.NET Based OPC UA Client/Server SDK  3.3.3.537
UnifiedAutomation.UaServer.IEventManager Interface Reference

An interface to an object that manages access to events produced by a node. More...

Inherited by UnifiedAutomation.UaServer.IEventManagerEx.

Public Member Functions

StatusCode BeginEventTransaction (RequestContext context, uint totalItemCountHint, TransactionType transactionType, Delegate callback, object callbackData, out TransactionHandle handle)
 Begins the transaction. More...
 
void FinishEventTransaction (TransactionHandle transaction)
 Finishes the transaction. More...
 
StatusCode BeginStartEventMonitoring (NotifierOperationHandle operationHandle, MonitoredItemCreateRequest settings, uint monitoredItemId, EventNotificationEventHandler callback)
 Starts monitoring a notifier for events. More...
 
StatusCode BeginModifyEventMonitoring (MonitoredItemOperationHandle operationHandle, MonitoredItemModifyRequest settings)
 Modifies the monitoring for an item. More...
 
StatusCode BeginStopEventMonitoring (MonitoredItemOperationHandle operationHandle)
 Stops monitoring an item. More...
 
StatusCode BeginSetEventMonitoringMode (MonitoredItemOperationHandle operationHandle, MonitoringMode monitoringMode, MonitoringParameters parameters)
 Changes the monitoring mode for an item. More...
 
void EventMonitoringStarted (RequestContext context, NodeId notifierId, MonitoredItemHandle itemHandle, MonitoringParameters parameters, EventNotificationEventHandler callback)
 Called when monitoring starts for a notifier from another IEventManager higher in the hierarchy. More...
 
void EventMonitoringModified (RequestContext context, NodeId notifierId, MonitoredItemHandle itemHandle, MonitoringParameters parameters)
 Called when monitoring changes for a notifier from another IEventManager higher in the hierarchy. More...
 
void EventMonitoringStopped (RequestContext context, NodeId notifierId, MonitoredItemHandle itemHandle)
 Called when monitoring stops for a notifier from another IEventManager higher in the hierarchy. More...
 
void ConditionRefresh (RequestContext context, NodeId notifierId, MonitoredItemHandle itemHandle, EventNotificationEventHandler callback)
 Called when the condition refresh is called for a notifier higher in the hierarchy. More...
 

Detailed Description

An interface to an object that manages access to events produced by a node.

Member Function Documentation

StatusCode UnifiedAutomation.UaServer.IEventManager.BeginEventTransaction ( RequestContext  context,
uint  totalItemCountHint,
TransactionType  transactionType,
Delegate  callback,
object  callbackData,
out TransactionHandle  handle 
)

Begins the transaction.

Parameters
contextThe request context.
totalItemCountHintThe total item count hint.
transactionTypeType of the transaction.
callbackThe callback to raise when an operation completes.
callbackDataThe callback data.
handleThe transaction handle.
Returns
Good if the transaction could be created, an error code otherwise.

Implemented in UnifiedAutomation.UaServer.RootNodeManager, and UnifiedAutomation.UaServer.BaseNodeManager.

StatusCode UnifiedAutomation.UaServer.IEventManager.BeginModifyEventMonitoring ( MonitoredItemOperationHandle  operationHandle,
MonitoredItemModifyRequest  settings 
)

Modifies the monitoring for an item.

Parameters
operationHandleThe operation handle.
settingsThe settings.
Returns
Good if the monitored item can be modified, an error code otherwise.

If this method returns Good the callback passed to BeginTransaction must be called when the operation completes.

Implemented in UnifiedAutomation.UaServer.RootNodeManager, and UnifiedAutomation.UaServer.BaseNodeManager.

StatusCode UnifiedAutomation.UaServer.IEventManager.BeginSetEventMonitoringMode ( MonitoredItemOperationHandle  operationHandle,
MonitoringMode  monitoringMode,
MonitoringParameters  parameters 
)

Changes the monitoring mode for an item.

Parameters
operationHandleThe operation handle.
monitoringModeThe monitoring mode.
parametersThe parameters.
Returns
Good if the monitored item can be modified, an error code otherwise.

