High Performance OPC UA Server SDK  1.2.0.193
ua_unregisternodesrequest Struct Reference

Asynchronously unregisters nodes to delete shortcuts in the server. More...

#include <unregisternodesrequest.h>

Data Fields

struct ua_nodeidnodes
 A list of NodeIds that have been obtained via the RegisterNodes service.
 
int32_t num_nodes
 Number of elements in ua_unregisternodesrequest::nodes.
 

Related Functions

void ua_unregisternodesrequest_init (struct ua_unregisternodesrequest *t)
 Initialize an ua_unregisternodesrequest struct with a valid value. More...
 
void ua_unregisternodesrequest_clear (struct ua_unregisternodesrequest *t)
 Clear all resources alloctated in an ua_unregisternodesrequest struct. More...
 
int ua_unregisternodesrequest_compare (const struct ua_unregisternodesrequest *a, const struct ua_unregisternodesrequest *b)
 Compare two ua_unregisternodesrequest structs. More...
 
int ua_unregisternodesrequest_copy (struct ua_unregisternodesrequest *dst, const struct ua_unregisternodesrequest *src)
 Create a copy of a ua_unregisternodesrequest struct. More...
 
static int ua_unregisternodesrequest_resize_nodes_array (struct ua_unregisternodesrequest *val, int32_t new_len)
 Resize the nodes array of a ua_unregisternodesrequest struct. More...
 

Detailed Description

Asynchronously unregisters nodes to delete shortcuts in the server.

This Service is used to unregister NodeIds that have been obtained via the RegisterNodes service.

UnregisterNodes does not validate the NodeIds from the request. Servers shall simply unregister NodeIds that are known as registered NodeIds. Any NodeIds that are in the list, but are not registered NodeIds are simply ignored.

Friends And Related Function Documentation

void ua_unregisternodesrequest_clear ( struct ua_unregisternodesrequest t)
related

Clear all resources alloctated in an ua_unregisternodesrequest struct.

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

int ua_unregisternodesrequest_compare ( const struct ua_unregisternodesrequest a,
const struct ua_unregisternodesrequest b 
)
related

Compare two ua_unregisternodesrequest structs.

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

int ua_unregisternodesrequest_copy ( struct ua_unregisternodesrequest dst,
const struct ua_unregisternodesrequest src 
)
related

Create a copy of a ua_unregisternodesrequest struct.

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

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

static int ua_unregisternodesrequest_resize_nodes_array ( struct ua_unregisternodesrequest val,
int32_t  new_len 
)
related

Resize the nodes array of a ua_unregisternodesrequest 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 nodes 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: