A base class for a UA server implementation. More...

Inherits UnifiedAutomation.UaBase.IServerBase, and IDisposable.

Inherited by UnifiedAutomation.UaBase.DiscoveryServerBase, and UnifiedAutomation.UaBase.SessionServerBase.

Classes
class	IncomingRequest

Public Member Functions
	ServerBase ()
	Initializes object with default values. More...

void	Dispose ()
	Frees any unmanaged resources. More...

void	ScheduleIncomingRequest (IEndpointIncomingRequest request)
	Schedules an incoming request. More...

ApplicationLicense	GetProductLicense ()
	Gets the application license. More...

virtual void	Start (ApplicationInstanceBase application)
	Starts the server (called from a dedicated host process). More...

virtual void	Stop ()
	Stops the server and releases all resources. More...

void	RunInThreadPool (ThreadPoolEventHandler callback, object request)
	Runs an operation the in server thread pool. More...

Protected Member Functions
virtual void	Dispose (bool disposing)
	An overrideable version of the Dispose. More...

void	InitializeRequestQueue (ApplicationInstanceBase configuration)
	Initializes the request queue. More...

virtual void	DispatchRequest (IEndpointIncomingRequest request)
	Adds a request to the queue. More...

virtual void	ProcessRequest (IEndpointIncomingRequest request)
	Processes the request. More...

ITransportListener	CreateListener (ApplicationInstanceBase application)
	Creates the UA TCP listener. More...

virtual void	ValidateRequest (RequestHeader requestHeader)
	Verifies that the request header is valid. More...

virtual ResponseHeader	CreateResponse (RequestHeader requestHeader, uint statusCode)
	Creates the response header. More...

virtual void	OnUpdateConfiguration (ApplicationInstanceBase configuration)
	Called when the server configuration is changed on disk. More...

virtual void	OnServerStarting (ApplicationInstanceBase configuration)
	Called before the server starts. More...

virtual List< StatusCode >	InitializeServices (ApplicationInstanceBase application)
	Creates the endpoints and creates the hosts. More...

virtual void	StartApplication (ApplicationInstanceBase configuration)
	Starts the server application. More...

virtual void	OnServerStopping ()
	Called before the server stops More...

string	NormalizeHostname (string hostname)
	Checks for IP address or well known hostnames that map to the computer. More...

ApplicationDescription	GetApplicationDescription (Uri clientUrl, ApplicationDescription description, LocalizedText applicationName)
	Gets the application description. More...

EndpointDescriptionCollection	GetEndpointDescriptions (Uri clientUrl, ApplicationDescription application)
	Gets the endpoint descriptions. More...

Properties
ApplicationInstanceBase	Application `[get]`
	Gets the application. More...

MessageContext	MessageContext `[get]`
	The message context to use with the service. More...

ApplicationThreadPool	ThreadPool `[get]`
	Gets the thread pool used by the server. More...

StatusCode	ServerError `[get]`
	An error condition that describes why the server if not running (null if no error exists). More...

ISecurityProvider	SecurityProvider `[get]`
	Gets the security provider. More...

IEnumerable< ITransportListener >	TransportListeners `[get]`
	Gets the list of transport listeners used by the server instance. More...

Properties inherited from UnifiedAutomation.UaBase.IServerBase
ApplicationInstanceBase	Application `[get]`
	Gets the application. More...

MessageContext	MessageContext `[get]`
	The message context to use with the service. More...

StatusCode	ServerError `[get]`
	An error condition that describes why the server if not running (null if no error exists). More...

Detailed Description

A base class for a UA server implementation.

Constructor & Destructor Documentation

UnifiedAutomation.UaBase.ServerBase.ServerBase ( )

inline

Initializes object with default values.

Member Function Documentation

ITransportListener UnifiedAutomation.UaBase.ServerBase.CreateListener ( ApplicationInstanceBase application )

inlineprotected

Creates the UA TCP listener.

virtual ResponseHeader UnifiedAutomation.UaBase.ServerBase.CreateResponse	(	RequestHeader	requestHeader,
		uint	statusCode
	)

inlineprotectedvirtual

Creates the response header.

Parameters

requestHeader	The object that contains description for the RequestHeader DataType.
statusCode	The status code.

Exceptions

StatusException If statusCode is bad.

Returns: Returns a description for the ResponseHeader DataType.

virtual void UnifiedAutomation.UaBase.ServerBase.DispatchRequest ( IEndpointIncomingRequest request )

inlineprotectedvirtual

Adds a request to the queue.

Parameters

request The request.

Reimplemented in UnifiedAutomation.UaServer.ServerManager.

void UnifiedAutomation.UaBase.ServerBase.Dispose ( )

inline

Frees any unmanaged resources.

virtual void UnifiedAutomation.UaBase.ServerBase.Dispose ( bool disposing )

inlineprotectedvirtual

An overrideable version of the Dispose.

Reimplemented in UnifiedAutomation.UaServer.ServerManager.

ApplicationDescription UnifiedAutomation.UaBase.ServerBase.GetApplicationDescription	(	Uri	clientUrl,
		ApplicationDescription	description,
		LocalizedText	applicationName
	)

