C# Class Opc.Ua.Server.StandardServer

Inheritance: SessionServerBase

Show file Open project: OPCFoundation/UA-.NET Class Usage Examples

Public Methods

Method	Description
ActivateSession ( RequestHeader requestHeader, SignatureData clientSignature, SignedSoftwareCertificateCollection clientSoftwareCertificates, StringCollection localeIds, ExtensionObject userIdentityToken, SignatureData userTokenSignature, byte &serverNonce, StatusCodeCollection &results, DiagnosticInfoCollection &diagnosticInfos ) : ResponseHeader	Invokes the ActivateSession service.
BeginPublish ( IEndpointIncomingRequest request ) : void	Begins an asynchronous publish operation.
Browse ( RequestHeader requestHeader, ViewDescription view, uint requestedMaxReferencesPerNode, BrowseDescriptionCollection nodesToBrowse, BrowseResultCollection &results, DiagnosticInfoCollection &diagnosticInfos ) : ResponseHeader	Invokes the Browse service.
BrowseNext ( RequestHeader requestHeader, bool releaseContinuationPoints, ByteStringCollection continuationPoints, BrowseResultCollection &results, DiagnosticInfoCollection &diagnosticInfos ) : ResponseHeader	Invokes the BrowseNext service.
Call ( RequestHeader requestHeader, CallMethodRequestCollection methodsToCall, CallMethodResultCollection &results, DiagnosticInfoCollection &diagnosticInfos ) : ResponseHeader	Invokes the Call service.
Cancel ( RequestHeader requestHeader, uint requestHandle, uint &cancelCount ) : ResponseHeader	Invokes the Cancel service.
CloseSession ( RequestHeader requestHeader, bool deleteSubscriptions ) : ResponseHeader	Invokes the CloseSession service.
CompletePublish ( IEndpointIncomingRequest request ) : void	Completes an asynchronous publish operation.
CreateMonitoredItems ( RequestHeader requestHeader, uint subscriptionId, TimestampsToReturn timestampsToReturn, MonitoredItemCreateRequestCollection itemsToCreate, MonitoredItemCreateResultCollection &results, DiagnosticInfoCollection &diagnosticInfos ) : ResponseHeader	Invokes the CreateMonitoredItems service.
CreateSession ( RequestHeader requestHeader, ApplicationDescription clientDescription, string serverUri, string endpointUrl, string sessionName, byte clientNonce, byte clientCertificate, double requestedSessionTimeout, uint maxResponseMessageSize, NodeId &sessionId, NodeId &authenticationToken, double &revisedSessionTimeout, byte &serverNonce, byte &serverCertificate, EndpointDescriptionCollection &serverEndpoints, SignedSoftwareCertificateCollection &serverSoftwareCertificates, SignatureData &serverSignature, uint &maxRequestMessageSize ) : ResponseHeader	Invokes the CreateSession service.
CreateSubscription ( RequestHeader requestHeader, double requestedPublishingInterval, uint requestedLifetimeCount, uint requestedMaxKeepAliveCount, uint maxNotificationsPerPublish, bool publishingEnabled, byte priority, uint &subscriptionId, double &revisedPublishingInterval, uint &revisedLifetimeCount, uint &revisedMaxKeepAliveCount ) : ResponseHeader	Invokes the CreateSubscription service.
DeleteMonitoredItems ( RequestHeader requestHeader, uint subscriptionId, UInt32Collection monitoredItemIds, StatusCodeCollection &results, DiagnosticInfoCollection &diagnosticInfos ) : ResponseHeader	Invokes the DeleteMonitoredItems service.
DeleteSubscriptions ( RequestHeader requestHeader, UInt32Collection subscriptionIds, StatusCodeCollection &results, DiagnosticInfoCollection &diagnosticInfos ) : ResponseHeader	Invokes the DeleteSubscriptions service.
FindServers ( RequestHeader requestHeader, string endpointUrl, StringCollection localeIds, StringCollection serverUris, ApplicationDescriptionCollection &servers ) : ResponseHeader	Invokes the FindServers service.
GetEndpoints ( RequestHeader requestHeader, string endpointUrl, StringCollection localeIds, StringCollection profileUris, EndpointDescriptionCollection &endpoints ) : ResponseHeader	Invokes the GetEndpoints service.
GetStatus ( ) : ServerStatusDataType	Returns the current status of the server.
HistoryRead ( RequestHeader requestHeader, ExtensionObject historyReadDetails, TimestampsToReturn timestampsToReturn, bool releaseContinuationPoints, HistoryReadValueIdCollection nodesToRead, HistoryReadResultCollection &results, DiagnosticInfoCollection &diagnosticInfos ) : ResponseHeader	Invokes the HistoryRead service.
HistoryUpdate ( RequestHeader requestHeader, ExtensionObjectCollection historyUpdateDetails, HistoryUpdateResultCollection &results, DiagnosticInfoCollection &diagnosticInfos ) : ResponseHeader	Invokes the HistoryUpdate service.
ModifyMonitoredItems ( RequestHeader requestHeader, uint subscriptionId, TimestampsToReturn timestampsToReturn, MonitoredItemModifyRequestCollection itemsToModify, MonitoredItemModifyResultCollection &results, DiagnosticInfoCollection &diagnosticInfos ) : ResponseHeader	Invokes the ModifyMonitoredItems service.
ModifySubscription ( RequestHeader requestHeader, uint subscriptionId, double requestedPublishingInterval, uint requestedLifetimeCount, uint requestedMaxKeepAliveCount, uint maxNotificationsPerPublish, byte priority, double &revisedPublishingInterval, uint &revisedLifetimeCount, uint &revisedMaxKeepAliveCount ) : ResponseHeader	Invokes the ModifySubscription service.
Publish ( RequestHeader requestHeader, SubscriptionAcknowledgementCollection subscriptionAcknowledgements, uint &subscriptionId, UInt32Collection &availableSequenceNumbers, bool &moreNotifications, NotificationMessage &notificationMessage, StatusCodeCollection &results, DiagnosticInfoCollection &diagnosticInfos ) : ResponseHeader	Invokes the Publish service.
Read ( RequestHeader requestHeader, double maxAge, TimestampsToReturn timestampsToReturn, ReadValueIdCollection nodesToRead, DataValueCollection &results, DiagnosticInfoCollection &diagnosticInfos ) : ResponseHeader	Invokes the Read service.
RegisterNodes ( RequestHeader requestHeader, NodeIdCollection nodesToRegister, NodeIdCollection &registeredNodeIds ) : ResponseHeader	Invokes the RegisterNodes service.
RegisterWithDiscoveryServer ( ) : bool	Registers the server with the discovery server.
Republish ( RequestHeader requestHeader, uint subscriptionId, uint retransmitSequenceNumber, NotificationMessage &notificationMessage ) : ResponseHeader	Invokes the Republish service.
SetMonitoringMode ( RequestHeader requestHeader, uint subscriptionId, MonitoringMode monitoringMode, UInt32Collection monitoredItemIds, StatusCodeCollection &results, DiagnosticInfoCollection &diagnosticInfos ) : ResponseHeader	Invokes the SetMonitoringMode service.
SetPublishingMode ( RequestHeader requestHeader, bool publishingEnabled, UInt32Collection subscriptionIds, StatusCodeCollection &results, DiagnosticInfoCollection &diagnosticInfos ) : ResponseHeader	Invokes the SetPublishingMode service.
SetTriggering ( RequestHeader requestHeader, uint subscriptionId, uint triggeringItemId, UInt32Collection linksToAdd, UInt32Collection linksToRemove, StatusCodeCollection &addResults, DiagnosticInfoCollection &addDiagnosticInfos, StatusCodeCollection &removeResults, DiagnosticInfoCollection &removeDiagnosticInfos ) : ResponseHeader	Invokes the SetTriggering service.
StandardServer ( ) : System	Initializes the object with default values.
TranslateBrowsePathsToNodeIds ( RequestHeader requestHeader, BrowsePathCollection browsePaths, BrowsePathResultCollection &results, DiagnosticInfoCollection &diagnosticInfos ) : ResponseHeader	Invokes the TranslateBrowsePathsToNodeIds service.
UnregisterNodes ( RequestHeader requestHeader, NodeIdCollection nodesToUnregister ) : ResponseHeader	Invokes the UnregisterNodes service.
Write ( RequestHeader requestHeader, WriteValueCollection nodesToWrite, StatusCodeCollection &results, DiagnosticInfoCollection &diagnosticInfos ) : ResponseHeader	Invokes the Write service.

