UA Bundle SDK .NET  2.2.1.258
 All Classes Namespaces Functions Variables Enumerations Enumerator Properties Events Groups Pages
UnifiedAutomation.UaServer.ServerManager Class Reference

An implementation of a server. More...

Inherits UnifiedAutomation.UaBase.SessionServerBase.

Public Member Functions

virtual void Stop (uint secondsTillShutdown, string shutdownReason, bool restart)
 Stops the server. More...
 
override void Stop ()
 Stops the server and releases all resources. More...
 
DataMonitoringResult ValidateDataMonitoringRequest (RequestContext context, NodeAttributeHandle nodeHandle, ReadValueId itemToMonitor, MonitoringParameters parameters, NodeMetadata metadata)
 Validates the data monitoring request. More...
 
override ResponseHeader FindServers (RequestHeader requestHeader, string endpointUrl, StringCollection localeIds, StringCollection serverUris, out ApplicationDescriptionCollection servers)
 Invokes the FindServers service. More...
 
override ResponseHeader GetEndpoints (RequestHeader requestHeader, string endpointUrl, StringCollection localeIds, StringCollection profileUris, out EndpointDescriptionCollection endpoints)
 Invokes the GetEndpoints service. More...
 
void SessionExpired (Session session)
 Cleans up an expired session. More...
 
void EndPublish (RequestContext context, IEndpointIncomingRequest incoming, StatusCode error, object callbackData, bool doNotBlockThread)
 Ends the publish. More...
 
void ReportEvent (GenericEvent e)
 Reports the event to the Server notifier. More...
 
void ReportEvent (NodeId notifierId, GenericEvent e)
 Reports the event. More...
 
- Public Member Functions inherited from UnifiedAutomation.UaBase.SessionServerBase
virtual ResponseHeader Browse (RequestHeader requestHeader, ViewDescription view, uint requestedMaxReferencesPerNode, BrowseDescriptionCollection nodesToBrowse, out BrowseResultCollection results, out DiagnosticInfoCollection diagnosticInfos)
 Invokes the Browse service. More...
 
virtual ResponseHeader BrowseNext (RequestHeader requestHeader, bool releaseContinuationPoints, ByteStringCollection continuationPoints, out BrowseResultCollection results, out DiagnosticInfoCollection diagnosticInfos)
 Invokes the BrowseNext service. More...
 
virtual ResponseHeader TranslateBrowsePathsToNodeIds (RequestHeader requestHeader, BrowsePathCollection browsePaths, out BrowsePathResultCollection results, out DiagnosticInfoCollection diagnosticInfos)
 Invokes the TranslateBrowsePathsToNodeIds service. More...
 
virtual ResponseHeader QueryFirst (RequestHeader requestHeader, ViewDescription view, NodeTypeDescriptionCollection nodeTypes, ContentFilter filter, uint maxDataSetsToReturn, uint maxReferencesToReturn, out QueryDataSetCollection queryDataSets, out byte[] continuationPoint, out ParsingResultCollection parsingResults, out DiagnosticInfoCollection diagnosticInfos, out ContentFilterResult filterResult)
 Invokes the QueryFirst service. More...
 
virtual ResponseHeader QueryNext (RequestHeader requestHeader, bool releaseContinuationPoint, byte[] continuationPoint, out QueryDataSetCollection queryDataSets, out byte[] revisedContinuationPoint)
 Invokes the QueryNext service. More...
 
virtual ResponseHeader Read (RequestHeader requestHeader, double maxAge, TimestampsToReturn timestampsToReturn, ReadValueIdCollection nodesToRead, out DataValueCollection results, out DiagnosticInfoCollection diagnosticInfos)
 Invokes the Read service. More...
 
virtual ResponseHeader HistoryRead (RequestHeader requestHeader, ExtensionObject historyReadDetails, TimestampsToReturn timestampsToReturn, bool releaseContinuationPoints, HistoryReadValueIdCollection nodesToRead, out HistoryReadResultCollection results, out DiagnosticInfoCollection diagnosticInfos)
 Invokes the HistoryRead service. More...
 
