Closes a session with the server. More...

#include <closesessionrequest.h>

Data Fields
bool	delete_subscriptions

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

void	ua_closesessionrequest_clear (struct ua_closesessionrequest *t)
	Clear all resources alloctated in an ua_closesessionrequest struct. More...

int	ua_closesessionrequest_compare (const struct ua_closesessionrequest a, const struct ua_closesessionrequest b)
	Compare two ua_closesessionrequest structs. More...

int	ua_closesessionrequest_copy (struct ua_closesessionrequest dst, const struct ua_closesessionrequest src)
	Create a copy of a ua_closesessionrequest struct. More...

Detailed Description

Closes a session with the server.

Friends And Related Function Documentation

void ua_closesessionrequest_clear ( struct ua_closesessionrequest * t )

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

int ua_closesessionrequest_compare	(	const struct ua_closesessionrequest *	a,
		const struct ua_closesessionrequest *	b
	)

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

int ua_closesessionrequest_copy	(	struct ua_closesessionrequest *	dst,
		const struct ua_closesessionrequest *	src
	)

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

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

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

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

Data Fields

Related Functions

Detailed Description

Friends And Related Function Documentation