Protected Methods

Method	Description
CreateAggregateManager ( IServerInternal server, ApplicationConfiguration configuration ) : AggregateManager	Creates the aggregate manager used by the server.
CreateEventManager ( IServerInternal server, ApplicationConfiguration configuration ) : EventManager	Creates the event manager for the server.
CreateMasterNodeManager ( IServerInternal server, ApplicationConfiguration configuration ) : MasterNodeManager	Creates the master node manager for the server.
CreateRequestManager ( IServerInternal server, ApplicationConfiguration configuration ) : RequestManager	Creates the request manager for the server.
CreateResourceManager ( IServerInternal server, ApplicationConfiguration configuration ) : ResourceManager	Creates the resource manager for the server.
CreateServiceHost ( System.ServiceModel.ServerBase server ) : System.ServiceModel.ServiceHost	Creates an instance of the service host.
CreateSessionManager ( IServerInternal server, ApplicationConfiguration configuration ) : SessionManager	Creates the session manager for the server.
CreateSubscriptionManager ( IServerInternal server, ApplicationConfiguration configuration ) : SubscriptionManager	Creates the session manager for the server.
GetEndpointDescriptions ( string endpointUrl, IList baseAddresses, StringCollection localeIds ) : EndpointDescriptionCollection	Returns the endpoints that match the base addresss and endpoint url.
GetEndpointInstance ( System.ServiceModel.ServerBase server ) : EndpointBase	Returns an instance of the endpoint to use.
GetServiceContract ( ) : Type	Returns the service contract to use.
InitializeServiceHosts ( ApplicationConfiguration configuration, BindingFactory bindingFactory, ApplicationDescription &serverDescription, EndpointDescriptionCollection &endpoints ) : IList	Creates the endpoints and creates the hosts.
IsSecurityError ( StatusCode error ) : bool	Returns whether the error is a security error.
OnApplicationCertificateError ( byte clientCertificate, ServiceResult result ) : void	Handles an error when validating the application instance certificate provided by a client.
OnNodeManagerStarted ( IServerInternal server ) : void	Called after the node managers have been started.
OnRequestComplete ( OperationContext context ) : void	Verifies that the request header is valid.
OnServerStarted ( IServerInternal server ) : void	Called after the server has been started.
OnServerStarting ( ApplicationConfiguration configuration ) : void	Called before the server starts.
OnServerStopping ( ) : void	Called before the server stops
OnUpdateConfiguration ( ApplicationConfiguration configuration ) : void	Called when the server configuration is changed on disk. Servers are free to ignore changes if it is difficult/impossible to apply them without a restart.
ProcessRequest ( IEndpointIncomingRequest request, object calldata ) : void	Processes the request.
SetServerError ( ServiceResult error ) : void	Reports an error during initialization after the base server object has been started.
SetServerState ( ServerState state ) : void	Updates the server state.
StartApplication ( ApplicationConfiguration configuration ) : void	Starts the server application.
TranslateException ( DiagnosticsMasks diagnosticsMasks, IList preferredLocales, ServiceResultException e ) : ServiceResultException	Translates an exception.
TranslateException ( OperationContext context, ServiceResultException e ) : ServiceResultException	Translates an exception.
TranslateResult ( DiagnosticsMasks diagnosticsMasks, IList preferredLocales, ServiceResult result ) : ServiceResult	Translates a service result.
ValidateRequest ( RequestHeader requestHeader, RequestType requestType ) : OperationContext	Verifies that the request header is valid.
ValidateRequest ( RequestHeader requestHeader ) : void	Verifies that the request header is valid.
ValidateSoftwareCertificates ( List softwareCertificates ) : void	Inspects the software certificates provided by the server.

