High Performance OPC UA Server SDK  1.2.0.193
ua_transferresult Struct Reference

A structure that is defined as the type of the results parameter of the TransferSubscriptions service. More...

#include <transferresult.h>

Data Fields

ua_statuscode status_code
 StatusCode for each Subscription to be transferred.
 
uint32_t * available_sequence_numbers
 A list of sequence number ranges that identify NotificationMessages that are in the Subscription’s retransmission queue. More...
 
int32_t num_available_sequence_numbers
 Number of elements in ua_transferresult::available_sequence_numbers.
 

Related Functions

void ua_transferresult_init (struct ua_transferresult *t)
 Initialize an ua_transferresult struct with a valid value. More...
 
void ua_transferresult_clear (struct ua_transferresult *t)
 Clear all resources alloctated in an ua_transferresult struct. More...
 
int ua_transferresult_compare (const struct ua_transferresult *a, const struct ua_transferresult *b)
 Compare two ua_transferresult structs. More...
 
int ua_transferresult_copy (struct ua_transferresult *dst, const struct ua_transferresult *src)
 Create a copy of a ua_transferresult struct. More...
 
static int ua_transferresult_resize_available_sequence_numbers_array (struct ua_transferresult *val, int32_t new_len)
 Resize the available_sequence_numbers array of a ua_transferresult struct. More...
 

Detailed Description

A structure that is defined as the type of the results parameter of the TransferSubscriptions service.

Friends And Related Function Documentation

void ua_transferresult_clear ( struct ua_transferresult t)
related

Clear all resources alloctated in an ua_transferresult struct.

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

int ua_transferresult_compare ( const struct ua_transferresult a,
const struct ua_transferresult b 
)
related

Compare two ua_transferresult structs.

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

int ua_transferresult_copy ( struct ua_transferresult dst,
const struct ua_transferresult src 
)
related

Create a copy of a ua_transferresult struct.

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

Initialize an ua_transferresult 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_transferresult struct can also be passed to ua_transferresult_compare, ua_transferresult_copy and ua_transferresult_clear. This function will always succeed as long as an ua_transferresult struct is passed to it.

static int ua_transferresult_resize_available_sequence_numbers_array ( struct ua_transferresult val,
int32_t  new_len 
)
related

Resize the available_sequence_numbers array of a ua_transferresult 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.

Field Documentation

available_sequence_numbers

A list of sequence number ranges that identify NotificationMessages that are in the Subscription’s retransmission queue.

This parameter is null if the transfer of the Subscription failed.


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