High Performance OPC UA Server SDK  1.2.0.193
ua_callmethodrequest Struct Reference

A structure that is defined as the type of the methodsToCall parameter of the Call service. More...

#include <callmethodrequest.h>

Data Fields

struct ua_nodeid object_id
 The NodeId shall be that of the object or ObjectType that is the source of a HasComponent Reference (or subtype of HasComponent Reference) to the method specified in methodId. More...
 
struct ua_nodeid method_id
 NodeId of the method to invoke. More...
 
struct ua_variantinput_arguments
 List of input argument values. More...
 
int32_t num_input_arguments
 Number of elements in ua_callmethodrequest::input_arguments.
 

Related Functions

void ua_callmethodrequest_init (struct ua_callmethodrequest *t)
 Initialize an ua_callmethodrequest struct with a valid value. More...
 
void ua_callmethodrequest_clear (struct ua_callmethodrequest *t)
 Clear all resources alloctated in an ua_callmethodrequest struct. More...
 
int ua_callmethodrequest_compare (const struct ua_callmethodrequest *a, const struct ua_callmethodrequest *b)
 Compare two ua_callmethodrequest structs. More...
 
int ua_callmethodrequest_copy (struct ua_callmethodrequest *dst, const struct ua_callmethodrequest *src)
 Create a copy of a ua_callmethodrequest struct. More...
 
static int ua_callmethodrequest_resize_input_arguments_array (struct ua_callmethodrequest *val, int32_t new_len)
 Resize the input_arguments array of a ua_callmethodrequest struct. More...
 

Detailed Description

A structure that is defined as the type of the methodsToCall parameter of the Call service.

Friends And Related Function Documentation

void ua_callmethodrequest_clear ( struct ua_callmethodrequest t)
related

Clear all resources alloctated in an ua_callmethodrequest struct.

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

int ua_callmethodrequest_compare ( const struct ua_callmethodrequest a,
const struct ua_callmethodrequest b 
)
related

Compare two ua_callmethodrequest structs.

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

int ua_callmethodrequest_copy ( struct ua_callmethodrequest dst,
const struct ua_callmethodrequest src 
)
related

Create a copy of a ua_callmethodrequest struct.

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

Initialize an ua_callmethodrequest 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_callmethodrequest struct can also be passed to ua_callmethodrequest_compare, ua_callmethodrequest_copy and ua_callmethodrequest_clear. This function will always succeed as long as an ua_callmethodrequest struct is passed to it.

static int ua_callmethodrequest_resize_input_arguments_array ( struct ua_callmethodrequest val,
int32_t  new_len 
)
related

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

Field Documentation

input_arguments

List of input argument values.

An empty list indicates that there are no input arguments. The size and order of this list matches the size and order of the input arguments defined by the input InputArguments Property of the method.

The name, a description and the data type of each argument are defined by the Argument structure in each element of the method’s InputArguments Property.

method_id

NodeId of the method to invoke.

If the objectId is the NodeId of an object, it is allowed to use the NodeId of a method that is the target of a HasComponent Reference from the ObjectType of the object.

object_id

The NodeId shall be that of the object or ObjectType that is the source of a HasComponent Reference (or subtype of HasComponent Reference) to the method specified in methodId.

See Part 3 of the OPC UA Specification for a description of objects and their methods.


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