C++ Based OPC UA Client/Server SDK  1.5.5.355
UaServer Class Reference

UaServer. More...

#include <uaserver.h>

Inherits UaThread.

Public Member Functions

 UaServer ()
 Constructs a UaServer object with default values.
 
virtual ~UaServer ()
 Destroys the UaServer object. More...
 
UaStatus initStackSettings (ServerConfig *pServerConfig)
 Initialize stack from configuration. More...
 
UaStatus startUp (ServerManager *pServerManager)
 Start up method for OPC UA server. More...
 
UaStatus shutDown ()
 Shut down method for OPC UA server. More...
 
OpcUa_StatusCode FindServers (OpcUa_Endpoint Endpoint, OpcUa_Handle CallContext, OpcUa_FindServersRequest *Request, OpcUa_EncodeableType *pRequestType)
 The implementation for the OpenSession service. More...
 
OpcUa_StatusCode GetEndpoints (OpcUa_Endpoint Endpoint, OpcUa_Handle CallContext, OpcUa_GetEndpointsRequest *Request, OpcUa_EncodeableType *pRequestType)
 The implementation for the OpenSession service. More...
 
OpcUa_StatusCode CreateSession (OpcUa_Endpoint Endpoint, OpcUa_Handle CallContext, OpcUa_CreateSessionRequest *Request, OpcUa_EncodeableType *pRequestType)
 The implementation for the OpenSession service. More...
 
OpcUa_StatusCode ActivateSession (OpcUa_Endpoint Endpoint, OpcUa_Handle CallContext, OpcUa_ActivateSessionRequest *Request, OpcUa_EncodeableType *pRequestType)
 The implementation for the ActivateSession service. More...
 
OpcUa_StatusCode CloseSession (OpcUa_Endpoint Endpoint, OpcUa_Handle CallContext, OpcUa_CloseSessionRequest *Request, OpcUa_EncodeableType *pRequestType)
 The implementation for the CloseSession service. More...
 
OpcUa_StatusCode Cancel (OpcUa_Endpoint Endpoint, OpcUa_Handle CallContext, OpcUa_CancelRequest *Request, OpcUa_EncodeableType *pRequestType)
 The implementation for the Cancel service. More...
 
OpcUa_StatusCode AddNodes (OpcUa_Endpoint Endpoint, OpcUa_Handle CallContext, OpcUa_AddNodesRequest *Request, OpcUa_EncodeableType *pRequestType)
 The implementation for the AddNodes service. More...
 
OpcUa_StatusCode AddReferences (OpcUa_Endpoint Endpoint, OpcUa_Handle CallContext, OpcUa_AddReferencesRequest *Request, OpcUa_EncodeableType *pRequestType)
 The implementation for the AddReferences service. More...
 
OpcUa_StatusCode DeleteNodes (OpcUa_Endpoint Endpoint, OpcUa_Handle CallContext, OpcUa_DeleteNodesRequest *Request, OpcUa_EncodeableType *pRequestType)
 The implementation for the DeleteNodes service. More...
 
OpcUa_StatusCode DeleteReferences (OpcUa_Endpoint Endpoint, OpcUa_Handle CallContext, OpcUa_DeleteReferencesRequest *Request, OpcUa_EncodeableType *pRequestType)
 The implementation for the DeleteReferences service. More...
 
OpcUa_StatusCode Browse (OpcUa_Endpoint Endpoint, OpcUa_Handle CallContext, OpcUa_BrowseRequest *Request, OpcUa_EncodeableType *pRequestType)
 The implementation for the Browse service. More...
 
OpcUa_StatusCode BrowseNext (OpcUa_Endpoint Endpoint, OpcUa_Handle CallContext, OpcUa_BrowseNextRequest *Request, OpcUa_EncodeableType *pRequestType)
 The implementation for the BrowseNext service. More...
 
OpcUa_StatusCode QueryFirst (OpcUa_Endpoint Endpoint, OpcUa_Handle CallContext, OpcUa_QueryFirstRequest *Request, OpcUa_EncodeableType *pRequestType)
 The implementation for the QueryFirst service. More...
 
OpcUa_StatusCode QueryNext (OpcUa_Endpoint Endpoint, OpcUa_Handle CallContext, OpcUa_QueryNextRequest *Request, OpcUa_EncodeableType *pRequestType)
 The implementation for the QueryNext service. More...
 
OpcUa_StatusCode TranslateBrowsePathsToNodeIds (OpcUa_Endpoint Endpoint, OpcUa_Handle CallContext, OpcUa_TranslateBrowsePathsToNodeIdsRequest *Request, OpcUa_EncodeableType *pRequestType)
 The implementation for the TranslateBrowsePathsToNodeIds service. More...
 
