UaSubscriptionManager Class Reference

Implements the UA subscription manager. Derived from UaThread. It is not possible to create plane copies of this class. It is not possible to use the default constructor. More...

#include <uasubscriptionmanager.h>

Inheritance diagram for UaSubscriptionManager:

Inheritance graph
[legend]
Collaboration diagram for UaSubscriptionManager:

Collaboration graph
[legend]

List of all members.


Public Member Functions

 UaSubscriptionManager (ServerManager *pServerManager)
 ~UaSubscriptionManager ()
UaStatus startUp ()
UaStatus shutDown ()
UaStatus createSubscription (Session *pSession, OpcUa_Double &publishingInterval, OpcUa_UInt32 &lifetimeCount, OpcUa_UInt32 &maxKeepAliveCount, OpcUa_UInt32 maxNotificationPerPublish, OpcUa_Boolean publishingEnabled, OpcUa_Byte priority, OpcUa_UInt32 &subscriptionId)
UaStatus modifySubscription (OpcUa_UInt32 subscriptionId, OpcUa_Double &publishingInterval, OpcUa_UInt32 &lifetimeCount, OpcUa_UInt32 &maxKeepAliveCount, OpcUa_UInt32 maxNotificationPerPublish, OpcUa_Byte priority)
UaStatus setPublishingMode (OpcUa_UInt32 subscriptionId, OpcUa_Boolean publishingMode)
UaStatus deleteSubscription (OpcUa_UInt32 subscriptionId)
UaStatus beginPublish (UaPublishContext *pUaPublishContext)
UaStatus beginCreateMonitoredItems (UaCreateMonitoredItemsContext *pUaCreateMonitoredItemsContext)
UaStatus beginModifyMonitoredItems (UaModifyMonitoredItemsContext *pUaModifyMonitoredItemsContext)
UaStatus beginSetMonitoringMode (UaSetMonitoringModeContext *pUaSetMonitoringModeContext)
UaStatus beginDeleteMonitoredItems (UaDeleteMonitoredItemsContext *pUaDeleteMonitoredItemsContext)
void run ()

Detailed Description

Implements the UA subscription manager. Derived from UaThread. It is not possible to create plane copies of this class. It is not possible to use the default constructor.

UaSubscriptionManager

Constructor & Destructor Documentation

UaSubscriptionManager::UaSubscriptionManager ( ServerManager *  pServerManager  ) 

construction

Parameters:
pServerManager Interface to the central ServerManager object. This interface pointer should be stored in the NodeManager instance to have access to core module objects like the root NodeManager or the ServerConfig

UaSubscriptionManager::~UaSubscriptionManager (  ) 

destruction

Member Function Documentation

UaStatus UaSubscriptionManager::startUp (  ) 

Start up subscription manager.

Returns:
Error code

UaStatus UaSubscriptionManager::shutDown (  ) 

Start up subscription manager.

Returns:
Error code

UaStatus UaSubscriptionManager::createSubscription ( Session *  pSession,
OpcUa_Double &  publishingInterval,
OpcUa_UInt32 &  lifetimeCount,
OpcUa_UInt32 &  maxKeepAliveCount,
OpcUa_UInt32  maxNotificationPerPublish,
OpcUa_Boolean  publishingEnabled,
OpcUa_Byte  priority,
OpcUa_UInt32 &  subscriptionId 
)

Create a new Subscription.

Parameters:
pSession Interface to the Session context for the method call
publishingInterval publishing interval in milliseconds the server allows
lifetimeCount a count for the the actual lifetime.
maxKeepAliveCount the maximum of Time to keep the Session alive.
maxNotificationPerPublish the maximum of notification per Publish.
publishingEnabled indicates if publishing is enabled or not.
priority the priority of the operation.
subscriptionId the Id of the Subscription.
Returns:
Error code

UaStatus UaSubscriptionManager::modifySubscription ( OpcUa_UInt32  subscriptionId,
OpcUa_Double &  publishingInterval,
OpcUa_UInt32 &  lifetimeCount,
OpcUa_UInt32 &  maxKeepAliveCount,
OpcUa_UInt32  maxNotificationPerPublish,
OpcUa_Byte  priority 
)

Modify an existing Subscription.

Parameters:
subscriptionId the Id of the Subscription.
publishingInterval publishing interval in milliseconds the server allows
lifetimeCount a count for the the actual lifetime.
maxKeepAliveCount the maximum of Time to keep the Session alive.
maxNotificationPerPublish the maximum of notification per Publish.
priority the priority of the operation.
Returns:
Error code

UaStatus UaSubscriptionManager::setPublishingMode ( OpcUa_UInt32  subscriptionId,
OpcUa_Boolean  publishingMode 
)

Set PublishingMode of a Subscription.

Parameters:
subscriptionId the Id of the Subscription.
publishingMode true if publishing mode false if not.
Returns:
Error code

UaStatus UaSubscriptionManager::deleteSubscription ( OpcUa_UInt32  subscriptionId  ) 

Delete a Subscription.

Parameters:
subscriptionId the Id of the Subscription.
Returns:
Error code

UaStatus UaSubscriptionManager::beginPublish ( UaPublishContext *  pUaPublishContext  ) 

Begin a Publish transaction.

Parameters:
pUaPublishContext the context of the needed publish transaction.
Returns:
Error code

UaStatus UaSubscriptionManager::beginCreateMonitoredItems ( UaCreateMonitoredItemsContext *  pUaCreateMonitoredItemsContext  ) 

Create new monitored items.

Parameters:
pUaCreateMonitoredItemsContext the context of the items to create.
Returns:
Error code

UaStatus UaSubscriptionManager::beginModifyMonitoredItems ( UaModifyMonitoredItemsContext *  pUaModifyMonitoredItemsContext  ) 

Modify monitored items.

Parameters:
pUaModifyMonitoredItemsContext the context for the monitored items to modify.
Returns:
Error code

UaStatus UaSubscriptionManager::beginSetMonitoringMode ( UaSetMonitoringModeContext *  pUaSetMonitoringModeContext  ) 

Set monitoring mode of monitored items.

Parameters:
pUaSetMonitoringModeContext the context to be set.
Returns:
Error code

UaStatus UaSubscriptionManager::beginDeleteMonitoredItems ( UaDeleteMonitoredItemsContext *  pUaDeleteMonitoredItemsContext  ) 

Delete monitored items.

Parameters:
pUaDeleteMonitoredItemsContext the context to delete.
Returns:
Error code

void UaSubscriptionManager::run (  )  [virtual]

Main thread method.

Implements UaThread.

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