Private Methods

Method	Description
Dispose ( bool disposing ) : void
OnConfigurationChanged ( object sender, ConfigurationWatcherEventArgs args ) : void
OnRegisterServer ( object state ) : void	Registers the server endpoints with the LDS.
RegistrationValidator_CertificateValidation ( CertificateValidator sender, CertificateValidationEventArgs e ) : void	Checks that the domains in the certificate match the current host.

Method Details

ActivateSession() public method

Invokes the ActivateSession service.

public ActivateSession ( RequestHeader requestHeader, SignatureData clientSignature, SignedSoftwareCertificateCollection clientSoftwareCertificates, StringCollection localeIds, ExtensionObject userIdentityToken, SignatureData userTokenSignature, byte &serverNonce, StatusCodeCollection &results, DiagnosticInfoCollection &diagnosticInfos ) : ResponseHeader
requestHeader	RequestHeader	The request header.
clientSignature	SignatureData	The client signature.
clientSoftwareCertificates	SignedSoftwareCertificateCollection	The client software certificates.
localeIds	StringCollection	The locale ids.
userIdentityToken	ExtensionObject	The user identity token.
userTokenSignature	SignatureData	The user token signature.
serverNonce	byte	The server nonce.
results	StatusCodeCollection	The results.
diagnosticInfos	DiagnosticInfoCollection	The diagnostic infos.
return	ResponseHeader

BeginPublish() public method

Begins an asynchronous publish operation.

public BeginPublish ( IEndpointIncomingRequest request ) : void
request	IEndpointIncomingRequest	The request.
return	void

Browse() public method

Invokes the Browse service.

public Browse ( RequestHeader requestHeader, ViewDescription view, uint requestedMaxReferencesPerNode, BrowseDescriptionCollection nodesToBrowse, BrowseResultCollection &results, DiagnosticInfoCollection &diagnosticInfos ) : ResponseHeader
requestHeader	RequestHeader	The request header.
view	ViewDescription	The view.
requestedMaxReferencesPerNode	uint	The maximum number of references to return for each node.
nodesToBrowse	BrowseDescriptionCollection	The list of nodes to browse.
results	BrowseResultCollection	The list of results for the passed starting nodes and filters.
diagnosticInfos	DiagnosticInfoCollection	The diagnostic information for the results.
return	ResponseHeader

BrowseNext() public method

Invokes the BrowseNext service.

public BrowseNext ( RequestHeader requestHeader, bool releaseContinuationPoints, ByteStringCollection continuationPoints, BrowseResultCollection &results, DiagnosticInfoCollection &diagnosticInfos ) : ResponseHeader
requestHeader	RequestHeader	The request header.
releaseContinuationPoints	bool	if set to true the continuation points are released.
continuationPoints	ByteStringCollection	A list of continuation points returned in a previous Browse or BrewseNext call.
results	BrowseResultCollection	The list of resulted references for browse.
diagnosticInfos	DiagnosticInfoCollection	The diagnostic information for the results.
return	ResponseHeader

Call() public method

Invokes the Call service.

public Call ( RequestHeader requestHeader, CallMethodRequestCollection methodsToCall, CallMethodResultCollection &results, DiagnosticInfoCollection &diagnosticInfos ) : ResponseHeader
requestHeader	RequestHeader	The request header.
methodsToCall	CallMethodRequestCollection	The methods to call.
results	CallMethodResultCollection	The results.
diagnosticInfos	DiagnosticInfoCollection	The diagnostic information for the results.
return	ResponseHeader

Cancel() public method

Invokes the Cancel service.

public Cancel ( RequestHeader requestHeader, uint requestHandle, uint &cancelCount ) : ResponseHeader
requestHeader	RequestHeader	The request header.
requestHandle	uint	The request handle assigned to the request.
cancelCount	uint	The number of cancelled requests.
return	ResponseHeader

CloseSession() public method

Invokes the CloseSession service.

public CloseSession ( RequestHeader requestHeader, bool deleteSubscriptions ) : ResponseHeader
requestHeader	RequestHeader	The request header.
deleteSubscriptions	bool	if set to true subscriptions are deleted.
return	ResponseHeader

CompletePublish() public method

Completes an asynchronous publish operation.

public CompletePublish ( IEndpointIncomingRequest request ) : void
request	IEndpointIncomingRequest	The request.
return	void

CreateAggregateManager() protected method

Creates the aggregate manager used by the server.

protected CreateAggregateManager ( IServerInternal server, ApplicationConfiguration configuration ) : AggregateManager
server	IServerInternal	The server.
configuration	ApplicationConfiguration	The application configuration.
return	AggregateManager

CreateEventManager() protected method

Creates the event manager for the server.

protected CreateEventManager ( IServerInternal server, ApplicationConfiguration configuration ) : EventManager
server	IServerInternal	The server.
configuration	ApplicationConfiguration	The configuration.
return	EventManager

CreateMasterNodeManager() protected method

Creates the master node manager for the server.

protected CreateMasterNodeManager ( IServerInternal server, ApplicationConfiguration configuration ) : MasterNodeManager
server	IServerInternal	The server.
configuration	ApplicationConfiguration	The configuration.
return	MasterNodeManager

CreateMonitoredItems() public method

Invokes the CreateMonitoredItems service.

public CreateMonitoredItems ( RequestHeader requestHeader, uint subscriptionId, TimestampsToReturn timestampsToReturn, MonitoredItemCreateRequestCollection itemsToCreate, MonitoredItemCreateResultCollection &results, DiagnosticInfoCollection &diagnosticInfos ) : ResponseHeader
requestHeader	RequestHeader	The request header.
subscriptionId	uint	The subscription id that will report notifications.
timestampsToReturn	TimestampsToReturn	The type of timestamps to be returned for the MonitoredItems.
itemsToCreate	MonitoredItemCreateRequestCollection	The list of MonitoredItems to be created and assigned to the specified subscription
results	MonitoredItemCreateResultCollection	The list of results for the MonitoredItems to create.
diagnosticInfos	DiagnosticInfoCollection	The diagnostic information for the results.
return	ResponseHeader

CreateRequestManager() protected method

Creates the request manager for the server.

protected CreateRequestManager ( IServerInternal server, ApplicationConfiguration configuration ) : RequestManager
server	IServerInternal	The server.
configuration	ApplicationConfiguration	The configuration.
return	RequestManager

CreateResourceManager() protected method

Creates the resource manager for the server.

protected CreateResourceManager ( IServerInternal server, ApplicationConfiguration configuration ) : ResourceManager
server	IServerInternal	The server.
configuration	ApplicationConfiguration	The configuration.
return	ResourceManager

CreateServiceHost() protected method

Creates an instance of the service host.

protected CreateServiceHost ( System.ServiceModel.ServerBase server ) : System.ServiceModel.ServiceHost
server	System.ServiceModel.ServerBase
return	System.ServiceModel.ServiceHost

CreateSession() public method

Invokes the CreateSession service.

public CreateSession ( RequestHeader requestHeader, ApplicationDescription clientDescription, string serverUri, string endpointUrl, string sessionName, byte clientNonce, byte clientCertificate, double requestedSessionTimeout, uint maxResponseMessageSize, NodeId &sessionId, NodeId &authenticationToken, double &revisedSessionTimeout, byte &serverNonce, byte &serverCertificate, EndpointDescriptionCollection &serverEndpoints, SignedSoftwareCertificateCollection &serverSoftwareCertificates, SignatureData &serverSignature, uint &maxRequestMessageSize ) : ResponseHeader
requestHeader	RequestHeader	The request header.
clientDescription	ApplicationDescription	Application description for the client application.
serverUri	string	The server URI.
endpointUrl	string	The endpoint URL.
sessionName	string	Name for the Session assigned by the client.
clientNonce	byte	The client nonce.
clientCertificate	byte	The client certificate.
requestedSessionTimeout	double	The requested session timeout.
maxResponseMessageSize	uint	Size of the max response message.
sessionId	NodeId	The unique public identifier assigned by the Server to the Session.
authenticationToken	NodeId	The unique private identifier assigned by the Server to the Session.
revisedSessionTimeout	double	The revised session timeout.
serverNonce	byte	The server nonce.
serverCertificate	byte	The server certificate.
serverEndpoints	EndpointDescriptionCollection	The server endpoints.
serverSoftwareCertificates	SignedSoftwareCertificateCollection	The server software certificates.
serverSignature	SignatureData	The server signature.
maxRequestMessageSize	uint	Size of the max request message.
return	ResponseHeader

CreateSessionManager() protected method

Creates the session manager for the server.

protected CreateSessionManager ( IServerInternal server, ApplicationConfiguration configuration ) : SessionManager
server	IServerInternal	The server.
configuration	ApplicationConfiguration	The configuration.
return	SessionManager

CreateSubscription() public method

Invokes the CreateSubscription service.

public CreateSubscription ( RequestHeader requestHeader, double requestedPublishingInterval, uint requestedLifetimeCount, uint requestedMaxKeepAliveCount, uint maxNotificationsPerPublish, bool publishingEnabled, byte priority, uint &subscriptionId, double &revisedPublishingInterval, uint &revisedLifetimeCount, uint &revisedMaxKeepAliveCount ) : ResponseHeader
requestHeader	RequestHeader	The request header.
requestedPublishingInterval	double	The cyclic rate that the Subscription is being requested to return Notifications to the Client.
requestedLifetimeCount	uint	The client-requested lifetime count for the Subscription
requestedMaxKeepAliveCount	uint	The requested max keep alive count.
maxNotificationsPerPublish	uint	The maximum number of notifications that the Client wishes to receive in a single Publish response.
publishingEnabled	bool	If set to true publishing is enabled for the Subscription.
priority	byte	The relative priority of the Subscription.
subscriptionId	uint	The Server-assigned identifier for the Subscription.
revisedPublishingInterval	double	The actual publishing interval that the Server will use.
revisedLifetimeCount	uint	The revised lifetime count.
revisedMaxKeepAliveCount	uint	The revised max keep alive count.
return	ResponseHeader

CreateSubscriptionManager() protected method

Creates the session manager for the server.

protected CreateSubscriptionManager ( IServerInternal server, ApplicationConfiguration configuration ) : SubscriptionManager
server	IServerInternal	The server.
configuration	ApplicationConfiguration	The configuration.
return	SubscriptionManager

DeleteMonitoredItems() public method

Invokes the DeleteMonitoredItems service.

public DeleteMonitoredItems ( RequestHeader requestHeader, uint subscriptionId, UInt32Collection monitoredItemIds, StatusCodeCollection &results, DiagnosticInfoCollection &diagnosticInfos ) : ResponseHeader
requestHeader	RequestHeader	The request header.
subscriptionId	uint	The subscription id.
monitoredItemIds	UInt32Collection	The list of MonitoredItems to delete.
results	StatusCodeCollection	The list of results for the MonitoredItems to delete.
diagnosticInfos	DiagnosticInfoCollection	The diagnostic information for the results.
return	ResponseHeader

DeleteSubscriptions() public method

Invokes the DeleteSubscriptions service.

public DeleteSubscriptions ( RequestHeader requestHeader, UInt32Collection subscriptionIds, StatusCodeCollection &results, DiagnosticInfoCollection &diagnosticInfos ) : ResponseHeader
requestHeader	RequestHeader	The request header.
subscriptionIds	UInt32Collection	The list of Subscriptions to delete.
results	StatusCodeCollection	The list of result StatusCodes for the Subscriptions to delete.
diagnosticInfos	DiagnosticInfoCollection	The diagnostic information for the results.
return	ResponseHeader

FindServers() public method

Invokes the FindServers service.

public FindServers ( RequestHeader requestHeader, string endpointUrl, StringCollection localeIds, StringCollection serverUris, ApplicationDescriptionCollection &servers ) : ResponseHeader
requestHeader	RequestHeader	The request header.
endpointUrl	string	The endpoint URL.
localeIds	StringCollection	The locale ids.
serverUris	StringCollection	The server uris.
servers	ApplicationDescriptionCollection	List of Servers that meet criteria specified in the request.
return	ResponseHeader

GetEndpointDescriptions() protected method

Returns the endpoints that match the base addresss and endpoint url.

protected GetEndpointDescriptions ( string endpointUrl, IList baseAddresses, StringCollection localeIds ) : EndpointDescriptionCollection
endpointUrl	string
baseAddresses	IList
localeIds	StringCollection
return	EndpointDescriptionCollection

GetEndpointInstance() protected method

Returns an instance of the endpoint to use.

protected GetEndpointInstance ( System.ServiceModel.ServerBase server ) : EndpointBase
server	System.ServiceModel.ServerBase
return	EndpointBase

GetEndpoints() public method

Invokes the GetEndpoints service.

public GetEndpoints ( RequestHeader requestHeader, string endpointUrl, StringCollection localeIds, StringCollection profileUris, EndpointDescriptionCollection &endpoints ) : ResponseHeader
requestHeader	RequestHeader	The request header.
endpointUrl	string	The endpoint URL.
localeIds	StringCollection	The locale ids.
profileUris	StringCollection	The profile uris.
endpoints	EndpointDescriptionCollection	The endpoints supported by the server.
return	ResponseHeader

