High Performance OPC UA Server SDK  1.2.0.193
ua_setpublishingmoderequest Struct Reference

Asynchronous call to enable sending of Notifications on one or more Subscriptions. More...

#include <setpublishingmoderequest.h>

Data Fields

bool publishing_enabled
 A Boolean parameter indicating whether publishing is enabled. More...
 
uint32_t * subscription_ids
 List of Server-assigned identifiers for the Subscriptions to enable or disable.
 
int32_t num_subscription_ids
 Number of elements in ua_setpublishingmoderequest::subscription_ids.
 

Related Functions

void ua_setpublishingmoderequest_init (struct ua_setpublishingmoderequest *t)
 Initialize an ua_setpublishingmoderequest struct with a valid value. More...
 
void ua_setpublishingmoderequest_clear (struct ua_setpublishingmoderequest *t)
 Clear all resources alloctated in an ua_setpublishingmoderequest struct. More...
 
int ua_setpublishingmoderequest_compare (const struct ua_setpublishingmoderequest *a, const struct ua_setpublishingmoderequest *b)
 Compare two ua_setpublishingmoderequest structs. More...
 
int ua_setpublishingmoderequest_copy (struct ua_setpublishingmoderequest *dst, const struct ua_setpublishingmoderequest *src)
 Create a copy of a ua_setpublishingmoderequest struct. More...
 
static int ua_setpublishingmoderequest_resize_subscription_ids_array (struct ua_setpublishingmoderequest *val, int32_t new_len)
 Resize the subscription_ids array of a ua_setpublishingmoderequest struct. More...
 

Detailed Description

Asynchronous call to enable sending of Notifications on one or more Subscriptions.

Friends And Related Function Documentation

void ua_setpublishingmoderequest_clear ( struct ua_setpublishingmoderequest t)
related

Clear all resources alloctated in an ua_setpublishingmoderequest struct.

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

int ua_setpublishingmoderequest_compare ( const struct ua_setpublishingmoderequest a,
const struct ua_setpublishingmoderequest b 
)
related

Compare two ua_setpublishingmoderequest structs.

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

int ua_setpublishingmoderequest_copy ( struct ua_setpublishingmoderequest dst,
const struct ua_setpublishingmoderequest src 
)
related

Create a copy of a ua_setpublishingmoderequest struct.

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

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

static int ua_setpublishingmoderequest_resize_subscription_ids_array ( struct ua_setpublishingmoderequest val,
int32_t  new_len 
)
related

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

Field Documentation

publishing_enabled

A Boolean parameter indicating whether publishing is enabled.

It has the following values:

TRUE
publishing of NotificationMessages is enabled for the Subscription.
FALSE
publishing of NotificationMessages is disabled for the Subscription.

The value of this parameter does not affect the value of the monitoring mode Attribute of MonitoredItems. Setting this value to FALSE does not discontinue the sending of keep-alive Messages.


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