virtual ResponseHeader Write (RequestHeader requestHeader, WriteValueCollection nodesToWrite, out StatusCodeCollection results, out DiagnosticInfoCollection diagnosticInfos)
 Invokes the Write service. More...
 
virtual ResponseHeader HistoryUpdate (RequestHeader requestHeader, ExtensionObjectCollection historyUpdateDetails, out HistoryUpdateResultCollection results, out DiagnosticInfoCollection diagnosticInfos)
 Invokes the HistoryUpdate service. More...
 
virtual ResponseHeader Call (RequestHeader requestHeader, CallMethodRequestCollection methodsToCall, out CallMethodResultCollection results, out DiagnosticInfoCollection diagnosticInfos)
 Invokes the Call service. More...
 
virtual ResponseHeader CreateMonitoredItems (RequestHeader requestHeader, uint subscriptionId, TimestampsToReturn timestampsToReturn, MonitoredItemCreateRequestCollection itemsToCreate, out MonitoredItemCreateResultCollection results, out DiagnosticInfoCollection diagnosticInfos)
 Invokes the CreateMonitoredItems service. More...
 
virtual ResponseHeader ModifyMonitoredItems (RequestHeader requestHeader, uint subscriptionId, TimestampsToReturn timestampsToReturn, MonitoredItemModifyRequestCollection itemsToModify, out MonitoredItemModifyResultCollection results, out DiagnosticInfoCollection diagnosticInfos)
 Invokes the ModifyMonitoredItems service. More...
 
virtual ResponseHeader SetMonitoringMode (RequestHeader requestHeader, uint subscriptionId, MonitoringMode monitoringMode, UInt32Collection monitoredItemIds, out StatusCodeCollection results, out DiagnosticInfoCollection diagnosticInfos)
 Invokes the SetMonitoringMode service. More...
 
virtual ResponseHeader DeleteMonitoredItems (RequestHeader requestHeader, uint subscriptionId, UInt32Collection monitoredItemIds, out StatusCodeCollection results, out DiagnosticInfoCollection diagnosticInfos)
 Invokes the DeleteMonitoredItems service. More...
 
virtual ResponseHeader Publish (RequestHeader requestHeader, SubscriptionAcknowledgementCollection subscriptionAcknowledgements, out uint subscriptionId, out UInt32Collection availableSequenceNumbers, out bool moreNotifications, out NotificationMessage notificationMessage, out StatusCodeCollection results, out DiagnosticInfoCollection diagnosticInfos)
 Invokes the Publish service. More...
 
virtual ResponseHeader TestStack (RequestHeader requestHeader, uint testId, int iteration, Variant input, out Variant output)
 Invokes the TestStack service. More...
 
virtual ResponseHeader TestStackEx (RequestHeader requestHeader, uint testId, int iteration, CompositeTestType input, out CompositeTestType output)
 Invokes the TestStackEx service. More...
 
- Public Member Functions inherited from UnifiedAutomation.UaBase.ServerBase
 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...
 
void Start (ApplicationInstance application)
 Starts the server (called from a dedicated host process). More...
 
void RunInThreadPool (ThreadPoolEventHandler callback, object request)
 Runs an operation the in server thread pool. More...
 

Protected Member Functions

override void Dispose (bool disposing)
 An overrideable version of the Dispose. More...
 
override void OnServerStarting (ApplicationInstance application)
 Called before the server starts. More...
 
virtual void RegisterAggregate (NodeId aggregateId, QualifiedName aggregateName, AggregatorFactory factory)
 Registers the aggregate (saves the factory and creates the objects in the addrres space). More...
 
virtual void OnRegisterAggregates ()
 Called to register any aggregates during server initialization. More...
 
override void OnServerStopping ()
 Called before the server stops. More...
 
override void DispatchRequest (IEndpointIncomingRequest request)
 Processes the request. More...
 
virtual void OnRootNodeManagerStarted (RootNodeManager nodeManager)
 Called when the root node manager starts. More...
 
virtual void OnSessionManagerStarted (SessionManager sessionManager)
 Called when the session manager starts. More...
 
virtual void OnSubscriptionManagerStarted (SubscriptionManager subscriptionManager)
 Called when the subscription manager starts. More...
 
