.NET Based OPC UA Client/Server SDK  3.3.3.537
UnifiedAutomation.UaBase.ServerBase Class Reference

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

Inherits UnifiedAutomation.UaBase.IServerBase, and IDisposable.

Inherited by UnifiedAutomation.UaBase.DiscoveryServerBase, UnifiedAutomation.UaBase.ReverseConnectManager, 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 OnOutgoingReverseConnectionClosed (object sender, OutgoingReverseConnectionUpdateEventArgs e)
 
virtual void OnOutgoingReverseConnectionOpened (object sender, OutgoingReverseConnectionUpdateEventArgs e)
 
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< StatusCodeInitializeServices (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...
 

Protected Attributes

MessageContext m_messageContext
 The message context.
 
ApplicationInstanceBase m_application
 The application instance More...
 
List< ITransportListenerm_listeners
 The transport listeners managed by the ServerBase More...
 
ApplicationLicense m_license
 The found sdk license. 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< ITransportListenerTransportListeners [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 ( )

Initializes object with default values.

Member Function Documentation

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

Creates the UA TCP listener.

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

Creates the response header.

Parameters
requestHeaderThe object that contains description for the RequestHeader DataType.
statusCodeThe status code.
Exceptions
StatusExceptionIf statusCode is bad.
Returns
Returns a description for the ResponseHeader DataType.
virtual void UnifiedAutomation.UaBase.ServerBase.DispatchRequest ( IEndpointIncomingRequest  request)
protectedvirtual

Adds a request to the queue.

Parameters
requestThe request.

Reimplemented in UnifiedAutomation.UaServer.ServerManager.

void UnifiedAutomation.UaBase.ServerBase.Dispose ( )

Frees any unmanaged resources.

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

An overrideable version of the Dispose.

Reimplemented in UnifiedAutomation.UaBase.ReverseConnectManager, and UnifiedAutomation.UaServer.ServerManager.

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

Gets the application description.

Parameters
clientUrlThe client URL.
descriptionThe description.
applicationNameName of the application.
Returns
EndpointDescriptionCollection UnifiedAutomation.UaBase.ServerBase.GetEndpointDescriptions ( Uri  clientUrl,
ApplicationDescription  application 
)
protected

Gets the endpoint descriptions.

Parameters
clientUrlThe client URL.
applicationThe application.
Returns
ApplicationLicense UnifiedAutomation.UaBase.ServerBase.GetProductLicense ( )

Gets the application license.

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

Initializes the request queue.

Parameters
configurationThe configuration.
virtual List<StatusCode> UnifiedAutomation.UaBase.ServerBase.InitializeServices ( ApplicationInstanceBase  application)
protectedvirtual

Creates the endpoints and creates the hosts.

Parameters
applicationThe application.
Returns
Returns list of hosts for a WCF services.
string UnifiedAutomation.UaBase.ServerBase.NormalizeHostname ( string  hostname)
protected

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

Parameters
hostnameThe hostname.
Returns
The hostname to use for URL filtering.
virtual void UnifiedAutomation.UaBase.ServerBase.OnServerStarting ( ApplicationInstanceBase  configuration)
protectedvirtual

Called before the server starts.

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

Reimplemented in UnifiedAutomation.UaServer.ServerManager.

virtual void UnifiedAutomation.UaBase.ServerBase.OnServerStopping ( )
protectedvirtual

Called before the server stops

Reimplemented in UnifiedAutomation.UaServer.ServerManager.

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

Called when the server configuration is changed on disk.

Parameters
configurationThe 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)
protectedvirtual

Processes the request.

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

Runs an operation the in server thread pool.

Parameters
requestThe request.
callbackThe callback.
void UnifiedAutomation.UaBase.ServerBase.ScheduleIncomingRequest ( IEndpointIncomingRequest  request)

Schedules an incoming request.

Parameters
requestThe request.

Implements UnifiedAutomation.UaBase.IServerBase.

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

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

Parameters
applicationThe application.

Reimplemented in UnifiedAutomation.UaBase.ReverseConnectManager, and UnifiedAutomation.UaServer.ServerManager.

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

Starts the server application.

Parameters
configurationThe object that stores the configurable configuration information for a UA application.
virtual void UnifiedAutomation.UaBase.ServerBase.Stop ( )
virtual

Stops the server and releases all resources.

Reimplemented in UnifiedAutomation.UaServer.ServerManager.

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

Verifies that the request header is valid.

Parameters
requestHeaderThe object that contains description for the RequestHeader DataType.

Member Data Documentation

ApplicationInstanceBase UnifiedAutomation.UaBase.ServerBase.m_application
protected

The application instance

ApplicationLicense UnifiedAutomation.UaBase.ServerBase.m_license
protected

The found sdk license.

List<ITransportListener> UnifiedAutomation.UaBase.ServerBase.m_listeners
protected

The transport listeners managed by the ServerBase

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: