High Performance OPC UA Server SDK  1.2.0.193
ua_networkgroupdatatype Struct Reference

Contains information on different network paths for one Server. More...

#include <networkgroupdatatype.h>

Data Fields

struct ua_string server_uri
 URI of the Server represented by the network group.
 
struct ua_endpointurllistdatatypenetwork_paths
 Array of different network paths to the server, for example provided by different network cards in a Server node. More...
 
int32_t num_network_paths
 Number of elements in ua_networkgroupdatatype::network_paths.
 

Related Functions

void ua_networkgroupdatatype_init (struct ua_networkgroupdatatype *t)
 Initialize an ua_networkgroupdatatype struct with a valid value. More...
 
void ua_networkgroupdatatype_clear (struct ua_networkgroupdatatype *t)
 Clear all resources alloctated in an ua_networkgroupdatatype struct. More...
 
int ua_networkgroupdatatype_compare (const struct ua_networkgroupdatatype *a, const struct ua_networkgroupdatatype *b)
 Compare two ua_networkgroupdatatype structs. More...
 
int ua_networkgroupdatatype_copy (struct ua_networkgroupdatatype *dst, const struct ua_networkgroupdatatype *src)
 Create a copy of a ua_networkgroupdatatype struct. More...
 
static int ua_networkgroupdatatype_resize_network_paths_array (struct ua_networkgroupdatatype *val, int32_t new_len)
 Resize the network_paths array of a ua_networkgroupdatatype struct. More...
 

Detailed Description

Contains information on different network paths for one Server.

Friends And Related Function Documentation

void ua_networkgroupdatatype_clear ( struct ua_networkgroupdatatype t)
related

Clear all resources alloctated in an ua_networkgroupdatatype struct.

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

int ua_networkgroupdatatype_compare ( const struct ua_networkgroupdatatype a,
const struct ua_networkgroupdatatype b 
)
related

Compare two ua_networkgroupdatatype structs.

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

int ua_networkgroupdatatype_copy ( struct ua_networkgroupdatatype dst,
const struct ua_networkgroupdatatype src 
)
related

Create a copy of a ua_networkgroupdatatype struct.

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

Initialize an ua_networkgroupdatatype 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_networkgroupdatatype struct can also be passed to ua_networkgroupdatatype_compare, ua_networkgroupdatatype_copy and ua_networkgroupdatatype_clear. This function will always succeed as long as an ua_networkgroupdatatype struct is passed to it.

static int ua_networkgroupdatatype_resize_network_paths_array ( struct ua_networkgroupdatatype val,
int32_t  new_len 
)
related

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

Field Documentation

network_paths

Array of different network paths to the server, for example provided by different network cards in a Server node.

Each network path can have several Endpoints representing different protocol options for the same path.


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