virtual RequestContext ValidateRequest (RequestHeader requestHeader, ServiceType requestType)
 Verifies that the request header is valid. More...
 
virtual StatusCode TranslateException (DiagnosticsMasks diagnosticsMasks, IList< string > preferredLocales, Exception e)
 Translates an exception. More...
 
virtual void OnAsyncRequestComplete (RequestContext context, IEndpointIncomingRequest incoming, bool doNotBlockThread)
 Called when an aysnchrnous request completes. More...
 
virtual void OnAsyncRequestError (RequestContext context, IEndpointIncomingRequest incoming, bool doNotBlockThread, Exception e)
 Called when an asynchronous request has an error during processing. More...
 
virtual ResponseHeader OnRequestComplete (RequestContext context)
 Called when the request completes. More...
 
virtual ResponseHeader OnRequestError (RequestContext context, Exception e)
 Called when an asynchronous request encounters an error. More...
 

Properties

NamespaceTable NamespaceUris [get]
 Gets the namespace uris. More...
 
TypeManager TypeManager [get]
 Gets the type manager. More...
 
FilterManager FilterManager [get]
 Gets the filter manager. More...
 
AggregateManager AggregateManager [get]
 Gets the aggregate manager. More...
 
SubscriptionManager SubscriptionManager [get]
 Gets the subscription manager. More...
 
bool IsRunning [get]
 Gets a value indicating whether this instance is running. More...
 
RequestContext DefaultRequestContext [get]
 Gets the server context. More...
 
SessionManager SessionManager [get]
 Gets the session manager. More...
 
ResourceManager ResourceManager [get]
 Gets the resource manager. More...
 
RootNodeManager RootNodeManager [get]
 Gets the node manager. More...
 
uint NextUniqueId [get]
 Gets the next unique id. More...
 
ServerInternalClient InternalClient [get]
 Gets the internal client object. More...
 

Events

EventHandler ServerStopped
 Occurs when the server is stopped. More...
 

Detailed Description

An implementation of a server.

Member Function Documentation

override void UnifiedAutomation.UaServer.ServerManager.DispatchRequest ( IEndpointIncomingRequest  request)
inlineprotectedvirtual

Processes the request.

Parameters
requestThe request.

Reimplemented from UnifiedAutomation.UaBase.ServerBase.

override void UnifiedAutomation.UaServer.ServerManager.Dispose ( bool  disposing)
inlineprotectedvirtual

An overrideable version of the Dispose.

Parameters
disposing

Reimplemented from UnifiedAutomation.UaBase.ServerBase.

void UnifiedAutomation.UaServer.ServerManager.EndPublish ( RequestContext  context,
IEndpointIncomingRequest  incoming,
StatusCode  error,
object  callbackData,
bool  doNotBlockThread 
)
inline

Ends the publish.

Parameters
contextThe request context.
incomingThe incoming.
errorThe error.
callbackDataThe callback data.
doNotBlockThreadif set to true then the current thread should not be blocked.
override ResponseHeader UnifiedAutomation.UaServer.ServerManager.FindServers ( RequestHeader  requestHeader,
string  endpointUrl,
StringCollection  localeIds,
StringCollection  serverUris,
out ApplicationDescriptionCollection  servers 
)
inlinevirtual

Invokes the FindServers service.

Parameters
requestHeaderThe common request parameters. The authenticationToken is always omitted. The authenticationToken shall be ignored if it is provided.
endpointUrlThe network address that the Client used to access the Discovery Endpoint. The Server uses this information for diagnostics and to determine what URLs to return in the response. The Server should return a suitable default URL if it does not recognize the HostName in the URL.
localeIdsList of locales to use. The server should return the ServerName using one of locales specified. If the server supports more than one of the requested locales then the server shall use the locale that appears first in this list. If the server does not support any of the requested locales it chooses an appropriate default locale. The server chooses an appropriate default locale if this list is empty.
serverUrisList of servers to return. All known servers are returned if the list is empty.
serversList of Servers that meet criteria specified in the request. This list is empty if no servers meet the criteria.
Returns
Returns a description for the ResponseHeader DataType, the return type is
See Also
ResponseHeader

