Activates a session with the server. More...

#include <activatesessionrequest.h>

Data Fields
struct ua_signaturedata	client_signature

struct ua_signedsoftwarecertificate *	client_software_certificates

int32_t	num_client_software_certificates

struct ua_string *	locale_ids

int32_t	num_locale_ids

struct ua_extensionobject	user_identity_token

struct ua_signaturedata	user_token_signature

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

void	ua_activatesessionrequest_clear (struct ua_activatesessionrequest *t)
	Clear all resources alloctated in an ua_activatesessionrequest struct. More...

int	ua_activatesessionrequest_compare (const struct ua_activatesessionrequest a, const struct ua_activatesessionrequest b)
	Compare two ua_activatesessionrequest structs. More...

int	ua_activatesessionrequest_copy (struct ua_activatesessionrequest dst, const struct ua_activatesessionrequest src)
	Create a copy of a ua_activatesessionrequest struct. More...

static int	ua_activatesessionrequest_resize_client_software_certificates_array (struct ua_activatesessionrequest *val, int32_t new_len)
	Resize the client_software_certificates array of a ua_activatesessionrequest struct. More...

static int	ua_activatesessionrequest_resize_locale_ids_array (struct ua_activatesessionrequest *val, int32_t new_len)
	Resize the locale_ids array of a ua_activatesessionrequest struct. More...

Detailed Description

Activates a session with the server.

Friends And Related Function Documentation

void ua_activatesessionrequest_clear ( struct ua_activatesessionrequest * t )

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

int ua_activatesessionrequest_compare	(	const struct ua_activatesessionrequest *	a,
		const struct ua_activatesessionrequest *	b
	)

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

int ua_activatesessionrequest_copy	(	struct ua_activatesessionrequest *	dst,
		const struct ua_activatesessionrequest *	src
	)

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

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

static int ua_activatesessionrequest_resize_client_software_certificates_array	(	struct ua_activatesessionrequest *	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 client_software_certificates array in number of members.

Returns: Zero on success or ua_statuscode on failure.

static int ua_activatesessionrequest_resize_locale_ids_array	(	struct ua_activatesessionrequest *	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 locale_ids 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:

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

Data Fields

Related Functions

Detailed Description

Friends And Related Function Documentation