High Performance OPC UA Server SDK  1.2.0.193
ua_deletemonitoreditemsrequest Struct Reference

Asynchronous call to delete monitored items. More...

#include <deletemonitoreditemsrequest.h>

Data Fields

uint32_t subscription_id
 The Server-assigned identifier for the Subscription that contains the MonitoredItems to be deleted.
 
uint32_t * monitored_item_ids
 List of Server-assigned ids for the MonitoredItems to be deleted.
 
int32_t num_monitored_item_ids
 Number of elements in ua_deletemonitoreditemsrequest::monitored_item_ids.
 

Related Functions

void ua_deletemonitoreditemsrequest_init (struct ua_deletemonitoreditemsrequest *t)
 Initialize an ua_deletemonitoreditemsrequest struct with a valid value. More...
 
void ua_deletemonitoreditemsrequest_clear (struct ua_deletemonitoreditemsrequest *t)
 Clear all resources alloctated in an ua_deletemonitoreditemsrequest struct. More...
 
int ua_deletemonitoreditemsrequest_compare (const struct ua_deletemonitoreditemsrequest *a, const struct ua_deletemonitoreditemsrequest *b)
 Compare two ua_deletemonitoreditemsrequest structs. More...
 
int ua_deletemonitoreditemsrequest_copy (struct ua_deletemonitoreditemsrequest *dst, const struct ua_deletemonitoreditemsrequest *src)
 Create a copy of a ua_deletemonitoreditemsrequest struct. More...
 
static int ua_deletemonitoreditemsrequest_resize_monitored_item_ids_array (struct ua_deletemonitoreditemsrequest *val, int32_t new_len)
 Resize the monitored_item_ids array of a ua_deletemonitoreditemsrequest struct. More...
 

Detailed Description

Asynchronous call to delete monitored items.

This Service is used to remove one or more MonitoredItems of a Subscription. When a MonitoredItem is deleted, its triggered item links are also deleted.

Successful removal of a MonitoredItem, however, might not remove notifications for the MonitoredItem that are in the process of being sent by the Subscription. Therefore, Clients may receive notifications for the MonitoredItem after they have received a positive response that the MonitoredItem has been deleted.

Friends And Related Function Documentation

void ua_deletemonitoreditemsrequest_clear ( struct ua_deletemonitoreditemsrequest t)
related

Clear all resources alloctated in an ua_deletemonitoreditemsrequest struct.

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

int ua_deletemonitoreditemsrequest_compare ( const struct ua_deletemonitoreditemsrequest a,
const struct ua_deletemonitoreditemsrequest b 
)
related

Compare two ua_deletemonitoreditemsrequest structs.

Compares the content of the ua_deletemonitoreditemsrequest struct a to the content of the ua_deletemonitoreditemsrequest 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_deletemonitoreditemsrequest structs, so it is well suited to not only determine equality, but also sort multiple instances of this struct.

int ua_deletemonitoreditemsrequest_copy ( struct ua_deletemonitoreditemsrequest dst,
const struct ua_deletemonitoreditemsrequest src 
)
related

Create a copy of a ua_deletemonitoreditemsrequest struct.

Copy all fields from struct ua_deletemonitoreditemsrequest 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_deletemonitoreditemsrequest_init ( struct ua_deletemonitoreditemsrequest t)
related

Initialize an ua_deletemonitoreditemsrequest 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_deletemonitoreditemsrequest struct can also be passed to ua_deletemonitoreditemsrequest_clear. This function will always succeed as long as an ua_deletemonitoreditemsrequest struct is passed to it.

static int ua_deletemonitoreditemsrequest_resize_monitored_item_ids_array ( struct ua_deletemonitoreditemsrequest val,
int32_t  new_len 
)
related

Resize the monitored_item_ids array of a ua_deletemonitoreditemsrequest 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: