Data Fields
struct ua_endpointdescription *	endpoints
	List of Endpoints that meet criteria specified in the request. More...

int32_t	num_endpoints
	Number of elements in ua_getendpointsresponse::endpoints.

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

void	ua_getendpointsresponse_clear (struct ua_getendpointsresponse *t)
	Clear all resources alloctated in an ua_getendpointsresponse struct. More...

int	ua_getendpointsresponse_compare (const struct ua_getendpointsresponse a, const struct ua_getendpointsresponse b)
	Compare two ua_getendpointsresponse structs. More...

int	ua_getendpointsresponse_copy (struct ua_getendpointsresponse dst, const struct ua_getendpointsresponse src)
	Create a copy of a ua_getendpointsresponse struct. More...

static int	ua_getendpointsresponse_resize_endpoints_array (struct ua_getendpointsresponse *val, int32_t new_len)
	Resize the endpoints array of a ua_getendpointsresponse struct. More...

Friends And Related Function Documentation

void ua_getendpointsresponse_clear ( struct ua_getendpointsresponse * t )

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

int ua_getendpointsresponse_compare	(	const struct ua_getendpointsresponse *	a,
		const struct ua_getendpointsresponse *	b
	)

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

int ua_getendpointsresponse_copy	(	struct ua_getendpointsresponse *	dst,
		const struct ua_getendpointsresponse *	src
	)

Copy all fields from struct ua_getendpointsresponse 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_getendpointsresponse_init ( struct ua_getendpointsresponse * t )

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

static int ua_getendpointsresponse_resize_endpoints_array	(	struct ua_getendpointsresponse *	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

new_len New length of the endpoints array in number of members.

Returns: Zero on success or ua_statuscode on failure.

Field Documentation

endpoints

List of Endpoints that meet criteria specified in the request.

This list is empty if no Endpoints meet the criteria

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

C:/work/embeddedstack/src/uabase/service/getendpointsresponse.h
C:/work/embeddedstack/src/uabase/service/getendpointsresponse.c

Data Fields

Related Functions

Friends And Related Function Documentation

Field Documentation