High Performance OPC UA Server SDK  1.2.0.193
ua_addreferencesrequest Struct Reference

Asynchronously adds one or more references to one or more nodes. More...

#include <addreferencesrequest.h>

Data Fields

struct ua_addreferencesitemreferences_to_add
 List of reference instances to add to the source node. More...
 
int32_t num_references_to_add
 Number of elements in ua_addreferencesrequest::references_to_add.
 

Related Functions

void ua_addreferencesrequest_init (struct ua_addreferencesrequest *t)
 Initialize an ua_addreferencesrequest struct with a valid value. More...
 
void ua_addreferencesrequest_clear (struct ua_addreferencesrequest *t)
 Clear all resources alloctated in an ua_addreferencesrequest struct. More...
 
int ua_addreferencesrequest_compare (const struct ua_addreferencesrequest *a, const struct ua_addreferencesrequest *b)
 Compare two ua_addreferencesrequest structs. More...
 
int ua_addreferencesrequest_copy (struct ua_addreferencesrequest *dst, const struct ua_addreferencesrequest *src)
 Create a copy of a ua_addreferencesrequest struct. More...
 
static int ua_addreferencesrequest_resize_references_to_add_array (struct ua_addreferencesrequest *val, int32_t new_len)
 Resize the references_to_add array of a ua_addreferencesrequest struct. More...
 

Detailed Description

Asynchronously adds one or more references to one or more nodes.

The NodeClass is an input parameter that is used to validate that the reference to be added matches the NodeClass of the target node. This parameter is not validated if the reference refers to a target node in a remote Server.

In certain cases, adding new references to the address space shall require that the Server add new Server ids to the Server’s ServerArray variable. For this reason, remote Servers are identified by their URI and not by their ServerArray index. This allows the Server to add the remote Server URIs to its ServerArray.

Friends And Related Function Documentation

void ua_addreferencesrequest_clear ( struct ua_addreferencesrequest t)
related

Clear all resources alloctated in an ua_addreferencesrequest struct.

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

int ua_addreferencesrequest_compare ( const struct ua_addreferencesrequest a,
const struct ua_addreferencesrequest b 
)
related

Compare two ua_addreferencesrequest structs.

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

int ua_addreferencesrequest_copy ( struct ua_addreferencesrequest dst,
const struct ua_addreferencesrequest src 
)
related

Create a copy of a ua_addreferencesrequest struct.

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

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

static int ua_addreferencesrequest_resize_references_to_add_array ( struct ua_addreferencesrequest val,
int32_t  new_len 
)
related

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

Field Documentation

references_to_add

List of reference instances to add to the source node.

The ua_AddReferencesItem::target_node_class of each reference in the list shall match the node class of the target node.


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