GetServiceContract() protected method

Returns the service contract to use.

protected GetServiceContract ( ) : Type
return	System.Type

GetStatus() public method

Returns the current status of the server.

public GetStatus ( ) : ServerStatusDataType
return	ServerStatusDataType

HistoryRead() public method

Invokes the HistoryRead service.

public HistoryRead ( RequestHeader requestHeader, ExtensionObject historyReadDetails, TimestampsToReturn timestampsToReturn, bool releaseContinuationPoints, HistoryReadValueIdCollection nodesToRead, HistoryReadResultCollection &results, DiagnosticInfoCollection &diagnosticInfos ) : ResponseHeader
requestHeader	RequestHeader	The request header.
historyReadDetails	ExtensionObject	The history read details.
timestampsToReturn	TimestampsToReturn	The timestamps to return.
releaseContinuationPoints	bool	if set to true continuation points are released.
nodesToRead	HistoryReadValueIdCollection	The nodes to read.
results	HistoryReadResultCollection	The results.
diagnosticInfos	DiagnosticInfoCollection	The diagnostic information for the results.
return	ResponseHeader

HistoryUpdate() public method

Invokes the HistoryUpdate service.

public HistoryUpdate ( RequestHeader requestHeader, ExtensionObjectCollection historyUpdateDetails, HistoryUpdateResultCollection &results, DiagnosticInfoCollection &diagnosticInfos ) : ResponseHeader
requestHeader	RequestHeader	The request header.
historyUpdateDetails	ExtensionObjectCollection	The details defined for the update.
results	HistoryUpdateResultCollection	The list of update results for the history update details.
diagnosticInfos	DiagnosticInfoCollection	The diagnostic information for the results.
return	ResponseHeader

InitializeServiceHosts() protected method

Creates the endpoints and creates the hosts.

protected InitializeServiceHosts ( ApplicationConfiguration configuration, BindingFactory bindingFactory, ApplicationDescription &serverDescription, EndpointDescriptionCollection &endpoints ) : IList
configuration	ApplicationConfiguration	The configuration.
bindingFactory	BindingFactory	The binding factory.
serverDescription	ApplicationDescription	The server description.
endpoints	EndpointDescriptionCollection	The endpoints.
return	IList

IsSecurityError() protected method

Returns whether the error is a security error.

protected IsSecurityError ( StatusCode error ) : bool
error	StatusCode	The error.
return	bool

ModifyMonitoredItems() public method

Invokes the ModifyMonitoredItems service.

public ModifyMonitoredItems ( RequestHeader requestHeader, uint subscriptionId, TimestampsToReturn timestampsToReturn, MonitoredItemModifyRequestCollection itemsToModify, MonitoredItemModifyResultCollection &results, DiagnosticInfoCollection &diagnosticInfos ) : ResponseHeader
requestHeader	RequestHeader	The request header.
subscriptionId	uint	The subscription id.
timestampsToReturn	TimestampsToReturn	The type of timestamps to be returned for the MonitoredItems.
itemsToModify	MonitoredItemModifyRequestCollection	The list of MonitoredItems to modify.
results	MonitoredItemModifyResultCollection	The list of results for the MonitoredItems to modify.
diagnosticInfos	DiagnosticInfoCollection	The diagnostic information for the results.
return	ResponseHeader

ModifySubscription() public method

Invokes the ModifySubscription service.

public ModifySubscription ( RequestHeader requestHeader, uint subscriptionId, double requestedPublishingInterval, uint requestedLifetimeCount, uint requestedMaxKeepAliveCount, uint maxNotificationsPerPublish, byte priority, double &revisedPublishingInterval, uint &revisedLifetimeCount, uint &revisedMaxKeepAliveCount ) : ResponseHeader
requestHeader	RequestHeader	The request header.
subscriptionId	uint	The subscription id.
requestedPublishingInterval	double	The cyclic rate that the Subscription is being requested to return Notifications to the Client.
requestedLifetimeCount	uint	The client-requested lifetime count for the Subscription.
requestedMaxKeepAliveCount	uint	The requested max keep alive count.
maxNotificationsPerPublish	uint	The maximum number of notifications that the Client wishes to receive in a single Publish response.
priority	byte	The relative priority of the Subscription.
revisedPublishingInterval	double	The revised publishing interval.
revisedLifetimeCount	uint	The revised lifetime count.
revisedMaxKeepAliveCount	uint	The revised max keep alive count.
return	ResponseHeader

OnApplicationCertificateError() protected method

Handles an error when validating the application instance certificate provided by a client.

protected OnApplicationCertificateError ( byte clientCertificate, ServiceResult result ) : void
clientCertificate	byte	The client certificate.
result	ServiceResult	The result.
return	void

OnNodeManagerStarted() protected method

Called after the node managers have been started.

protected OnNodeManagerStarted ( IServerInternal server ) : void
server	IServerInternal	The server.
return	void

OnRequestComplete() protected method

Verifies that the request header is valid.

protected OnRequestComplete ( OperationContext context ) : void
context	OperationContext	The operation context.
return	void

OnServerStarted() protected method