OpcUa_StatusCode RegisterNodes (OpcUa_Endpoint Endpoint, OpcUa_Handle CallContext, OpcUa_RegisterNodesRequest *Request, OpcUa_EncodeableType *pRequestType)
 The implementation for the RegisterNodes service. More...
 
OpcUa_StatusCode UnregisterNodes (OpcUa_Endpoint Endpoint, OpcUa_Handle CallContext, OpcUa_UnregisterNodesRequest *Request, OpcUa_EncodeableType *pRequestType)
 The implementation for the UnregisterNodes service. More...
 
OpcUa_StatusCode Read (OpcUa_Endpoint Endpoint, OpcUa_Handle CallContext, OpcUa_ReadRequest *Request, OpcUa_EncodeableType *pRequestType)
 The implementation for the Read service. More...
 
OpcUa_StatusCode Write (OpcUa_Endpoint Endpoint, OpcUa_Handle CallContext, OpcUa_WriteRequest *Request, OpcUa_EncodeableType *pRequestType)
 The implementation for the Write service. More...
 
OpcUa_StatusCode HistoryRead (OpcUa_Endpoint Endpoint, OpcUa_Handle CallContext, OpcUa_HistoryReadRequest *Request, OpcUa_EncodeableType *pRequestType)
 The implementation for the HistoryRead service. More...
 
OpcUa_StatusCode HistoryUpdate (OpcUa_Endpoint Endpoint, OpcUa_Handle CallContext, OpcUa_HistoryUpdateRequest *Request, OpcUa_EncodeableType *pRequestType)
 The implementation for the HistoryUpdate service. More...
 
OpcUa_StatusCode Call (OpcUa_Endpoint Endpoint, OpcUa_Handle CallContext, OpcUa_CallRequest *Request, OpcUa_EncodeableType *pRequestType)
 The implementation for the Call service. More...
 
OpcUa_StatusCode CreateSubscription (OpcUa_Endpoint Endpoint, OpcUa_Handle CallContext, OpcUa_CreateSubscriptionRequest *Request, OpcUa_EncodeableType *pRequestType)
 The implementation for the CreateSubscription service. More...
 
OpcUa_StatusCode ModifySubscription (OpcUa_Endpoint Endpoint, OpcUa_Handle CallContext, OpcUa_ModifySubscriptionRequest *Request, OpcUa_EncodeableType *pRequestType)
 The implementation for the ModifySubscription service. More...
 
OpcUa_StatusCode SetPublishingMode (OpcUa_Endpoint Endpoint, OpcUa_Handle CallContext, OpcUa_SetPublishingModeRequest *Request, OpcUa_EncodeableType *pRequestType)
 The implementation for the SetPublishingMode service. More...
 
OpcUa_StatusCode Publish (OpcUa_Endpoint Endpoint, OpcUa_Handle CallContext, OpcUa_PublishRequest *Request, OpcUa_EncodeableType *pRequestType)
 The implementation for the Publish service. More...
 
OpcUa_StatusCode Republish (OpcUa_Endpoint Endpoint, OpcUa_Handle CallContext, OpcUa_RepublishRequest *Request, OpcUa_EncodeableType *pRequestType)
 The implementation for the Republish service. More...
 
OpcUa_StatusCode TransferSubscriptions (OpcUa_Endpoint Endpoint, OpcUa_Handle CallContext, OpcUa_TransferSubscriptionsRequest *Request, OpcUa_EncodeableType *pRequestType)
 The implementation for the TransferSubscriptions service. More...
 
OpcUa_StatusCode DeleteSubscriptions (OpcUa_Endpoint Endpoint, OpcUa_Handle CallContext, OpcUa_DeleteSubscriptionsRequest *Request, OpcUa_EncodeableType *pRequestType)
 The implementation for the DeleteSubscriptions service. More...
 
OpcUa_StatusCode CreateMonitoredItems (OpcUa_Endpoint Endpoint, OpcUa_Handle CallContext, OpcUa_CreateMonitoredItemsRequest *Request, OpcUa_EncodeableType *pRequestType)
 The implementation for the CreateMonitoredItems service. More...
 
OpcUa_StatusCode ModifyMonitoredItems (OpcUa_Endpoint Endpoint, OpcUa_Handle CallContext, OpcUa_ModifyMonitoredItemsRequest *Request, OpcUa_EncodeableType *pRequestType)
 The implementation for the ModifyMonitoredItems service. More...
 