Reimplemented from UnifiedAutomation.UaBase.SessionServerBase.

override ResponseHeader UnifiedAutomation.UaServer.ServerManager.GetEndpoints ( RequestHeader  requestHeader,
string  endpointUrl,
StringCollection  localeIds,
StringCollection  profileUris,
out EndpointDescriptionCollection  endpoints 
)
inlinevirtual

Invokes the GetEndpoints service.

Parameters
requestHeaderThe common request parameters. The authenticationToken is always omitted. The authenticationToken shall be ignored if it is provided.
endpointUrlThe network address that the Client used to access the Discovery Endpoint. The Server uses this information for diagnostics and to determine what URLs to return in the response. The Server should return a suitable default URL, if it does not recognize the HostName in the URL.
localeIdsList of locales to use. Specifies the locale to use when returning human readable strings.
profileUrisList of Transport Profile that the returned Endpoints shall support. All Endpoints are returned if the list is empty.
endpointsThe endpoints.List of Endpoints that meet criteria specified in the request. This list is empty if no Endpoints meet the criteria.
Returns
Returns a description for the ResponseHeader DataType

Reimplemented from UnifiedAutomation.UaBase.SessionServerBase.

virtual void UnifiedAutomation.UaServer.ServerManager.OnAsyncRequestComplete ( RequestContext  context,
IEndpointIncomingRequest  incoming,
bool  doNotBlockThread 
)
inlineprotectedvirtual

Called when an aysnchrnous request completes.

Parameters
contextThe request context.
incomingThe incoming.
doNotBlockThreadif set to true then the current thread should not be blocked.
virtual void UnifiedAutomation.UaServer.ServerManager.OnAsyncRequestError ( RequestContext  context,
IEndpointIncomingRequest  incoming,
bool  doNotBlockThread,
Exception  e 
)
inlineprotectedvirtual

Called when an asynchronous request has an error during processing.

Parameters
contextThe request context.
incomingThe incoming.
doNotBlockThreadif set to true then the current thread should not be blocked.
eThe exeception.
virtual void UnifiedAutomation.UaServer.ServerManager.OnRegisterAggregates ( )
inlineprotectedvirtual

Called to register any aggregates during server initialization.

virtual ResponseHeader UnifiedAutomation.UaServer.ServerManager.OnRequestComplete ( RequestContext  context)
inlineprotectedvirtual

Called when the request completes.

Parameters
contextThe request context.
Returns
The header to return to the client.
virtual ResponseHeader UnifiedAutomation.UaServer.ServerManager.OnRequestError ( RequestContext  context,
Exception  e 
)
inlineprotectedvirtual

Called when an asynchronous request encounters an error.

Parameters
contextThe request context.
eThe exception.
Returns
The header to return to the client.
virtual void UnifiedAutomation.UaServer.ServerManager.OnRootNodeManagerStarted ( RootNodeManager  nodeManager)
inlineprotectedvirtual

Called when the root node manager starts.

Parameters
nodeManagerThe node manager.
override void UnifiedAutomation.UaServer.ServerManager.OnServerStarting ( ApplicationInstance  application)
inlineprotectedvirtual

Called before the server starts.

Parameters
applicationThe application.

Reimplemented from UnifiedAutomation.UaBase.ServerBase.

override void UnifiedAutomation.UaServer.ServerManager.OnServerStopping ( )
inlineprotectedvirtual

Called before the server stops.

Reimplemented from UnifiedAutomation.UaBase.ServerBase.

virtual void UnifiedAutomation.UaServer.ServerManager.OnSessionManagerStarted ( SessionManager  sessionManager)
inlineprotectedvirtual

Called when the session manager starts.

Parameters
sessionManagerThe session manager.
virtual void UnifiedAutomation.UaServer.ServerManager.OnSubscriptionManagerStarted ( SubscriptionManager  subscriptionManager)
inlineprotectedvirtual

Called when the subscription manager starts.

Parameters
subscriptionManagerThe subscription manager.
virtual void UnifiedAutomation.UaServer.ServerManager.RegisterAggregate ( NodeId  aggregateId,
QualifiedName  aggregateName,
AggregatorFactory  factory 
)
inlineprotectedvirtual