Called after the server has been started.

protected OnServerStarted ( IServerInternal server ) : void
server	IServerInternal	The server.
return	void

OnServerStarting() protected method

Called before the server starts.

protected OnServerStarting ( ApplicationConfiguration configuration ) : void
configuration	ApplicationConfiguration	The configuration.
return	void

OnServerStopping() protected method

Called before the server stops

protected OnServerStopping ( ) : void
return	void

OnUpdateConfiguration() protected method

Called when the server configuration is changed on disk.

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

protected OnUpdateConfiguration ( ApplicationConfiguration configuration ) : void
configuration	ApplicationConfiguration	The configuration.
return	void

ProcessRequest() protected method

Processes the request.

protected ProcessRequest ( IEndpointIncomingRequest request, object calldata ) : void
request	IEndpointIncomingRequest	The request.
calldata	object	The calldata passed with the request.
return	void

Publish() public method

Invokes the Publish service.

public Publish ( RequestHeader requestHeader, SubscriptionAcknowledgementCollection subscriptionAcknowledgements, uint &subscriptionId, UInt32Collection &availableSequenceNumbers, bool &moreNotifications, NotificationMessage &notificationMessage, StatusCodeCollection &results, DiagnosticInfoCollection &diagnosticInfos ) : ResponseHeader
requestHeader	RequestHeader	The request header.
subscriptionAcknowledgements	SubscriptionAcknowledgementCollection	The list of acknowledgements for one or more Subscriptions.
subscriptionId	uint	The subscription identifier.
availableSequenceNumbers	UInt32Collection	The available sequence numbers.
moreNotifications	bool	If set to true the number of Notifications that were ready to be sent could not be sent in a single response.
notificationMessage	NotificationMessage	The NotificationMessage that contains the list of Notifications.
results	StatusCodeCollection	The list of results for the acknowledgements.
diagnosticInfos	DiagnosticInfoCollection	The diagnostic information for the results.
return	ResponseHeader

Read() public method

Invokes the Read service.

public Read ( RequestHeader requestHeader, double maxAge, TimestampsToReturn timestampsToReturn, ReadValueIdCollection nodesToRead, DataValueCollection &results, DiagnosticInfoCollection &diagnosticInfos ) : ResponseHeader
requestHeader	RequestHeader	The request header.
maxAge	double	The Maximum age of the value to be read in milliseconds.
timestampsToReturn	TimestampsToReturn	The type of timestamps to be returned for the requested Variables.
nodesToRead	ReadValueIdCollection	The list of Nodes and their Attributes to read.
results	DataValueCollection	The list of returned Attribute values
diagnosticInfos	DiagnosticInfoCollection	The diagnostic information for the results.
return	ResponseHeader

RegisterNodes() public method

Invokes the RegisterNodes service.

public RegisterNodes ( RequestHeader requestHeader, NodeIdCollection nodesToRegister, NodeIdCollection &registeredNodeIds ) : ResponseHeader
requestHeader	RequestHeader	The request header.
nodesToRegister	NodeIdCollection	The list of NodeIds to register.
registeredNodeIds	NodeIdCollection	The list of NodeIds identifying the registered nodes.
return	ResponseHeader

RegisterWithDiscoveryServer() public method

Registers the server with the discovery server.

public RegisterWithDiscoveryServer ( ) : bool
return	bool

Republish() public method

Invokes the Republish service.

public Republish ( RequestHeader requestHeader, uint subscriptionId, uint retransmitSequenceNumber, NotificationMessage &notificationMessage ) : ResponseHeader
requestHeader	RequestHeader	The request header.
subscriptionId	uint	The subscription id.
retransmitSequenceNumber	uint	The sequence number of a specific NotificationMessage to be republished.
notificationMessage	NotificationMessage	The requested NotificationMessage.
return	ResponseHeader

SetMonitoringMode() public method

Invokes the SetMonitoringMode service.

public SetMonitoringMode ( RequestHeader requestHeader, uint subscriptionId, MonitoringMode monitoringMode, UInt32Collection monitoredItemIds, StatusCodeCollection &results, DiagnosticInfoCollection &diagnosticInfos ) : ResponseHeader
requestHeader	RequestHeader	The request header.
subscriptionId	uint	The subscription id.
monitoringMode	MonitoringMode	The monitoring mode to be set for the MonitoredItems.
monitoredItemIds	UInt32Collection	The list of MonitoredItems to modify.
results	StatusCodeCollection	The list of results for the MonitoredItems to modify.
diagnosticInfos	DiagnosticInfoCollection	The diagnostic information for the results.
return	ResponseHeader

SetPublishingMode() public method

Invokes the SetPublishingMode service.

public SetPublishingMode ( RequestHeader requestHeader, bool publishingEnabled, UInt32Collection subscriptionIds, StatusCodeCollection &results, DiagnosticInfoCollection &diagnosticInfos ) : ResponseHeader
requestHeader	RequestHeader	The request header.
publishingEnabled	bool	If set to true publishing of NotificationMessages is enabled for the Subscription.
subscriptionIds	UInt32Collection	The list of subscription ids.
results	StatusCodeCollection	The list of StatusCodes for the Subscriptions to enable/disable.
diagnosticInfos	DiagnosticInfoCollection	The diagnostic information for the results.
return	ResponseHeader