OpcUa_StatusCode SetMonitoringMode (OpcUa_Endpoint Endpoint, OpcUa_Handle CallContext, OpcUa_SetMonitoringModeRequest *Request, OpcUa_EncodeableType *pRequestType)
 The implementation for the SetMonitoringMode service. More...
 
OpcUa_StatusCode SetTriggering (OpcUa_Endpoint Endpoint, OpcUa_Handle CallContext, OpcUa_SetTriggeringRequest *Request, OpcUa_EncodeableType *pRequestType)
 The implementation for the SetTriggering service. More...
 
OpcUa_StatusCode DeleteMonitoredItems (OpcUa_Endpoint Endpoint, OpcUa_Handle CallContext, OpcUa_DeleteMonitoredItemsRequest *Request, OpcUa_EncodeableType *pRequestType)
 The implementation for the DeleteMonitoredItems service. More...
 
void secureChannelCreated (OpcUa_Endpoint hEndpoint, OpcUa_UInt32 uSecureChannelId, OpcUa_StatusCode uStatus, const UaString &sSecurityPolicy, OpcUa_UInt16 uSecurityMode, const UaByteString &clientCertificate)
 Event to inform server about creation of a secure channel. More...
 
OpcUa_StatusCode secureChannelCertificateError (OpcUa_Endpoint hEndpoint, OpcUa_StatusCode uStatus, const UaByteString &clientCertificate)
 Event to inform server about a certificate error at secure channel creation. More...
 
void secureChannelDeleted (OpcUa_Endpoint hEndpoint, OpcUa_UInt32 uSecureChannelId)
 Event to inform server about deletion of a secure channel. More...
 
void secureChannelTransportClosed (OpcUa_Endpoint hEndpoint, OpcUa_UInt32 uSecureChannelId)
 Event to inform server that the transport connection for the secure channel was closed. More...
 
void secureChannelRenewed (OpcUa_Endpoint hEndpoint, OpcUa_UInt32 uSecureChannelId)
 Event to inform server that the secure channel was renewed. More...
 
OpcUa_UInt32 getEndpointCount ()
 Returns the number of OPC UA endpoints in the server. More...
 
UaEndpointgetEndpointByIndex (OpcUa_UInt32 endpointIndex)
 Returns the endpoint at the sepcified index. More...
 
OpcUa_UInt32 addEndpoint (UaEndpoint *pEndpoint)
 Adds an endpoint to the server. More...
 
UaStatus openEndpoint (OpcUa_UInt32 endpointIndex)
 Opens the endpoint sepcified by the index. More...
 
UaStatus closeEndpoint (OpcUa_UInt32 endpointIndex)
 Closes the endpoint sepcified by the index. More...
 
- Public Member Functions inherited from UaThread
 UaThread ()
 Constructs a thread management object without starting the thread.
 
virtual ~UaThread ()
 Destroys the thread management object.
 
virtual void start ()
 Starts the thread managed by this object. More...
 
OpcUa_Boolean wait (OpcUa_UInt32 time=OpcUa_UInt32_Max)
 Waits for the termination of the thread. More...
 
OpcUa_Boolean running () const
 Returns the running state of the thread. More...
 
OpcUa_Boolean finished () const
 Returns the finished state of the thread. More...
 

Protected Member Functions

virtual UaTransactionManagercreateUaTransactionManager (ServerManager *pServerManager, UaSubscriptionManager *pUaSubscriptionManager)
 This function creates the UaTransactionManager. More...
 
virtual UaSubscriptionManagercreateUaSubscriptionManager (ServerManager *pServerManager)
 This function creates the UaSubscriptionManager. More...
 
virtual void validateEndpoints (UaEndpointArray &)
 This method is called before the endpoints are openened to allow a modification. More...
 

Additional Inherited Members

- Static Public Member Functions inherited from UaThread
static OpcUa_UInt32 currentThread ()
 Get thread ID of current thread. More...
 
static void sleep (OpcUa_UInt32 secs)
 Sleep for n seconds. More...
 
static void msleep (OpcUa_UInt32 msecs)
 Sleep for n milliseconds. More...
 
static void usleep (OpcUa_UInt32 usecs)
 Sleep for n microseconds. More...
 

Detailed Description

UaServer.

OPC UA Server Main Entry Class. Derived from UaThread It is not possible to create shallow copies of this class. It is not possible to use the default constructor.

Constructor & Destructor Documentation

UaServer::~UaServer ( )
virtual

Destroys the UaServer object.

Member Function Documentation

