High Performance OPC UA Server SDK  1.2.0.193
ua_monitoreditemmodifyrequest Struct Reference

A structure that is defined as the type of the itemsToModify parameter of the ModifyMonitoredItems service. More...

#include <monitoreditemmodifyrequest.h>

Data Fields

uint32_t monitored_item_id
 Server-assigned ID for the MonitoredItem.
 
struct ua_monitoringparameters requested_parameters
 The requested values for the monitoring parameters. More...
 

Related Functions

void ua_monitoreditemmodifyrequest_init (struct ua_monitoreditemmodifyrequest *t)
 Initialize an ua_monitoreditemmodifyrequest struct with a valid value. More...
 
void ua_monitoreditemmodifyrequest_clear (struct ua_monitoreditemmodifyrequest *t)
 Clear all resources alloctated in an ua_monitoreditemmodifyrequest struct. More...
 
int ua_monitoreditemmodifyrequest_compare (const struct ua_monitoreditemmodifyrequest *a, const struct ua_monitoreditemmodifyrequest *b)
 Compare two ua_monitoreditemmodifyrequest structs. More...
 
int ua_monitoreditemmodifyrequest_copy (struct ua_monitoreditemmodifyrequest *dst, const struct ua_monitoreditemmodifyrequest *src)
 Create a copy of a ua_monitoreditemmodifyrequest struct. More...
 

Detailed Description

A structure that is defined as the type of the itemsToModify parameter of the ModifyMonitoredItems service.

Friends And Related Function Documentation

void ua_monitoreditemmodifyrequest_clear ( struct ua_monitoreditemmodifyrequest t)
related

Clear all resources alloctated in an ua_monitoreditemmodifyrequest struct.

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

int ua_monitoreditemmodifyrequest_compare ( const struct ua_monitoreditemmodifyrequest a,
const struct ua_monitoreditemmodifyrequest b 
)
related

Compare two ua_monitoreditemmodifyrequest structs.

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

int ua_monitoreditemmodifyrequest_copy ( struct ua_monitoreditemmodifyrequest dst,
const struct ua_monitoreditemmodifyrequest src 
)
related

Create a copy of a ua_monitoreditemmodifyrequest struct.

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

Initialize an ua_monitoreditemmodifyrequest 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_monitoreditemmodifyrequest struct can also be passed to ua_monitoreditemmodifyrequest_compare, ua_monitoreditemmodifyrequest_copy and ua_monitoreditemmodifyrequest_clear. This function will always succeed as long as an ua_monitoreditemmodifyrequest struct is passed to it.

Field Documentation

requested_parameters

The requested values for the monitoring parameters.

If the number of notifications in the queue exceeds the new queue size, the notifications exceeding the size shall be discarded following the configured discard policy.


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