Registers the aggregate (saves the factory and creates the objects in the addrres space).

Parameters
aggregateIdThe aggregate id.
aggregateNameName of the aggregate.
factoryThe factory.
void UnifiedAutomation.UaServer.ServerManager.ReportEvent ( GenericEvent  e)
inline

Reports the event to the Server notifier.

Parameters
eThe event to report.
void UnifiedAutomation.UaServer.ServerManager.ReportEvent ( NodeId  notifierId,
GenericEvent  e 
)
inline

Reports the event.

Parameters
notifierIdThe notifier which is the target for the event.
eThe event to report.
void UnifiedAutomation.UaServer.ServerManager.SessionExpired ( Session  session)
inline

Cleans up an expired session.

Parameters
sessionThe session.
virtual void UnifiedAutomation.UaServer.ServerManager.Stop ( uint  secondsTillShutdown,
string  shutdownReason,
bool  restart 
)
inlinevirtual

Stops the server.

Parameters
secondsTillShutdownThe seconds till shutdown.
shutdownReasonThe shutdown reason.
restartif set to true [restart].
override void UnifiedAutomation.UaServer.ServerManager.Stop ( )
inlinevirtual

Stops the server and releases all resources.

Reimplemented from UnifiedAutomation.UaBase.ServerBase.

virtual StatusCode UnifiedAutomation.UaServer.ServerManager.TranslateException ( DiagnosticsMasks  diagnosticsMasks,
IList< string >  preferredLocales,
Exception  e 
)
inlineprotectedvirtual

Translates an exception.

Parameters
diagnosticsMasksThe fields to return.
preferredLocalesThe preferred locales.
eThe exception.
Returns
The translated exception as a status code.
DataMonitoringResult UnifiedAutomation.UaServer.ServerManager.ValidateDataMonitoringRequest ( RequestContext  context,
NodeAttributeHandle  nodeHandle,
ReadValueId  itemToMonitor,
MonitoringParameters  parameters,
NodeMetadata  metadata 
)
inline

Validates the data monitoring request.

Parameters
contextThe request context.
nodeHandleThe node handle.
itemToMonitorThe item to monitor.
parametersThe parameters.
metadataThe metadata.
Returns
virtual RequestContext UnifiedAutomation.UaServer.ServerManager.ValidateRequest ( RequestHeader  requestHeader,
ServiceType  requestType 
)
inlineprotectedvirtual

Verifies that the request header is valid.

Parameters
requestHeaderThe request header.
requestTypeType of the request.
Returns
A context that is passed into methods used to process the request.

Property Documentation

AggregateManager UnifiedAutomation.UaServer.ServerManager.AggregateManager
get

Gets the aggregate manager.

RequestContext UnifiedAutomation.UaServer.ServerManager.DefaultRequestContext
get

Gets the server context.

FilterManager UnifiedAutomation.UaServer.ServerManager.FilterManager
get

Gets the filter manager.

ServerInternalClient UnifiedAutomation.UaServer.ServerManager.InternalClient
get

Gets the internal client object.

bool UnifiedAutomation.UaServer.ServerManager.IsRunning
get

Gets a value indicating whether this instance is running.

true if this instance is running; otherwise, false.

NamespaceTable UnifiedAutomation.UaServer.ServerManager.NamespaceUris
get

Gets the namespace uris.

uint UnifiedAutomation.UaServer.ServerManager.NextUniqueId
get

Gets the next unique id.

ResourceManager UnifiedAutomation.UaServer.ServerManager.ResourceManager
get

Gets the resource manager.

RootNodeManager UnifiedAutomation.UaServer.ServerManager.RootNodeManager
get

Gets the node manager.

SessionManager UnifiedAutomation.UaServer.ServerManager.SessionManager
get

Gets the session manager.

SubscriptionManager UnifiedAutomation.UaServer.ServerManager.SubscriptionManager
get

Gets the subscription manager.

TypeManager UnifiedAutomation.UaServer.ServerManager.TypeManager
get

Gets the type manager.

Event Documentation

EventHandler UnifiedAutomation.UaServer.ServerManager.ServerStopped

Occurs when the server is stopped.


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