If this method returns Good the callback passed to BeginTransaction must be called when the operation completes.

Implemented in UnifiedAutomation.UaServer.RootNodeManager, and UnifiedAutomation.UaServer.BaseNodeManager.

StatusCode UnifiedAutomation.UaServer.IEventManager.BeginStartEventMonitoring ( NotifierOperationHandle  operationHandle,
MonitoredItemCreateRequest  settings,
uint  monitoredItemId,
EventNotificationEventHandler  callback 
)

Starts monitoring a notifier for events.

Parameters
operationHandleThe operation handle.
settingsThe settings.
monitoredItemIdThe monitored item id.
callbackThe callback to use when events occur.
Returns
Good if the monitored item can be created, an error code otherwise.

If this method returns Good the callback passed to BeginTransaction must be called when the operation completes.

Implemented in UnifiedAutomation.UaServer.RootNodeManager, and UnifiedAutomation.UaServer.BaseNodeManager.

StatusCode UnifiedAutomation.UaServer.IEventManager.BeginStopEventMonitoring ( MonitoredItemOperationHandle  operationHandle)

Stops monitoring an item.

Parameters
operationHandleThe operation handle.
Returns
Good if the monitored item can be modified, an error code otherwise.

If this method returns Good the callback passed to BeginTransaction must be called when the operation completes.

Implemented in UnifiedAutomation.UaServer.RootNodeManager, and UnifiedAutomation.UaServer.BaseNodeManager.

void UnifiedAutomation.UaServer.IEventManager.ConditionRefresh ( RequestContext  context,
NodeId  notifierId,
MonitoredItemHandle  itemHandle,
EventNotificationEventHandler  callback 
)

Called when the condition refresh is called for a notifier higher in the hierarchy.

Parameters
contextThe context.
notifierIdThe id for the notifier.
itemHandleThe item handle.
callbackThe callback to call with the current state of all conditions.

Implemented in UnifiedAutomation.UaServer.RootNodeManager, and UnifiedAutomation.UaServer.BaseNodeManager.

void UnifiedAutomation.UaServer.IEventManager.EventMonitoringModified ( RequestContext  context,
NodeId  notifierId,
MonitoredItemHandle  itemHandle,
MonitoringParameters  parameters 
)

Called when monitoring changes for a notifier from another IEventManager higher in the hierarchy.

Parameters
contextThe context.
notifierIdThe id for the notifier in the other IEventManager.
itemHandleThe item handle.
parametersThe parameters.

Implemented in UnifiedAutomation.UaServer.RootNodeManager, and UnifiedAutomation.UaServer.BaseNodeManager.

void UnifiedAutomation.UaServer.IEventManager.EventMonitoringStarted ( RequestContext  context,
NodeId  notifierId,
MonitoredItemHandle  itemHandle,
MonitoringParameters  parameters,
EventNotificationEventHandler  callback 
)

Called when monitoring starts for a notifier from another IEventManager higher in the hierarchy.

Parameters
contextThe context.
notifierIdThe id for the notifier in the other IEventManager.
itemHandleThe item handle.
parametersThe parameters.
callbackThe callback to use when events occur.

Implemented in UnifiedAutomation.UaServer.RootNodeManager, and UnifiedAutomation.UaServer.BaseNodeManager.

void UnifiedAutomation.UaServer.IEventManager.EventMonitoringStopped ( RequestContext  context,
NodeId  notifierId,
MonitoredItemHandle  itemHandle 
)

Called when monitoring stops for a notifier from another IEventManager higher in the hierarchy.

Parameters
contextThe context.
notifierIdThe id for the notifier in the other IEventManager.
itemHandleThe item handle.

Implemented in UnifiedAutomation.UaServer.RootNodeManager, and UnifiedAutomation.UaServer.BaseNodeManager.

void UnifiedAutomation.UaServer.IEventManager.FinishEventTransaction ( TransactionHandle  transaction)

Finishes the transaction.

Parameters
transactionThe transaction.

Implemented in UnifiedAutomation.UaServer.RootNodeManager, and UnifiedAutomation.UaServer.BaseNodeManager.


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