High Performance OPC UA Server SDK  1.2.0.193
ua_publishresponse Struct Reference

Data Fields

uint32_t subscription_id
 The Server-assigned identifier for the Subscription for which notifications are being returned. More...
 
uint32_t * available_sequence_numbers
 A list of sequence number ranges that identify unacknowledged NotificationMessages that are available for retransmission from the Subscription’s retransmission queue. More...
 
int32_t num_available_sequence_numbers
 Number of elements in ua_publishresponse::available_sequence_numbers.
 
bool more_notifications
 A Boolean parameter indicating whether all avalaible notifications could be included in a single response. More...
 
struct ua_notificationmessage notification_message
 The NotificationMessage that contains the list of Notifications.
 
ua_statuscoderesults
 List of results for the acknowledgements. More...
 
int32_t num_results
 Number of elements in ua_publishresponse::results.
 
struct ua_diagnosticinfodiag_infos
 List of diagnostic information for the acknowledgements. More...
 
int32_t num_diag_infos
 Number of elements in ua_publishresponse::diag_infos.
 

Related Functions

void ua_publishresponse_init (struct ua_publishresponse *t)
 Initialize an ua_publishresponse struct with a valid value. More...
 
void ua_publishresponse_clear (struct ua_publishresponse *t)
 Clear all resources alloctated in an ua_publishresponse struct. More...
 
int ua_publishresponse_compare (const struct ua_publishresponse *a, const struct ua_publishresponse *b)
 Compare two ua_publishresponse structs. More...
 
int ua_publishresponse_copy (struct ua_publishresponse *dst, const struct ua_publishresponse *src)
 Create a copy of a ua_publishresponse struct. More...
 
static int ua_publishresponse_resize_available_sequence_numbers_array (struct ua_publishresponse *val, int32_t new_len)
 Resize the available_sequence_numbers array of a ua_publishresponse struct. More...
 
static int ua_publishresponse_resize_results_array (struct ua_publishresponse *val, int32_t new_len)
 Resize the results array of a ua_publishresponse struct. More...
 
static int ua_publishresponse_resize_diag_infos_array (struct ua_publishresponse *val, int32_t new_len)
 Resize the diag_infos array of a ua_publishresponse struct. More...
 

Friends And Related Function Documentation

void ua_publishresponse_clear ( struct ua_publishresponse t)
related

Clear all resources alloctated in an ua_publishresponse struct.

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

int ua_publishresponse_compare ( const struct ua_publishresponse a,
const struct ua_publishresponse b 
)
related

Compare two ua_publishresponse structs.

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

int ua_publishresponse_copy ( struct ua_publishresponse dst,
const struct ua_publishresponse src 
)
related

Create a copy of a ua_publishresponse struct.

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

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

static int ua_publishresponse_resize_available_sequence_numbers_array ( struct ua_publishresponse val,
int32_t  new_len 
)
related

Resize the available_sequence_numbers array of a ua_publishresponse 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 available_sequence_numbers array in number of members.
Returns
Zero on success or ua_statuscode on failure.
static int ua_publishresponse_resize_diag_infos_array ( struct ua_publishresponse val,
int32_t  new_len 
)
related

Resize the diag_infos array of a ua_publishresponse 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 diag_infos array in number of members.
Returns
Zero on success or ua_statuscode on failure.
static int ua_publishresponse_resize_results_array ( struct ua_publishresponse val,
int32_t  new_len 
)
related

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

Field Documentation

available_sequence_numbers

A list of sequence number ranges that identify unacknowledged NotificationMessages that are available for retransmission from the Subscription’s retransmission queue.

This list is prepared after processing the acknowledgements in the request.

diag_infos

List of diagnostic information for the acknowledgements.

The size and order of the list matches the size and order of the ua_PublishRequest::subscription_acknowledgements request parameter. This list is empty if diagnostics information was not requested in the request header or if no diagnostic information was encountered in processing of the request.

more_notifications

A Boolean parameter indicating whether all avalaible notifications could be included in a single response.

It has the following values:

TRUE
The number of Notifications that were ready to be sent could not be sent in a single response.
FALSE
All Notifications that were ready are included in the response.
results

List of results for the acknowledgements.

The size and order of the list matches the size and order of the ua_PublishRequest::subscription_acknowledgements request parameter.

subscription_id

The Server-assigned identifier for the Subscription for which notifications are being returned.

The value 0 is used to indicate that there were no Subscriptions defined for which a response could be sent.


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