inlineprotected

Gets the application description.

Parameters

clientUrl	The client URL.
description	The description.
applicationName	Name of the application.

Returns

EndpointDescriptionCollection UnifiedAutomation.UaBase.ServerBase.GetEndpointDescriptions	(	Uri	clientUrl,
		ApplicationDescription	application
	)

inlineprotected

Gets the endpoint descriptions.

Parameters

clientUrl	The client URL.
application	The application.

Returns

ApplicationLicense UnifiedAutomation.UaBase.ServerBase.GetProductLicense ( )

inline

Gets the application license.

void UnifiedAutomation.UaBase.ServerBase.InitializeRequestQueue ( ApplicationInstanceBase configuration )

inlineprotected

Initializes the request queue.

Parameters

configuration The configuration.

virtual List<StatusCode> UnifiedAutomation.UaBase.ServerBase.InitializeServices ( ApplicationInstanceBase application )

inlineprotectedvirtual

Creates the endpoints and creates the hosts.

Parameters

application The application.

Returns: Returns list of hosts for a WCF services.

string UnifiedAutomation.UaBase.ServerBase.NormalizeHostname ( string hostname )

inlineprotected

Checks for IP address or well known hostnames that map to the computer.

Parameters

hostname The hostname.

Returns: The hostname to use for URL filtering.

virtual void UnifiedAutomation.UaBase.ServerBase.OnServerStarting ( ApplicationInstanceBase configuration )

inlineprotectedvirtual

Called before the server starts.

Parameters

configuration The object that stores the configurable configuration information for a UA application.

Reimplemented in UnifiedAutomation.UaServer.ServerManager.

virtual void UnifiedAutomation.UaBase.ServerBase.OnServerStopping ( )

inlineprotectedvirtual

Called before the server stops

Reimplemented in UnifiedAutomation.UaServer.ServerManager.

virtual void UnifiedAutomation.UaBase.ServerBase.OnUpdateConfiguration ( ApplicationInstanceBase configuration )

inlineprotectedvirtual

Called when the server configuration is changed on disk.

Parameters

configuration The object that stores the configurable configuration information for a UA application.

Servers are free to ignore changes if it is difficult/impossible to apply them without a restart.

virtual void UnifiedAutomation.UaBase.ServerBase.ProcessRequest ( IEndpointIncomingRequest request )

inlineprotectedvirtual

Processes the request.

Parameters

request The request.

void UnifiedAutomation.UaBase.ServerBase.RunInThreadPool	(	ThreadPoolEventHandler	callback,
		object	request
	)

inline

Runs an operation the in server thread pool.

Parameters

request	The request.
callback	The callback.

void UnifiedAutomation.UaBase.ServerBase.ScheduleIncomingRequest ( IEndpointIncomingRequest request )

inline

Schedules an incoming request.

Parameters

request The request.

Implements UnifiedAutomation.UaBase.IServerBase.

virtual void UnifiedAutomation.UaBase.ServerBase.Start ( ApplicationInstanceBase application )

inlinevirtual

Starts the server (called from a dedicated host process).

Parameters

application The application.

Reimplemented in UnifiedAutomation.UaServer.ServerManager.

virtual void UnifiedAutomation.UaBase.ServerBase.StartApplication ( ApplicationInstanceBase configuration )

inlineprotectedvirtual

Starts the server application.

Parameters

configuration The object that stores the configurable configuration information for a UA application.

virtual void UnifiedAutomation.UaBase.ServerBase.Stop ( )

inlinevirtual

Stops the server and releases all resources.

Reimplemented in UnifiedAutomation.UaServer.ServerManager.

virtual void UnifiedAutomation.UaBase.ServerBase.ValidateRequest ( RequestHeader requestHeader )

inlineprotectedvirtual

Verifies that the request header is valid.

Parameters

requestHeader The object that contains description for the RequestHeader DataType.

Property Documentation

ApplicationInstanceBase UnifiedAutomation.UaBase.ServerBase.Application

get

Gets the application.

MessageContext UnifiedAutomation.UaBase.ServerBase.MessageContext

get

The message context to use with the service.

The message context that stores context information associated with a UA server that is used during message processing.

ISecurityProvider UnifiedAutomation.UaBase.ServerBase.SecurityProvider

get

Gets the security provider.

StatusCode UnifiedAutomation.UaBase.ServerBase.ServerError

get

An error condition that describes why the server if not running (null if no error exists).

The object that combines the status code and diagnostic info structures.

ApplicationThreadPool UnifiedAutomation.UaBase.ServerBase.ThreadPool

get

Gets the thread pool used by the server.

The thread pool.

IEnumerable<ITransportListener> UnifiedAutomation.UaBase.ServerBase.TransportListeners

getprotected

Gets the list of transport listeners used by the server instance.

The transport listeners.

The documentation for this class was generated from the following file:

D:/work/uasdknet_master/src/UaBase/Wcf/ServerBase.cs

Classes

Public Member Functions

Protected Member Functions

Properties

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Property Documentation