OpcUa_StatusCode UaServer::ActivateSession ( OpcUa_Endpoint  a_pEndpoint,
OpcUa_Handle  a_hCallContext,
OpcUa_ActivateSessionRequest a_pRequest,
OpcUa_EncodeableType a_pRequestType 
)

The implementation for the ActivateSession service.

Parameters
a_pEndpointconfigured endpoints for the server.
a_hCallContextCallback context used for the transaction.
a_pRequestthe request of the current send information.
a_pRequestTypethe type of the Request.
Returns
OPC UA status code
OpcUa_UInt32 UaServer::addEndpoint ( UaEndpoint pEndpoint)

Adds an endpoint to the server.

Returns
Index of added endpoint.
Parameters
[in]pEndpointEndpoiont to add to the server
OpcUa_StatusCode UaServer::AddNodes ( OpcUa_Endpoint  a_pEndpoint,
OpcUa_Handle  a_hCallContext,
OpcUa_AddNodesRequest a_pRequest,
OpcUa_EncodeableType a_pRequestType 
)

The implementation for the AddNodes service.

Parameters
a_pEndpointconfigured endpoints for the server.
a_hCallContextCallback context used for the transaction.
a_pRequestthe request of the current send information.
a_pRequestTypethe type of the Request.
Returns
OPC UA status code
OpcUa_StatusCode UaServer::AddReferences ( OpcUa_Endpoint  a_pEndpoint,
OpcUa_Handle  a_hCallContext,
OpcUa_AddReferencesRequest a_pRequest,
OpcUa_EncodeableType a_pRequestType 
)

The implementation for the AddReferences service.

Parameters
a_pEndpointconfigured endpoints for the server.
a_hCallContextCallback context used for the transaction.
a_pRequestthe request of the current send information.
a_pRequestTypethe type of the Request.
Returns
OPC UA status code
OpcUa_StatusCode UaServer::Browse ( OpcUa_Endpoint  a_pEndpoint,
OpcUa_Handle  a_hCallContext,
OpcUa_BrowseRequest a_pRequest,
OpcUa_EncodeableType a_pRequestType 
)

The implementation for the Browse service.

Parameters
a_pEndpointconfigured endpoints for the server.
a_hCallContextCallback context used for the transaction.
a_pRequestthe request of the current send information.
a_pRequestTypethe type of the Request.
Returns
OPC UA status code
OpcUa_StatusCode UaServer::BrowseNext ( OpcUa_Endpoint  a_pEndpoint,
OpcUa_Handle  a_hCallContext,
OpcUa_BrowseNextRequest a_pRequest,
OpcUa_EncodeableType a_pRequestType 
)

The implementation for the BrowseNext service.

Parameters
a_pEndpointconfigured endpoints for the server.
a_hCallContextCallback context used for the transaction.
a_pRequestthe request of the current send information.
a_pRequestTypethe type of the Request.
Returns
OPC UA status code
OpcUa_StatusCode UaServer::Call ( OpcUa_Endpoint  a_pEndpoint,
OpcUa_Handle  a_hCallContext,
OpcUa_CallRequest a_pRequest,
OpcUa_EncodeableType a_pRequestType 
)

The implementation for the Call service.

Parameters
a_pEndpointconfigured endpoints for the server.
a_hCallContextCallback context used for the transaction.
a_pRequestthe request of the current send information.
a_pRequestTypethe type of the Request.
Returns
OPC UA status code
OpcUa_StatusCode UaServer::Cancel ( OpcUa_Endpoint  a_pEndpoint,
OpcUa_Handle  a_hCallContext,
OpcUa_CancelRequest a_pRequest,
OpcUa_EncodeableType a_pRequestType 
)

The implementation for the Cancel service.

Parameters
a_pEndpointconfigured endpoints for the server.
a_hCallContextCallback context used for the transaction.
a_pRequestthe request of the current send information.
a_pRequestTypethe type of the Request.
Returns
OPC UA status code
UaStatus UaServer::closeEndpoint ( OpcUa_UInt32  endpointIndex)

Closes the endpoint sepcified by the index.

Parameters
[in]endpointIndexIndex of the Endpoint to close
OpcUa_StatusCode UaServer::CloseSession ( OpcUa_Endpoint  a_pEndpoint,
OpcUa_Handle  a_hCallContext,
OpcUa_CloseSessionRequest a_pRequest,
OpcUa_EncodeableType a_pRequestType 
)

The implementation for the CloseSession service.

Parameters
a_pEndpointconfigured endpoints for the server.
a_hCallContextCallback context used for the transaction.
a_pRequestthe request of the current send information.
a_pRequestTypethe type of the Request.
Returns
OPC UA status code
OpcUa_StatusCode UaServer::CreateMonitoredItems ( OpcUa_Endpoint  a_pEndpoint,
OpcUa_Handle  a_hCallContext,
OpcUa_CreateMonitoredItemsRequest a_pRequest,
OpcUa_EncodeableType a_pRequestType 
)

The implementation for the CreateMonitoredItems service.

Parameters
a_pEndpointconfigured endpoints for the server.
a_hCallContextCallback context used for the transaction.
a_pRequestthe request of the current send information.
a_pRequestTypethe type of the Request.
Returns
OPC UA status code
OpcUa_StatusCode UaServer::CreateSession ( OpcUa_Endpoint  a_pEndpoint,
OpcUa_Handle  a_hCallContext,
OpcUa_CreateSessionRequest a_pRequest,
OpcUa_EncodeableType a_pRequestType 
)

The implementation for the OpenSession service.

Parameters
a_pEndpointconfigured endpoints for the server.
a_hCallContextCallback context used for the transaction.
a_pRequestthe request of the current send information.
a_pRequestTypethe type of the Request.
Returns
OPC UA status code
OpcUa_StatusCode UaServer::CreateSubscription ( OpcUa_Endpoint  a_pEndpoint,
OpcUa_Handle  a_hCallContext,
OpcUa_CreateSubscriptionRequest a_pRequest,
OpcUa_EncodeableType a_pRequestType 
)

The implementation for the CreateSubscription service.

Parameters
a_pEndpointconfigured endpoints for the server.
a_hCallContextCallback context used for the transaction.
a_pRequestthe request of the current send information.
a_pRequestTypethe type of the Request.
Returns
OPC UA status code
UaSubscriptionManager * UaServer::createUaSubscriptionManager ( ServerManager pServerManager)
protectedvirtual

This function creates the UaSubscriptionManager.

The virtual function can be overwritten by a derived class to create a class derived from UaSubscriptionManager instead of UaSubscriptionManager. An instance of a derived class of UaServer can be passed to UaModule::initialize() to force the UaModule to use this instance instead of creating a UaServer

UaTransactionManager * UaServer::createUaTransactionManager ( ServerManager pServerManager,
UaSubscriptionManager pUaSubscriptionManager 
)
protectedvirtual

This function creates the UaTransactionManager.

The virtual function can be overwritten by a derived class to create a class derived from UaTransactionManager instead of UaTransactionManager. An instance of a derived class of UaServer can be passed to UaModule::initialize() to force the UaModule to use this instance instead of creating a UaServer

OpcUa_StatusCode UaServer::DeleteMonitoredItems ( OpcUa_Endpoint  a_pEndpoint,
OpcUa_Handle  a_hCallContext,
OpcUa_DeleteMonitoredItemsRequest a_pRequest,
OpcUa_EncodeableType a_pRequestType 
)

The implementation for the DeleteMonitoredItems service.

Parameters
a_pEndpointconfigured endpoints for the server.
a_hCallContextCallback context used for the transaction.
a_pRequestthe request of the current send information.
a_pRequestTypethe type of the Request.
Returns
OPC UA status code
OpcUa_StatusCode UaServer::DeleteNodes ( OpcUa_Endpoint  a_pEndpoint,
OpcUa_Handle  a_hCallContext,
OpcUa_DeleteNodesRequest a_pRequest,
OpcUa_EncodeableType a_pRequestType 
)

The implementation for the DeleteNodes service.

Parameters
a_pEndpointconfigured endpoints for the server.
a_hCallContextCallback context used for the transaction.
a_pRequestthe request of the current send information.
a_pRequestTypethe type of the Request.
Returns
OPC UA status code
OpcUa_StatusCode UaServer::DeleteReferences ( OpcUa_Endpoint  a_pEndpoint,
OpcUa_Handle  a_hCallContext,
OpcUa_DeleteReferencesRequest a_pRequest,
OpcUa_EncodeableType a_pRequestType 
)

The implementation for the DeleteReferences service.

Parameters
a_pEndpointconfigured endpoints for the server.
a_hCallContextCallback context used for the transaction.
a_pRequestthe request of the current send information.
a_pRequestTypethe type of the Request.
Returns
OPC UA status code
OpcUa_StatusCode UaServer::DeleteSubscriptions ( OpcUa_Endpoint  a_pEndpoint,
OpcUa_Handle  a_hCallContext,
OpcUa_DeleteSubscriptionsRequest a_pRequest,
OpcUa_EncodeableType a_pRequestType 
)

The implementation for the DeleteSubscriptions service.

Parameters
a_pEndpointconfigured endpoints for the server.
a_hCallContextCallback context used for the transaction.
a_pRequestthe request of the current send information.
a_pRequestTypethe type of the Request.
Returns
OPC UA status code
OpcUa_StatusCode UaServer::FindServers ( OpcUa_Endpoint  a_pEndpoint,
OpcUa_Handle  a_hCallContext,
OpcUa_FindServersRequest a_pRequest,
OpcUa_EncodeableType a_pRequestType 
)

The implementation for the OpenSession service.

Parameters
a_pEndpointconfigured endpoints for the server.
a_hCallContextCallback context used for the transaction.
a_pRequestthe request of the current send information.
a_pRequestTypethe type of the Request.
Returns
OPC UA status code
UaEndpoint * UaServer::getEndpointByIndex ( OpcUa_UInt32  endpointIndex)

Returns the endpoint at the sepcified index.

Parameters
[in]endpointIndexIndex of the Endpoint to return
OpcUa_UInt32 UaServer::getEndpointCount ( )

Returns the number of OPC UA endpoints in the server.

OpcUa_StatusCode UaServer::GetEndpoints ( OpcUa_Endpoint  a_pEndpoint,
OpcUa_Handle  a_hCallContext,
OpcUa_GetEndpointsRequest a_pRequest,
OpcUa_EncodeableType a_pRequestType 
)

The implementation for the OpenSession service.

Parameters
a_pEndpointconfigured endpoints for the server.
a_hCallContextCallback context used for the transaction.
a_pRequestthe request of the current send information.
a_pRequestTypethe type of the Request.
Returns
OPC UA status code
OpcUa_StatusCode UaServer::HistoryRead ( OpcUa_Endpoint  a_pEndpoint,
OpcUa_Handle  a_hCallContext,
OpcUa_HistoryReadRequest a_pRequest,
OpcUa_EncodeableType a_pRequestType 
)

The implementation for the HistoryRead service.

Parameters
a_pEndpointconfigured endpoints for the server.
a_hCallContextCallback context used for the transaction.
a_pRequestthe request of the current send information.
a_pRequestTypethe type of the Request.
Returns
OPC UA status code
OpcUa_StatusCode UaServer::HistoryUpdate ( OpcUa_Endpoint  a_pEndpoint,
OpcUa_Handle  a_hCallContext,
OpcUa_HistoryUpdateRequest a_pRequest,
OpcUa_EncodeableType a_pRequestType 
)

The implementation for the HistoryUpdate service.

Parameters
a_pEndpointconfigured endpoints for the server.
a_hCallContextCallback context used for the transaction.
a_pRequestthe request of the current send information.
a_pRequestTypethe type of the Request.
Returns
OPC UA status code
UaStatus UaServer::initStackSettings ( ServerConfig pServerConfig)

Initialize stack from configuration.

OpcUa_StatusCode UaServer::ModifyMonitoredItems ( OpcUa_Endpoint  a_pEndpoint,
OpcUa_Handle  a_hCallContext,
OpcUa_ModifyMonitoredItemsRequest a_pRequest,
OpcUa_EncodeableType a_pRequestType 
)

The implementation for the ModifyMonitoredItems service.

Parameters
a_pEndpointconfigured endpoints for the server.
a_hCallContextCallback context used for the transaction.
a_pRequestthe request of the current send information.
a_pRequestTypethe type of the Request.
Returns
OPC UA status code
OpcUa_StatusCode UaServer::ModifySubscription ( OpcUa_Endpoint  a_pEndpoint,
OpcUa_Handle  a_hCallContext,
OpcUa_ModifySubscriptionRequest a_pRequest,
OpcUa_EncodeableType a_pRequestType 
)

The implementation for the ModifySubscription service.

Parameters
a_pEndpointconfigured endpoints for the server.
a_hCallContextCallback context used for the transaction.
a_pRequestthe request of the current send information.
a_pRequestTypethe type of the Request.
Returns
OPC UA status code
UaStatus UaServer::openEndpoint ( OpcUa_UInt32  endpointIndex)

Opens the endpoint sepcified by the index.

Parameters
[in]endpointIndexIndex of the Endpoint to open
OpcUa_StatusCode UaServer::Publish ( OpcUa_Endpoint  a_pEndpoint,
OpcUa_Handle  a_hCallContext,
OpcUa_PublishRequest a_pRequest,
OpcUa_EncodeableType a_pRequestType 
)

The implementation for the Publish service.

