ANSI C Based OPC UA Client/Server SDK  1.8.3.398
UaServerMonitoring

Data Structures

struct  UaServer_MonitoredItem
 A Monitored Item structure (Common) More...
 
struct  UaServer_MonitoredItemData
 A Monitored Item structure (Data) More...
 
struct  UaServer_MonitoredItemEvent
 A Monitored Item structure (Event) More...
 

Enumerations

enum  MonitoredItemType
 An enumeration of MonitoredItem types. More...
 

Functions

OpcUa_StatusCode UaServer_SubscribeComplete (UaServer_ProviderSubscribeContext *a_pCtx)
 Called by the provider to signal that he finished handling all AddItem and RemoveItem calls. More...
 
OpcUa_StatusCode UaServer_DataLoggerItemData_Create (OpcUa_NodeId *a_pNodeId, OpcUa_Int32 a_iSamplingInterval, OpcUa_MonitoringMode a_monitoringMode, OpcUa_UInt32 a_uItemQueueSize, OpcUa_DataChangeFilter *a_pFilter, OpcUa_Int a_DataLogger, OpcUa_Int *a_pDataLogItem)
 Create a data logger item, monitoring and logging the value of the passed node. More...
 
OpcUa_StatusCode UaServer_DataLoggerItemData_Modify (OpcUa_Int a_DataLogger, OpcUa_Int a_DataLogItem, OpcUa_Int32 a_iSamplingInterval, OpcUa_MonitoringMode a_monitoringMode, OpcUa_UInt32 a_uItemQueueSize, OpcUa_DataChangeFilter *a_pFilter)
 Modify an existing data logger item. More...
 
OpcUa_StatusCode UaServer_DataLoggerItemData_Remove (OpcUa_Int a_DataLogger, OpcUa_Int a_DataLogItem)
 Remove an existing data logger item. More...
 

Detailed Description

Enumeration Type Documentation

An enumeration of MonitoredItem types.

Depending on the type, a UaServer_MonitoredItem can be cast to UaServer_MonitoredItemData or UaServer_MonitoredItemEvent.

Function Documentation

OpcUa_StatusCode UaServer_DataLoggerItemData_Create ( OpcUa_NodeId a_pNodeId,
OpcUa_Int32  a_iSamplingInterval,
OpcUa_MonitoringMode  a_monitoringMode,
OpcUa_UInt32  a_uItemQueueSize,
OpcUa_DataChangeFilter *  a_pFilter,
OpcUa_Int  a_DataLogger,
OpcUa_Int *  a_pDataLogItem 
)

Create a data logger item, monitoring and logging the value of the passed node.

Parameters
[in]a_pNodeIdThe NodeId of the variable to monitor.
[in]a_iSamplingIntervalThe sampling interval for monitoring the variable.
[in]a_monitoringModeThe monitoring mode to use, allowing to create a disabled data logger item.
[in]a_uItemQueueSizeThe queue size to be used for logging.
[in]a_pFilterOptional data change filter to apply when monitoring the variable.
[in]a_DataLoggerHandle of the data logger to log the data to.
[out]a_pDataLogItemThe handle of the created data logger item is stored here.
Returns
OpcUa_Good on success.
OpcUa_StatusCode UaServer_DataLoggerItemData_Modify ( OpcUa_Int  a_DataLogger,
OpcUa_Int  a_DataLogItem,
OpcUa_Int32  a_iSamplingInterval,
OpcUa_MonitoringMode  a_monitoringMode,
OpcUa_UInt32  a_uItemQueueSize,
OpcUa_DataChangeFilter *  a_pFilter 
)

Modify an existing data logger item.

Parameters
[in]a_DataLoggerHandle of the data logger the item belongs to.
[in]a_DataLogItemThe handle of the data logger item.
[in]a_iSamplingIntervalThe sampling interval for monitoring the variable.
[in]a_monitoringModeThe monitoring mode to use, allowing to enable or disable the data logger item.
[in]a_uItemQueueSizeThe queue size to be used for logging.
[in]a_pFilterOptional data change filter to apply when monitoring the variable.
Returns
OpcUa_Good on success.
OpcUa_StatusCode UaServer_DataLoggerItemData_Remove ( OpcUa_Int  a_DataLogger,
OpcUa_Int  a_DataLogItem 
)

Remove an existing data logger item.

Parameters
[in]a_DataLoggerHandle of the data logger the item belongs to.
[in]a_DataLogItemThe handle of the data logger item.
Returns
OpcUa_Good on success.
OpcUa_StatusCode UaServer_SubscribeComplete ( UaServer_ProviderSubscribeContext a_pCtx)

Called by the provider to signal that he finished handling all AddItem and RemoveItem calls.

Note
This function is thread-safe.
Parameters
a_pCtxThe processed SubscribeContext.
Returns
Always returns OpcUa_Good.