High Performance OPC UA Server SDK  1.1.1.177
ua_monitoreditem Struct Reference

Structure to represent a monitoreditem in the server. More...

#include <monitoreditem.h>

Public Member Functions

int ua_monitoreditem_new_value (struct ua_monitoreditem *item, struct ua_datavalue *value)
 Add a new value to a monitoreditem. More...
 
struct uasession_sessionua_monitoreditem_get_session (struct ua_monitoreditem *item)
 Get the session belonging to a monitoreditem. More...
 

Data Fields

struct ua_nodeid nodeid
 nodeid of the item to monitor
 
uint32_t sampling_interval
 sampling interval can be adjusted by provider in add_item or modify_item
 
uint32_t user_data [2]
 user data can be used by provider
 
uint32_t attributeid
 attributeid to monitor
 
struct ua_indexrangerange
 array of requested indexranges for this item
 
unsigned int num_ranges
 number of entries in the range array
 
uint32_t timeout_hint
 timeout in ms an add/modify/remove may take, 0 indicates no timeout
 
enum ua_timestampstoreturn ts
 timestamps to return for the monitoreditem
 
ua_statuscode operation_result
 async result of the add/modify/remove operation
 
uint32_t id
 server assigned id of the monitored item
 
bool discard_oldest
 
bool initial_value
 
uint32_t client_handle
 
enum ua_monitoringmode monitoring_mode
 
enum ua_datachangetrigger datachangetrigger
 
struct ua_datavalue last_value
 
struct ua_subscriptionsubscription
 
struct util_ringqueue value_queue
 

Detailed Description

Structure to represent a monitoreditem in the server.

Member Function Documentation

struct uasession_session * ua_monitoreditem_get_session ( struct ua_monitoreditem item)

Get the session belonging to a monitoreditem.

Parameters
item
Returns
int ua_monitoreditem_new_value ( struct ua_monitoreditem item,
struct ua_datavalue value 
)

Add a new value to a monitoreditem.

Add a newly sampled value to the monitoreditem, the functions checks if the value changed and enqueues it if necessary.

In case of success the function takes ownership of the value and finally clears it and calls ipc_free on the pointer. In case of failure the caller is responsible for cleaning the value up.

Parameters
itemMonitoreditem to add a new value to.
valueThe new value.
Returns
Zero on success or errorcode on failure.

The documentation for this struct was generated from the following files: