High Performance OPC UA Server SDK  1.2.0.193
ua_notificationmessage Struct Reference

Data Fields

uint32_t sequence_number
 The Message that contains one or more Notifications.
 
ua_datetime publish_time
 The sequence number of the NotificationMessage.
 
struct ua_extensionobjectnotification_data
 The list of NotificationData structures. More...
 
int32_t num_notification_data
 Number of elements in ua_notificationmessage::notification_data.
 

Related Functions

void ua_notificationmessage_init (struct ua_notificationmessage *t)
 Initialize an ua_notificationmessage struct with a valid value. More...
 
void ua_notificationmessage_clear (struct ua_notificationmessage *t)
 Clear all resources alloctated in an ua_notificationmessage struct. More...
 
int ua_notificationmessage_compare (const struct ua_notificationmessage *a, const struct ua_notificationmessage *b)
 Compare two ua_notificationmessage structs. More...
 
int ua_notificationmessage_copy (struct ua_notificationmessage *dst, const struct ua_notificationmessage *src)
 Create a copy of a ua_notificationmessage struct. More...
 
static int ua_notificationmessage_resize_notification_data_array (struct ua_notificationmessage *val, int32_t new_len)
 Resize the notification_data array of a ua_notificationmessage struct. More...
 

Friends And Related Function Documentation

void ua_notificationmessage_clear ( struct ua_notificationmessage t)
related

Clear all resources alloctated in an ua_notificationmessage struct.

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

int ua_notificationmessage_compare ( const struct ua_notificationmessage a,
const struct ua_notificationmessage b 
)
related

Compare two ua_notificationmessage structs.

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

int ua_notificationmessage_copy ( struct ua_notificationmessage dst,
const struct ua_notificationmessage src 
)
related

Create a copy of a ua_notificationmessage struct.

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

Initialize an ua_notificationmessage 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_notificationmessage struct can also be passed to ua_notificationmessage_compare, ua_notificationmessage_copy and ua_notificationmessage_clear. This function will always succeed as long as an ua_notificationmessage struct is passed to it.

static int ua_notificationmessage_resize_notification_data_array ( struct ua_notificationmessage val,
int32_t  new_len 
)
related

Resize the notification_data array of a ua_notificationmessage 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 notification_data array in number of members.
Returns
Zero on success or ua_statuscode on failure.

Field Documentation

notification_data

The list of NotificationData structures.

The NotificationData parameter type is an extensible parameter type. It specifies the types of Notifications that can be sent.

Notifications of the same type should be grouped into one NotificationData element. If a Subscription contains MonitoredItems for events and data, this array should have not more than 2 elements. If the Subscription contains MonitoredItems only for data or only for events, the array size should always be one for this Subscription.


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