Parameters
a_pEndpointconfigured endpoints for the server.
a_hCallContextCallback context used for the transaction.
a_pRequestthe request of the current send information.
a_pRequestTypethe type of the Request.
Returns
OPC UA status code
OpcUa_StatusCode UaServer::QueryFirst ( OpcUa_Endpoint  a_pEndpoint,
OpcUa_Handle  a_hCallContext,
OpcUa_QueryFirstRequest a_pRequest,
OpcUa_EncodeableType a_pRequestType 
)

The implementation for the QueryFirst service.

Parameters
a_pEndpointconfigured endpoints for the server.
a_hCallContextCallback context used for the transaction.
a_pRequestthe request of the current send information.
a_pRequestTypethe type of the Request.
Returns
OPC UA status code
OpcUa_StatusCode UaServer::QueryNext ( OpcUa_Endpoint  a_pEndpoint,
OpcUa_Handle  a_hCallContext,
OpcUa_QueryNextRequest a_pRequest,
OpcUa_EncodeableType a_pRequestType 
)

The implementation for the QueryNext service.

Parameters
a_pEndpointconfigured endpoints for the server.
a_hCallContextCallback context used for the transaction.
a_pRequestthe request of the current send information.
a_pRequestTypethe type of the Request.
Returns
OPC UA status code
OpcUa_StatusCode UaServer::Read ( OpcUa_Endpoint  a_pEndpoint,
OpcUa_Handle  a_hCallContext,
OpcUa_ReadRequest a_pRequest,
OpcUa_EncodeableType a_pRequestType 
)

The implementation for the Read service.

Parameters
a_pEndpointconfigured endpoints for the server.
a_hCallContextCallback context used for the transaction.
a_pRequestthe request of the current send information.
a_pRequestTypethe type of the Request.
Returns
OPC UA status code
OpcUa_StatusCode UaServer::RegisterNodes ( OpcUa_Endpoint  a_pEndpoint,
OpcUa_Handle  a_hCallContext,
OpcUa_RegisterNodesRequest a_pRequest,
OpcUa_EncodeableType a_pRequestType 
)

The implementation for the RegisterNodes service.

Parameters
a_pEndpointconfigured endpoints for the server.
a_hCallContextCallback context used for the transaction.
a_pRequestthe request of the current send information.
a_pRequestTypethe type of the Request.
Returns
OPC UA status code
OpcUa_StatusCode UaServer::Republish ( OpcUa_Endpoint  a_pEndpoint,
OpcUa_Handle  a_hCallContext,
OpcUa_RepublishRequest a_pRequest,
OpcUa_EncodeableType a_pRequestType 
)

The implementation for the Republish service.

Parameters
a_pEndpointconfigured endpoints for the server.
a_hCallContextCallback context used for the transaction.
a_pRequestthe request of the current send information.
a_pRequestTypethe type of the Request.
Returns
OPC UA status code
OpcUa_StatusCode UaServer::secureChannelCertificateError ( OpcUa_Endpoint  hEndpoint,
OpcUa_StatusCode  uStatus,
const UaByteString clientCertificate 
)

Event to inform server about a certificate error at secure channel creation.

Parameters
hEndpointthe Endpoint used to create the secure channel.
uStatusError code
clientCertificatethe certificate the Client sends to the Server.
void UaServer::secureChannelCreated ( OpcUa_Endpoint  hEndpoint,
OpcUa_UInt32  uSecureChannelId,
OpcUa_StatusCode  uStatus,
const UaString sSecurityPolicy,
OpcUa_UInt16  uSecurityMode,
const UaByteString clientCertificate 
)

Event to inform server about creation of a secure channel.

Parameters
hEndpointthe Endpoint used to create the secure channel.
uSecureChannelIdthe SecureChannelId to be created.
uStatusError code
sSecurityPolicyThe security policy in case of open or renew.
uSecurityModeThe security mode, if the event type refers to a secure channel.
clientCertificatethe certificate the Client sends to the Server.
void UaServer::secureChannelDeleted ( OpcUa_Endpoint  hEndpoint,
OpcUa_UInt32  uSecureChannelId 
)

Event to inform server about deletion of a secure channel.

Parameters
hEndpointthe Endpoint used to delete the secure channel.
uSecureChannelIdthe SecureChannelId to be deleted.
void UaServer::secureChannelRenewed ( OpcUa_Endpoint  hEndpoint,
OpcUa_UInt32  uSecureChannelId 
)

Event to inform server that the secure channel was renewed.

Parameters
hEndpointthe Endpoint used to create the secure channel.
uSecureChannelIdthe SecureChannelId of the channel renewed.
void UaServer::secureChannelTransportClosed ( OpcUa_Endpoint  hEndpoint,
OpcUa_UInt32  uSecureChannelId 
)

