High Performance OPC UA Server SDK  1.2.0.193
ua_transfersubscriptionsresponse Struct Reference

Data Fields

struct ua_transferresultresults
 List of results for the Subscriptions to transfer. More...
 
int32_t num_results
 Number of elements in ua_transfersubscriptionsresponse::results.
 
struct ua_diagnosticinfodiag_infos
 List of diagnostic information for the Subscriptions to transfer. More...
 
int32_t num_diag_infos
 Number of elements in ua_transfersubscriptionsresponse::diag_infos.
 

Related Functions

void ua_transfersubscriptionsresponse_init (struct ua_transfersubscriptionsresponse *t)
 Initialize an ua_transfersubscriptionsresponse struct with a valid value. More...
 
void ua_transfersubscriptionsresponse_clear (struct ua_transfersubscriptionsresponse *t)
 Clear all resources alloctated in an ua_transfersubscriptionsresponse struct. More...
 
int ua_transfersubscriptionsresponse_compare (const struct ua_transfersubscriptionsresponse *a, const struct ua_transfersubscriptionsresponse *b)
 Compare two ua_transfersubscriptionsresponse structs. More...
 
int ua_transfersubscriptionsresponse_copy (struct ua_transfersubscriptionsresponse *dst, const struct ua_transfersubscriptionsresponse *src)
 Create a copy of a ua_transfersubscriptionsresponse struct. More...
 
static int ua_transfersubscriptionsresponse_resize_results_array (struct ua_transfersubscriptionsresponse *val, int32_t new_len)
 Resize the results array of a ua_transfersubscriptionsresponse struct. More...
 
static int ua_transfersubscriptionsresponse_resize_diag_infos_array (struct ua_transfersubscriptionsresponse *val, int32_t new_len)
 Resize the diag_infos array of a ua_transfersubscriptionsresponse struct. More...
 

Friends And Related Function Documentation

void ua_transfersubscriptionsresponse_clear ( struct ua_transfersubscriptionsresponse t)
related

Clear all resources alloctated in an ua_transfersubscriptionsresponse struct.

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

int ua_transfersubscriptionsresponse_compare ( const struct ua_transfersubscriptionsresponse a,
const struct ua_transfersubscriptionsresponse b 
)
related

Compare two ua_transfersubscriptionsresponse structs.

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

int ua_transfersubscriptionsresponse_copy ( struct ua_transfersubscriptionsresponse dst,
const struct ua_transfersubscriptionsresponse src 
)
related

Create a copy of a ua_transfersubscriptionsresponse struct.

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

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

static int ua_transfersubscriptionsresponse_resize_diag_infos_array ( struct ua_transfersubscriptionsresponse val,
int32_t  new_len 
)
related

Resize the diag_infos array of a ua_transfersubscriptionsresponse 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_transfersubscriptionsresponse_resize_results_array ( struct ua_transfersubscriptionsresponse val,
int32_t  new_len 
)
related

Resize the results array of a ua_transfersubscriptionsresponse 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

diag_infos

List of diagnostic information for the Subscriptions to transfer.

The size and order of the list matches the size and order of the ua_TransferSubscriptionsRequest::subscription_ids 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.

results

List of results for the Subscriptions to transfer.

The size and order of the list matches the size and order of the ua_TransferSubscriptionsRequest::subscription_ids request parameter.


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