C++ Based OPC UA Client/Server/PubSub SDK  1.7.6.537
InternalDurableSubscriptionCallback Class Reference

Durable subscription spefic implementation of Subscription callback functions. More...

Inherits IOManagerCallback, and EventManagerCallback.

Public Member Functions

UaStatus finishStartMonitoring (OpcUa_UInt32, OpcUa_UInt32, OpcUa_UInt32, OpcUa_Double, OpcUa_Boolean, const UaDataValue &, const UaStatus &)
 Finished transaction to start monitoring a data item. More...
 
UaStatus finishRead (OpcUa_UInt32, OpcUa_UInt32, UaDataValue &, OpcUa_Boolean, OpcUa_Boolean, UaDiagnosticInfo *)
 Finished reading of an attribute value of a node. More...
 
UaStatus finishWrite (OpcUa_UInt32, OpcUa_UInt32, const UaStatus &, OpcUa_Boolean)
 Finished writing of an attribute value of a node. More...
 
UaStatus finishModifyMonitoring (OpcUa_UInt32, OpcUa_UInt32, OpcUa_Double, const UaStatus &)
 Finished modify monitoring of an attribute value of a node. More...
 
UaStatus finishStopMonitoring (OpcUa_UInt32, OpcUa_UInt32, const UaStatus &)
 Finished stopping monitoring of an data item. More...
 
UaStatus finishStartMonitoring (OpcUa_UInt32, OpcUa_UInt32, OpcUa_UInt32, OpcUa_UInt32, OpcUa_Double, const UaStatus &, OpcUa_EventFilterResult *)
 Finished transaction to start monitoring an event item. More...
 
UaStatus finishModifyMonitoring (OpcUa_UInt32, OpcUa_UInt32, OpcUa_UInt32, OpcUa_Double, const UaStatus &, OpcUa_EventFilterResult *)
 Finished transaction to modify monitoring an event item. More...
 
UaStatus finishStopMonitoring (OpcUa_UInt32, OpcUa_UInt32, OpcUa_UInt32, const UaStatus &)
 Finished stopping monitoring of an event item. More...
 
- Public Member Functions inherited from IOManagerCallback
 IOManagerCallback ()
 Construction.
 
virtual ~IOManagerCallback ()
 Destruction.
 
- Public Member Functions inherited from EventManagerCallback
 EventManagerCallback ()
 construction
 
virtual ~EventManagerCallback ()
 destruction
 

Detailed Description

Durable subscription spefic implementation of Subscription callback functions.

Member Function Documentation

UaStatus InternalDurableSubscriptionCallback::finishModifyMonitoring ( OpcUa_UInt32  hTransaction,
OpcUa_UInt32  callbackHandle,
OpcUa_Double  revisedSamplingInterval,
const UaStatus statusCode 
)
inlinevirtual

Finished modify monitoring of an attribute value of a node.

The method is called to finish the modifying of the sampling attributes for a monitored item. The modifying is started with the beginModifyMonitoring method of the interface IOManager.

Parameters
hTransactionHandle for the transaction used by the SDK to identify the transaction in the callbacks. This handle was passed in to the IOManager with the beginTransaction method.
callbackHandleHandle for the node in the callback. This handle was passed in to the IOManager with the beginModifyMonitoring method.
revisedSamplingIntervalThe corresponding revised sampling interval for the requested sampling interval in beginModifyMonitoring.
statusCodeResult of the ModifyMonitoring operation. Optional diagnostig information requested by the client in the parameter ServiceContext::returnDiagnostics of IOManager::beginTransaction can be provided through UaStatus::setDiagnosticInfo().
Returns
Error code

Implements IOManagerCallback.

UaStatus InternalDurableSubscriptionCallback::finishModifyMonitoring ( OpcUa_UInt32  hTransaction,
OpcUa_UInt32  callbackHandle,
OpcUa_UInt32  eventManagerIndex,
OpcUa_Double  revisedSamplingInterval,
const UaStatus statusCode,
OpcUa_EventFilterResult pEventFilterResult 
)
inlinevirtual

Finished transaction to modify monitoring an event item.

Parameters
hTransactionHandle for the transaction used by the SDK to identify the transaction in the callbacks. This handle was passed in to the IOManager with the beginTransaction method.
callbackHandleHandle for the node in the callback. This handle was passed in to the EventManager with the beginModifyMonitoring method.
eventManagerIndexan Index of different EventManagers.
revisedSamplingIntervalThe corresponding revised sampling interval for the requested sampling interval in beginModifyMonitoring.
statusCodeResult of the ModifyMonitoring operation.
pEventFilterResultDetailed result for the event filter. Can be NULL if no error occurred. The SDK detaches the result content.
Returns
Result code of the method call

Implements EventManagerCallback.

UaStatus InternalDurableSubscriptionCallback::finishRead ( OpcUa_UInt32  hTransaction,
OpcUa_UInt32  callbackHandle,
UaDataValue dataValue,
OpcUa_Boolean  detachValue,
OpcUa_Boolean  allowThreadUse,
UaDiagnosticInfo pDiagnosticInfo 
)
inlinevirtual

Finished reading of an attribute value of a node.

The method is called to finish a read call for an attribute value of a node. The read is started with the beginRead method of the interface IOManager.

