.NET Based OPC UA Client/Server SDK
3.0.6.477
|
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... | |
A base class for a UA server implementation.
|
inline |
Initializes object with default values.
|
inlineprotected |
Creates the UA TCP listener.
|
inlineprotectedvirtual |
Creates the response header.
requestHeader | The object that contains description for the RequestHeader DataType. |
statusCode | The status code. |
StatusException | If statusCode is bad. |
|
inlineprotectedvirtual |
Adds a request to the queue.
request | The request. |
Reimplemented in UnifiedAutomation.UaServer.ServerManager.
|
inline |
Frees any unmanaged resources.
|
inlineprotectedvirtual |
An overrideable version of the Dispose.
Reimplemented in UnifiedAutomation.UaServer.ServerManager.
|
inlineprotected |
Gets the application description.
clientUrl | The client URL. |
description | The description. |
applicationName | Name of the application. |
|
inlineprotected |
Gets the endpoint descriptions.
clientUrl | The client URL. |
application | The application. |
|
inline |
Gets the application license.
|
inlineprotected |
Initializes the request queue.
configuration | The configuration. |
|
inlineprotectedvirtual |
Creates the endpoints and creates the hosts.
application | The application. |
|
inlineprotected |
Checks for IP address or well known hostnames that map to the computer.
hostname | The hostname. |
|
inlineprotectedvirtual |
Called before the server starts.
configuration | The object that stores the configurable configuration information for a UA application. |
Reimplemented in UnifiedAutomation.UaServer.ServerManager.
|
inlineprotectedvirtual |
Called before the server stops
Reimplemented in UnifiedAutomation.UaServer.ServerManager.
|
inlineprotectedvirtual |
Called when the server configuration is changed on disk.
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.
|
inlineprotectedvirtual |
Processes the request.
request | The request. |
|
inline |
Runs an operation the in server thread pool.
request | The request. |
callback | The callback. |
|
inline |
Schedules an incoming request.
request | The request. |
Implements UnifiedAutomation.UaBase.IServerBase.
|
inlinevirtual |
Starts the server (called from a dedicated host process).
application | The application. |
Reimplemented in UnifiedAutomation.UaServer.ServerManager.
|
inlineprotectedvirtual |
Starts the server application.
configuration | The object that stores the configurable configuration information for a UA application. |
|
inlinevirtual |
Stops the server and releases all resources.
Reimplemented in UnifiedAutomation.UaServer.ServerManager.
|
inlineprotectedvirtual |
Verifies that the request header is valid.
requestHeader | The object that contains description for the RequestHeader DataType. |
|
get |
Gets the application.
|
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.
|
get |
Gets the security provider.
|
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.
|
get |
Gets the thread pool used by the server.
The thread pool.
|
getprotected |
Gets the list of transport listeners used by the server instance.
The transport listeners.