High Performance OPC UA Server SDK  1.2.0.193
ua_setmonitoringmoderequest Struct Reference

Asynchronous call to set the monitoring mode for a list of monitored items. More...

#include <setmonitoringmoderequest.h>

Data Fields

uint32_t subscription_id
 The Server-assigned identifier for the Subscription used to qualify the monitoredItemIds.
 
enum ua_monitoringmode monitoring_mode
 The monitoring mode to be set for the MonitoredItems.
 
uint32_t * monitored_item_ids
 List of Server-assigned IDs for the MonitoredItems.
 
int32_t num_monitored_item_ids
 Number of elements in ua_setmonitoringmoderequest::monitored_item_ids.
 

Related Functions

void ua_setmonitoringmoderequest_init (struct ua_setmonitoringmoderequest *t)
 Initialize an ua_setmonitoringmoderequest struct with a valid value. More...
 
void ua_setmonitoringmoderequest_clear (struct ua_setmonitoringmoderequest *t)
 Clear all resources alloctated in an ua_setmonitoringmoderequest struct. More...
 
int ua_setmonitoringmoderequest_compare (const struct ua_setmonitoringmoderequest *a, const struct ua_setmonitoringmoderequest *b)
 Compare two ua_setmonitoringmoderequest structs. More...
 
int ua_setmonitoringmoderequest_copy (struct ua_setmonitoringmoderequest *dst, const struct ua_setmonitoringmoderequest *src)
 Create a copy of a ua_setmonitoringmoderequest struct. More...
 
static int ua_setmonitoringmoderequest_resize_monitored_item_ids_array (struct ua_setmonitoringmoderequest *val, int32_t new_len)
 Resize the monitored_item_ids array of a ua_setmonitoringmoderequest struct. More...
 

Detailed Description

Asynchronous call to set the monitoring mode for a list of monitored items.

This Service is used to set the monitoring mode for one or more MonitoredItems of a Subscription. Setting the mode to DISABLED causes all queued notifications to be deleted.

Friends And Related Function Documentation

void ua_setmonitoringmoderequest_clear ( struct ua_setmonitoringmoderequest t)
related

Clear all resources alloctated in an ua_setmonitoringmoderequest struct.

Frees allocated memory like arrays and resets numeric values. The ua_setmonitoringmoderequest struct itself is not freed and must be freed by the caller if required. This function always succeeds for a valid ua_setmonitoringmoderequest struct, that was validly decoded or initilized by ua_setmonitoringmoderequest_init.

int ua_setmonitoringmoderequest_compare ( const struct ua_setmonitoringmoderequest a,
const struct ua_setmonitoringmoderequest b 
)
related

Compare two ua_setmonitoringmoderequest structs.

Compares the content of the ua_setmonitoringmoderequest struct a to the content of the ua_setmonitoringmoderequest struct b. If a is smaller than b, an integer less than zero is returned, if a is bigger than b, an integer greater than zero is returned. If both structs are equal zero is returned.

This function creates a total order on ua_setmonitoringmoderequest structs, so it is well suited to not only determine equality, but also sort multiple instances of this struct.

int ua_setmonitoringmoderequest_copy ( struct ua_setmonitoringmoderequest dst,
const struct ua_setmonitoringmoderequest src 
)
related

Create a copy of a ua_setmonitoringmoderequest struct.

Copy all fields from struct ua_setmonitoringmoderequest src to dst. Creates a deep copy so all content is recusively copied and both src and dst can be used and must be freed separately.

dst is not cleared before the copy operation, so it must not have any allocated data. It may or may not be initilized by the caller before copy.

Returns
Zero on success or ua_statuscode on failure.
void ua_setmonitoringmoderequest_init ( struct ua_setmonitoringmoderequest t)
related

Initialize an ua_setmonitoringmoderequest struct with a valid value.

After initialization the fields of the struct are set to valid and consistent values and can safley be accessed. An initialized ua_setmonitoringmoderequest struct can also be passed to ua_setmonitoringmoderequest_clear. This function will always succeed as long as an ua_setmonitoringmoderequest struct is passed to it.

static int ua_setmonitoringmoderequest_resize_monitored_item_ids_array ( struct ua_setmonitoringmoderequest val,
int32_t  new_len 
)
related

Resize the monitored_item_ids array of a ua_setmonitoringmoderequest struct.

Depending on new_len and the current size of the array, the array will be created, increased, decreased or deleted. In case array members are removed these are cleared properly, new array members are initialized with zero.

Parameters
new_lenNew length of the monitored_item_ids array in number of members.
Returns
Zero on success or ua_statuscode on failure.

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