High Performance OPC UA Server SDK  1.2.0.193
ua_callrequest Struct Reference

Asynchronously calls a method provided by an object on the OPC UA server. More...

#include <callrequest.h>

Data Fields

struct ua_callmethodrequestmethods_to_call
 List of methods to call.
 
int32_t num_methods_to_call
 Number of elements in ua_callrequest::methods_to_call.
 

Related Functions

void ua_callrequest_init (struct ua_callrequest *t)
 Initialize an ua_callrequest struct with a valid value. More...
 
void ua_callrequest_clear (struct ua_callrequest *t)
 Clear all resources alloctated in an ua_callrequest struct. More...
 
int ua_callrequest_compare (const struct ua_callrequest *a, const struct ua_callrequest *b)
 Compare two ua_callrequest structs. More...
 
int ua_callrequest_copy (struct ua_callrequest *dst, const struct ua_callrequest *src)
 Create a copy of a ua_callrequest struct. More...
 
static int ua_callrequest_resize_methods_to_call_array (struct ua_callrequest *val, int32_t new_len)
 Resize the methods_to_call array of a ua_callrequest struct. More...
 

Detailed Description

Asynchronously calls a method provided by an object on the OPC UA server.

Friends And Related Function Documentation

void ua_callrequest_clear ( struct ua_callrequest t)
related

Clear all resources alloctated in an ua_callrequest struct.

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

int ua_callrequest_compare ( const struct ua_callrequest a,
const struct ua_callrequest b 
)
related

Compare two ua_callrequest structs.

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

int ua_callrequest_copy ( struct ua_callrequest dst,
const struct ua_callrequest src 
)
related

Create a copy of a ua_callrequest struct.

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

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

static int ua_callrequest_resize_methods_to_call_array ( struct ua_callrequest val,
int32_t  new_len 
)
related

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

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