SetServerError() protected method

Reports an error during initialization after the base server object has been started.

protected SetServerError ( ServiceResult error ) : void
error	ServiceResult	The error.
return	void

SetServerState() protected method

Updates the server state.

protected SetServerState ( ServerState state ) : void
state	ServerState	The state.
return	void

SetTriggering() public method

Invokes the SetTriggering service.

public SetTriggering ( RequestHeader requestHeader, uint subscriptionId, uint triggeringItemId, UInt32Collection linksToAdd, UInt32Collection linksToRemove, StatusCodeCollection &addResults, DiagnosticInfoCollection &addDiagnosticInfos, StatusCodeCollection &removeResults, DiagnosticInfoCollection &removeDiagnosticInfos ) : ResponseHeader
requestHeader	RequestHeader	The request header.
subscriptionId	uint	The subscription id.
triggeringItemId	uint	The id for the MonitoredItem used as the triggering item.
linksToAdd	UInt32Collection	The list of ids of the items to report that are to be added as triggering links.
linksToRemove	UInt32Collection	The list of ids of the items to report for the triggering links to be deleted.
addResults	StatusCodeCollection	The list of StatusCodes for the items to add.
addDiagnosticInfos	DiagnosticInfoCollection	The list of diagnostic information for the links to add.
removeResults	StatusCodeCollection	The list of StatusCodes for the items to delete.
removeDiagnosticInfos	DiagnosticInfoCollection	The list of diagnostic information for the links to delete.
return	ResponseHeader

StandardServer() public method

Initializes the object with default values.

public StandardServer ( ) : System
return	System

StartApplication() protected method

Starts the server application.

protected StartApplication ( ApplicationConfiguration configuration ) : void
configuration	ApplicationConfiguration	The configuration.
return	void

TranslateBrowsePathsToNodeIds() public method

Invokes the TranslateBrowsePathsToNodeIds service.

public TranslateBrowsePathsToNodeIds ( RequestHeader requestHeader, BrowsePathCollection browsePaths, BrowsePathResultCollection &results, DiagnosticInfoCollection &diagnosticInfos ) : ResponseHeader
requestHeader	RequestHeader	The request header.
browsePaths	BrowsePathCollection	The list of browse paths for which NodeIds are being requested.
results	BrowsePathResultCollection	The list of results for the list of browse paths.
diagnosticInfos	DiagnosticInfoCollection	The diagnostic information for the results.
return	ResponseHeader

TranslateException() protected method

Translates an exception.

protected TranslateException ( DiagnosticsMasks diagnosticsMasks, IList preferredLocales, ServiceResultException e ) : ServiceResultException
diagnosticsMasks	DiagnosticsMasks	The fields to return.
preferredLocales	IList	The preferred locales.
e	ServiceResultException	The ServiceResultException e.
return	ServiceResultException

TranslateException() protected method

Translates an exception.

protected TranslateException ( OperationContext context, ServiceResultException e ) : ServiceResultException
context	OperationContext	The context.
e	ServiceResultException	The ServiceResultException e.
return	ServiceResultException

TranslateResult() protected method

Translates a service result.

protected TranslateResult ( DiagnosticsMasks diagnosticsMasks, IList preferredLocales, ServiceResult result ) : ServiceResult
diagnosticsMasks	DiagnosticsMasks	The fields to return.
preferredLocales	IList	The preferred locales.
result	ServiceResult	The result.
return	ServiceResult

UnregisterNodes() public method

Invokes the UnregisterNodes service.

public UnregisterNodes ( RequestHeader requestHeader, NodeIdCollection nodesToUnregister ) : ResponseHeader
requestHeader	RequestHeader	The request header.
nodesToUnregister	NodeIdCollection	The list of NodeIds to unregister
return	ResponseHeader

ValidateRequest() protected method

Verifies that the request header is valid.

protected ValidateRequest ( RequestHeader requestHeader, RequestType requestType ) : OperationContext
requestHeader	RequestHeader	The request header.
requestType	RequestType	Type of the request.
return	OperationContext

ValidateRequest() protected method

Verifies that the request header is valid.

protected ValidateRequest ( RequestHeader requestHeader ) : void
requestHeader	RequestHeader	The request header.
return	void

ValidateSoftwareCertificates() protected method

Inspects the software certificates provided by the server.

protected ValidateSoftwareCertificates ( List softwareCertificates ) : void
softwareCertificates	List	The software certificates.
return	void

Write() public method

Invokes the Write service.

public Write ( RequestHeader requestHeader, WriteValueCollection nodesToWrite, StatusCodeCollection &results, DiagnosticInfoCollection &diagnosticInfos ) : ResponseHeader
requestHeader	RequestHeader	The request header.
nodesToWrite	WriteValueCollection	The list of Nodes, Attributes, and values to write.
results	StatusCodeCollection	The list of write result status codes for each write operation.
diagnosticInfos	DiagnosticInfoCollection	The diagnostic information for the results.
return	ResponseHeader