Event to inform server that the transport connection for the secure channel was closed.

Parameters
hEndpointthe Endpoint used to create the secure channel.
uSecureChannelIdthe SecureChannelId of the channel where the transport connection was closed.
OpcUa_StatusCode UaServer::SetMonitoringMode ( OpcUa_Endpoint  a_pEndpoint,
OpcUa_Handle  a_hCallContext,
OpcUa_SetMonitoringModeRequest a_pRequest,
OpcUa_EncodeableType a_pRequestType 
)

The implementation for the SetMonitoringMode service.

Parameters
a_pEndpointconfigured endpoints for the server.
a_hCallContextCallback context used for the transaction.
a_pRequestthe request of the current send information.
a_pRequestTypethe type of the Request.
Returns
OPC UA status code
OpcUa_StatusCode UaServer::SetPublishingMode ( OpcUa_Endpoint  a_pEndpoint,
OpcUa_Handle  a_hCallContext,
OpcUa_SetPublishingModeRequest a_pRequest,
OpcUa_EncodeableType a_pRequestType 
)

The implementation for the SetPublishingMode service.

Parameters
a_pEndpointconfigured endpoints for the server.
a_hCallContextCallback context used for the transaction.
a_pRequestthe request of the current send information.
a_pRequestTypethe type of the Request.
Returns
OPC UA status code
OpcUa_StatusCode UaServer::SetTriggering ( OpcUa_Endpoint  a_pEndpoint,
OpcUa_Handle  a_hCallContext,
OpcUa_SetTriggeringRequest a_pRequest,
OpcUa_EncodeableType a_pRequestType 
)

The implementation for the SetTriggering service.

Parameters
a_pEndpointconfigured endpoints for the server.
a_hCallContextCallback context used for the transaction.
a_pRequestthe request of the current send information.
a_pRequestTypethe type of the Request.
Returns
OPC UA status code
UaStatus UaServer::shutDown ( )

Shut down method for OPC UA server.

Returns
Error code
UaStatus UaServer::startUp ( ServerManager pServerManager)

Start up method for OPC UA server.

Returns
Error code
OpcUa_StatusCode UaServer::TransferSubscriptions ( OpcUa_Endpoint  a_pEndpoint,
OpcUa_Handle  a_hCallContext,
OpcUa_TransferSubscriptionsRequest a_pRequest,
OpcUa_EncodeableType a_pRequestType 
)

The implementation for the TransferSubscriptions service.

Parameters
a_pEndpointconfigured endpoints for the server.
a_hCallContextCallback context used for the transaction.
a_pRequestthe request of the current send information.
a_pRequestTypethe type of the Request.
Returns
OPC UA status code
OpcUa_StatusCode UaServer::TranslateBrowsePathsToNodeIds ( OpcUa_Endpoint  a_pEndpoint,
OpcUa_Handle  a_hCallContext,
OpcUa_TranslateBrowsePathsToNodeIdsRequest a_pRequest,
OpcUa_EncodeableType a_pRequestType 
)

The implementation for the TranslateBrowsePathsToNodeIds service.

Parameters
a_pEndpointconfigured endpoints for the server.
a_hCallContextCallback context used for the transaction.
a_pRequestthe request of the current send information.
a_pRequestTypethe type of the Request.
Returns
OPC UA status code
OpcUa_StatusCode UaServer::UnregisterNodes ( OpcUa_Endpoint  a_pEndpoint,
OpcUa_Handle  a_hCallContext,
OpcUa_UnregisterNodesRequest a_pRequest,
OpcUa_EncodeableType a_pRequestType 
)

The implementation for the UnregisterNodes service.

Parameters
a_pEndpointconfigured endpoints for the server.
a_hCallContextCallback context used for the transaction.
a_pRequestthe request of the current send information.
a_pRequestTypethe type of the Request.
Returns
OPC UA status code
virtual void UaServer::validateEndpoints ( UaEndpointArray )
inlineprotectedvirtual

This method is called before the endpoints are openened to allow a modification.

This allows a derived class to add or modify endpoints for special use cases like internal communication with other components of a product.

OpcUa_StatusCode UaServer::Write ( OpcUa_Endpoint  a_pEndpoint,
OpcUa_Handle  a_hCallContext,
OpcUa_WriteRequest a_pRequest,
OpcUa_EncodeableType a_pRequestType 
)

The implementation for the Write service.

Parameters
a_pEndpointconfigured endpoints for the server.
a_hCallContextCallback context used for the transaction.
a_pRequestthe request of the current send information.
a_pRequestTypethe type of the Request.
Returns
OPC UA status code

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