High Performance OPC UA Server SDK  1.1.0.158
ua_callresponse Struct Reference

Data Fields

struct ua_callmethodresultresults
 Result for the method calls.
 
int32_t num_results
 Number of elements in ua_callresponse::results.
 
struct ua_diagnosticinfodiag_infos
 List of diagnostic information for the StatusCode of the callResult. More...
 
int32_t num_diag_infos
 Number of elements in ua_callresponse::diag_infos.
 

Related Functions

void ua_callresponse_init (struct ua_callresponse *t)
 Initialize an ua_callresponse struct with a valid value. More...
 
void ua_callresponse_clear (struct ua_callresponse *t)
 Clear all resources alloctated in an ua_callresponse struct. More...
 
int ua_callresponse_compare (const struct ua_callresponse *a, const struct ua_callresponse *b)
 Compare two ua_callresponse structs. More...
 
int ua_callresponse_copy (struct ua_callresponse *dst, const struct ua_callresponse *src)
 Create a copy of a ua_callresponse struct. More...
 
static int ua_callresponse_resize_results_array (struct ua_callresponse *val, int32_t new_len)
 Resize the results array of a ua_callresponse struct. More...
 
static int ua_callresponse_resize_diag_infos_array (struct ua_callresponse *val, int32_t new_len)
 Resize the diag_infos array of a ua_callresponse struct. More...
 

Friends And Related Function Documentation

void ua_callresponse_clear ( struct ua_callresponse t)
related

Clear all resources alloctated in an ua_callresponse struct.

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

int ua_callresponse_compare ( const struct ua_callresponse a,
const struct ua_callresponse b 
)
related

Compare two ua_callresponse structs.

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

int ua_callresponse_copy ( struct ua_callresponse dst,
const struct ua_callresponse src 
)
related

Create a copy of a ua_callresponse struct.

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

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

static int ua_callresponse_resize_diag_infos_array ( struct ua_callresponse val,
int32_t  new_len 
)
related

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

Resize the results array of a ua_callresponse 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 StatusCode of the callResult.

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.


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