Parameters
hTransactionHandle for the transaction used by the SDK to identify the transaction in the callbacks. This handle was passed in to the IOManager with the beginTransaction method.
callbackHandleHandle for the node in the callback. This handle was passed in to the IOManager with the beginRead method.
dataValueContains the value, timestamps and result code for the Read operation.
detachValueIndicates if the method can detach the value from the wrapper class.
allowThreadUseIndicates if the calling thread can be used by the SDK to send the response to the client. This can happen if this method is the called for the last node in the transaction.
True: The thread calling this method can be used to send the response and may block
False: The SDK is using a worker thread to send the response to the client.
pDiagnosticInfoOptional diagnostig information requested by the client in the parameter ServiceContext::returnDiagnostics of IOManager::beginTransaction
Returns
Error code

Implements IOManagerCallback.

UaStatus InternalDurableSubscriptionCallback::finishStartMonitoring ( OpcUa_UInt32  hTransaction,
OpcUa_UInt32  callbackHandle,
OpcUa_UInt32  hIOVariable,
OpcUa_Double  revisedSamplingInterval,
OpcUa_Boolean  initialDataValueAvailable,
const UaDataValue initialDataValue,
const UaStatus statusCode 
)
virtual

Finished transaction to start monitoring a data item.

Parameters
hTransactionHandle for the transaction used by the SDK to identify the transaction in the callbacks. This handle was passed in to the IOManager with the beginTransaction method.
callbackHandleHandle for the node in the callback. This handle was passed in to the IOManager with the beginStartMonitoring method.
hIOVariableThe handle of the variable in the IOManager created with beginStartMonitoring. The handle was passed to the SDK in the callback finishStartMonitoring.
revisedSamplingIntervalThe corresponding revised sampling interval for the requested sampling interval in beginStartMonitoring.
initialDataValueAvailablethe available initial data value.
initialDataValuethe actual data value.
statusCodeResult of the finishStartMonitoring operation.
Returns
Error code

Implements IOManagerCallback.

UaStatus InternalDurableSubscriptionCallback::finishStartMonitoring ( OpcUa_UInt32  hTransaction,
OpcUa_UInt32  callbackHandle,
OpcUa_UInt32  eventManagerIndex,
OpcUa_UInt32  hEventItem,
OpcUa_Double  revisedSamplingInterval,
const UaStatus statusCode,
OpcUa_EventFilterResult  
)
virtual

Finished transaction to start monitoring an event item.

Parameters
hTransactionHandle for the transaction used by the SDK to identify the transaction in the callbacks. This handle was passed in to the IOManager with the beginTransaction method.
callbackHandleHandle for the node in the callback. This handle was passed in to the IOManager with the beginModifyMonitoring method.
eventManagerIndexan Index of different EventManagers.
hEventIteman EventItem used to fire an Event.
revisedSamplingIntervalThe corresponding revised sampling interval for the requested sampling interval in beginStartMonitoring.
statusCodeResult of the finishStartMonitoring operation.
Returns
Error code

Implements EventManagerCallback.

UaStatus InternalDurableSubscriptionCallback::finishStopMonitoring ( OpcUa_UInt32  ,
OpcUa_UInt32  ,
const UaStatus  
)
virtual

Finished stopping monitoring of an data item.

Parameters
hTransactionHandle for the transaction used by the SDK to identify the transaction in the callbacks. This handle was passed in to the IOManager with the beginTransaction method.
callbackHandleHandle for the node in the callback. This handle was passed in to the IOManager with the beginModifyMonitoring method.
statusCodeResult of the finishStopMonitoring operation.
Returns
Error code

Implements IOManagerCallback.

UaStatus InternalDurableSubscriptionCallback::finishStopMonitoring ( OpcUa_UInt32  ,
OpcUa_UInt32  ,
OpcUa_UInt32  ,
const UaStatus  
)
virtual

Finished stopping monitoring of an event item.

Parameters
hTransactionHandle for the transaction used by the SDK to identify the transaction in the callbacks. This handle was passed in to the IOManager with the beginTransaction method.
callbackHandleHandle for the node in the callback. This handle was passed in to the IOManager with the beginModifyMonitoring method.
eventManagerIndexan Index of different EventManagers.
statusCodeResult of the finishStopMonitoring operation.
Returns
Error code

Implements EventManagerCallback.

UaStatus InternalDurableSubscriptionCallback::finishWrite ( OpcUa_UInt32  hTransaction,
OpcUa_UInt32  callbackHandle,
const UaStatus statusCode,
OpcUa_Boolean  allowThreadUse 
)
inlinevirtual

Finished writing of an attribute value of a node.

The method is called to finish a write call for an attribute value of a node. The write is started with the beginWrite method of the interface IOManager.

Parameters
hTransactionHandle for the transaction used by the SDK to identify the transaction in the callbacks. This handle was passed in to the IOManager with the beginTransaction method.
callbackHandleHandle for the node in the callback. This handle was passed in to the IOManager with the beginWrite method.
statusCodeResult of the Write operation. Optional diagnostig information requested by the client in the parameter ServiceContext::returnDiagnostics of IOManager::beginTransaction can be provided through UaStatus::setDiagnosticInfo().
allowThreadUseIndicates if the calling thread can be used by the SDK to send the response to the client. This can happen if this method is the called for the last node in the transaction.
True: The thread calling this method can be used to send the response and may block
False: The SDK is using a worker thread to send the response to the client.
Returns
Error code

Implements IOManagerCallback.


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