A token representing an anonymous user. More...

#include <anonymousidentitytoken.h>

Data Fields
struct ua_string	policy_id

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

void	ua_anonymousidentitytoken_clear (struct ua_anonymousidentitytoken *t)
	Clear all resources alloctated in an ua_anonymousidentitytoken struct. More...

int	ua_anonymousidentitytoken_compare (const struct ua_anonymousidentitytoken a, const struct ua_anonymousidentitytoken b)
	Compare two ua_anonymousidentitytoken structs. More...

int	ua_anonymousidentitytoken_copy (struct ua_anonymousidentitytoken dst, const struct ua_anonymousidentitytoken src)
	Create a copy of a ua_anonymousidentitytoken struct. More...

Detailed Description

A token representing an anonymous user.

Friends And Related Function Documentation

void ua_anonymousidentitytoken_clear ( struct ua_anonymousidentitytoken * t )

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

int ua_anonymousidentitytoken_compare	(	const struct ua_anonymousidentitytoken *	a,
		const struct ua_anonymousidentitytoken *	b
	)

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

int ua_anonymousidentitytoken_copy	(	struct ua_anonymousidentitytoken *	dst,
		const struct ua_anonymousidentitytoken *	src
	)

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

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

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

C:/work/embeddedstack/src/uabase/structure/anonymousidentitytoken.h
C:/work/embeddedstack/src/uabase/structure/anonymousidentitytoken.c

Data Fields

Related Functions

Detailed Description

Friends And Related Function Documentation