UaObjectServer Class Reference

Derived from UaObjectBase and EventManager. It is not possible to create plane copies of this Class. More...

#include <uaobjectsserver.h>

Inheritance diagram for UaObjectServer:

Inheritance graph
[legend]
Collaboration diagram for UaObjectServer:

Collaboration graph
[legend]

List of all members.


Public Member Functions

 UaObjectServer (const UaString &name, const UaNodeId &nodeId, const UaString &defaultLocaleId)
virtual ~UaObjectServer ()
UaStatus startUp (UaReferenceLists *pTypeSourceNode, ServerConfig *pServerConfig, NodeManagerConfig *pNodeManagerConfig)
UaStatus shutDown ()
UaStatus beginEventTransaction (EventManagerCallback *pCallback, const ServiceContext &serviceContext, OpcUa_UInt32 hTransaction, OpcUa_Handle &hEventManagerContext)
UaStatus beginStartMonitoring (OpcUa_Handle hEventManagerContext, OpcUa_UInt32 callbackHandle, OpcUa_UInt32 eventManagerIndex, EventCallback *pEventCallback, OpcUa_EventFilter *pEventFilter, OpcUa_Double samplingInterval)
UaStatus beginModifyMonitoring (OpcUa_Handle hEventManagerContext, OpcUa_UInt32 callbackHandle, OpcUa_UInt32 eventManagerIndex, OpcUa_UInt32 hEventItem, OpcUa_Int32 samplingInterval)
UaStatus beginStopMonitoring (OpcUa_Handle hEventManagerContext, OpcUa_UInt32 callbackHandle, OpcUa_UInt32 eventManagerIndex, OpcUa_UInt32 hEventItem)
UaStatus finishEventTransaction (OpcUa_Handle hEventManagerContext)
UaNodeId typeDefinitionId () const
OpcUa_Byte eventNotifier () const
UaNode * getUaNode () const
UaStatus addNamespace (const UaString &sNameSpace, OpcUa_UInt16 &assignedNamespaceIndex)
UaStatus getNamespaces (UaStringArray &sNamespaces)
void startServerShutDown (OpcUa_Int32 secondsTillShutdown, const UaLocalizedText &shutdownReason)
void changeServerState (OpcUa_ServerState newState)
void fireEvent (UaEventData *pEventData)

Detailed Description

Derived from UaObjectBase and EventManager. It is not possible to create plane copies of this Class.

UaObjectServer

Constructor & Destructor Documentation

UaObjectServer::UaObjectServer ( const UaString &  name,
const UaNodeId &  nodeId,
const UaString &  defaultLocaleId 
)

construction

UaObjectServer::~UaObjectServer (  )  [virtual]

destruction

Member Function Documentation

UaStatus UaObjectServer::startUp ( UaReferenceLists *  pTypeSourceNode,
ServerConfig *  pServerConfig,
NodeManagerConfig *  pNodeManagerConfig 
)

Start up UaObjectServer.

Parameters:
pTypeSourceNode the type of the SourceNode in the ReferenceList.
pServerConfig Server configuration object.
pNodeManagerConfig NodeManager configuration object.
Returns:
Error code

* Root | Objects | Server | NamespaceArray */

UaStatus UaObjectServer::shutDown (  ) 

Shut down UaObjectServer.

Returns:
Error code

UaStatus UaObjectServer::beginEventTransaction ( EventManagerCallback *  pCallback,
const ServiceContext &  serviceContext,
OpcUa_UInt32  hTransaction,
OpcUa_Handle &  hEventManagerContext 
) [virtual]

Start a transaction.

Parameters:
pCallback Callback interface used for the transaction. The IOManager must use this interface to finish the action for each passed node in the transaction.
serviceContext General context for the service calls containing information like the session object, return diagnostic mask and timeout hint.
hTransaction Handle for the transaction used by the SDK to identify the transaction in the callbacks.
hEventManagerContext a Variable with all information about the current context.
Returns:
Error code

Implements EventManager.

UaStatus UaObjectServer::beginStartMonitoring ( OpcUa_Handle  hEventManagerContext,
OpcUa_UInt32  callbackHandle,
OpcUa_UInt32  eventManagerIndex,
EventCallback *  pEventCallback,
OpcUa_EventFilter *  pEventFilter,
OpcUa_Double  samplingInterval 
) [virtual]

Start monitoring of an event notifier.

Parameters:
hEventManagerContext a Variable with all information about the current context.
callbackHandle Handle for the node in the callback. This handle was passed in to the IOManager with the beginModifyMonitoring method.
eventManagerIndex an Index of different EventManagers.
pEventCallback the callback Event of the actual used monitored Item.
pEventFilter a filter for all Events that can occur.
samplingInterval a Variable with information about the samplingInterval.
Returns:
Error code

Implements EventManager.

UaStatus UaObjectServer::beginModifyMonitoring ( OpcUa_Handle  hEventManagerContext,
OpcUa_UInt32  callbackHandle,
OpcUa_UInt32  eventManagerIndex,
OpcUa_UInt32  hEventItem,
OpcUa_Int32  samplingInterval 
) [virtual]

Notify EventManager about modifying monitoring parameters of an event notifier.

Parameters:
hEventManagerContext a Variable with all information about the current context.
callbackHandle Handle for the node in the callback. This handle was passed in to the IOManager with the beginModifyMonitoring method.
eventManagerIndex an Index of different EventManagers.
hEventItem an EventItem used to fire an Event.
samplingInterval a Variable with information about the samplingInterval.
Returns:
Error code

Implements EventManager.

UaStatus UaObjectServer::beginStopMonitoring ( OpcUa_Handle  hEventManagerContext,
OpcUa_UInt32  callbackHandle,
OpcUa_UInt32  eventManagerIndex,
OpcUa_UInt32  hEventItem 
) [virtual]

Notify IOManager after stopping monitoring of an item..

Parameters:
hEventManagerContext a Variable with all information about the current context.
callbackHandle Handle for the node in the callback. This handle was passed in to the IOManager with the beginModifyMonitoring method.
eventManagerIndex an Index of different EventManagers.
hEventItem an EventItem used to fire an Event.
Returns:
Error code

Implements EventManager.

UaStatus UaObjectServer::finishEventTransaction ( OpcUa_Handle  hEventManagerContext  )  [virtual]

Finish a transaction.

Parameters:
hEventManagerContext a Variable with all information about the current context.
Returns:
Error code

Implements EventManager.

UaNodeId UaObjectServer::typeDefinitionId (  )  const [virtual]

Get the object type NodeId for the server object.

Returns:
the object type NodeId for the server object.

Implements UaNode.

OpcUa_Byte UaObjectServer::eventNotifier (  )  const [virtual]

Notifiys which Event was fired.

Returns:
the EventNotifier for the UaTransitionType.

Implements UaObject.

UaNode* UaObjectServer::getUaNode (  )  const [inline, virtual]

Get the Node.

Returns:
the current searched Node.

Reimplemented from UaObjectBase.

UaStatus UaObjectServer::addNamespace ( const UaString &  sNameSpace,
OpcUa_UInt16 &  assignedNamespaceIndex 
)

Add a namespace to the end of the list.

Parameters:
sNameSpace the Namespace of the current Node.
assignedNamespaceIndex Assigned namespace index of the added NodeManager.
Returns:
Error code

UaStatus UaObjectServer::getNamespaces ( UaStringArray &  sNamespaces  ) 

Get list of namespaces.

Parameters:
sNamespaces the namespace to search for.
Returns:
Error code

void UaObjectServer::startServerShutDown ( OpcUa_Int32  secondsTillShutdown,
const UaLocalizedText &  shutdownReason 
)

Inform the server object about the shutdown of the server.

Parameters:
secondsTillShutdown Seconds till shutdown of the server.
shutdownReason Reason for the shutdown.

void UaObjectServer::changeServerState ( OpcUa_ServerState  newState  ) 

Update the server manager about the change of the server state.

Parameters:
newState New server status.

void UaObjectServer::fireEvent ( UaEventData *  pEventData  ) 

Fire an event.

Parameters:
pEventData a Variable with the Event to be fired.

The documentation for this class was generated from the following files:
  • src/uaserver/uaservercpp/coremodule/uaobjectsserver.h
  • src/uaserver/uaservercpp/coremodule/uaobjectsserver.cpp