Data Fields
struct ua_datavalue *	results
	structures. More...

int32_t	num_results
	Number of elements in ua_readresponse::results.

struct ua_diagnosticinfo *	diag_infos
	List of diagnostic information. More...

int32_t	num_diag_infos
	Number of elements in ua_readresponse::diag_infos.

Related Functions
void	ua_readresponse_init (struct ua_readresponse *t)
	Initialize an ua_readresponse struct with a valid value. More...

void	ua_readresponse_clear (struct ua_readresponse *t)
	Clear all resources alloctated in an ua_readresponse struct. More...

int	ua_readresponse_compare (const struct ua_readresponse a, const struct ua_readresponse b)
	Compare two ua_readresponse structs. More...

int	ua_readresponse_copy (struct ua_readresponse dst, const struct ua_readresponse src)
	Create a copy of a ua_readresponse struct. More...

static int	ua_readresponse_resize_results_array (struct ua_readresponse *val, int32_t new_len)
	Resize the Results array of a ua_readresponse struct. More...

static int	ua_readresponse_resize_diag_infos_array (struct ua_readresponse *val, int32_t new_len)
	Resize the DiagnosticInfos array of a ua_readresponse struct. More...

Friends And Related Function Documentation

◆ ua_readresponse_clear()

void ua_readresponse_clear ( struct ua_readresponse * t )

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

◆ ua_readresponse_compare()

int ua_readresponse_compare	(	const struct ua_readresponse *	a,
		const struct ua_readresponse *	b
	)

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

◆ ua_readresponse_copy()

int ua_readresponse_copy	(	struct ua_readresponse *	dst,
		const struct ua_readresponse *	src
	)

Copy all fields from struct ua_readresponse 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.

◆ ua_readresponse_init()

void ua_readresponse_init ( struct ua_readresponse * t )

After initialization the fields of the struct are set to valid and consistent values and can safley be accessed. An initialized ua_readresponse struct can also be passed to ua_readresponse_clear. This function will always succeed as long as an ua_readresponse struct is passed to it.

◆ ua_readresponse_resize_diag_infos_array()

static int ua_readresponse_resize_diag_infos_array	(	struct ua_readresponse *	val,
		int32_t	new_len
	)

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

val	The value to be resized.
new_len	New length of the DiagnosticInfos array in number of members.

Returns: Zero on success or ua_statuscode on failure.

◆ ua_readresponse_resize_results_array()

static int ua_readresponse_resize_results_array	(	struct ua_readresponse *	val,
		int32_t	new_len
	)

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

val	The value to be resized.
new_len	New length of the Results array in number of members.

Returns: Zero on success or ua_statuscode on failure.

Field Documentation

◆ diag_infos

diag_infos

List of diagnostic information.

The size and order of this list matches the size and order of the ua_readrequest::nodes list for each Node contained in the ua_readrequest::nodes parameter. This list is empty if diagnostics information was not requested in the request header or if no diagnostic information was encountered in processing of the request.

◆ results

results

structures.

The DataValue consists of

Value: The value of the read node and attribute combination
StatusCode: This parameter is used to indicate the conditions under which the value was generated, and thereby can be used as an indicator of the usability of the value.
SourceTimestamp: Reflects the UTC timestamp that was applied to the value by the data source. It is only available for Value attributes.
ServerTimestamp: Reflects the time that the Server received the value or knew it to be accurate.

The size and order of this list matches the size and order of the ua_readrequest::nodes list for each Node contained in the ua_readrequest::nodes parameter.

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

/root/src/src/uabase/service/readresponse.h
/root/src/src/uabase/service/readresponse.c

Data Fields

Related Functions