Specifies an application that is available. More...

#include <applicationdescription.h>

Data Fields
struct ua_string	application_uri
	The globally unique identifier for the application instance. More...

struct ua_string	product_uri
	The globally unique identifier for the product.

struct ua_localizedtext	application_name
	A localized descriptive name for the application.

enum ua_applicationtype	application_type
	The type of application. More...

struct ua_string	gateway_server_uri
	A URI that identifies the Gateway Server associated with the DiscoveryUrls. More...

struct ua_string	discovery_profile_uri
	A URI that identifies the discovery profile supported by the URLs provided. More...

struct ua_string *	discovery_urls
	A list of URLs for the discovery Endpoints provided by the application. More...

int32_t	num_discovery_urls
	Number of elements in ua_applicationdescription::discovery_urls.

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

void	ua_applicationdescription_clear (struct ua_applicationdescription *t)
	Clear all resources alloctated in an ua_applicationdescription struct. More...

int	ua_applicationdescription_compare (const struct ua_applicationdescription a, const struct ua_applicationdescription b)
	Compare two ua_applicationdescription structs. More...

int	ua_applicationdescription_copy (struct ua_applicationdescription dst, const struct ua_applicationdescription src)
	Create a copy of a ua_applicationdescription struct. More...

static int	ua_applicationdescription_resize_discovery_urls_array (struct ua_applicationdescription *val, int32_t new_len)
	Resize the discovery_urls array of a ua_applicationdescription struct. More...

Detailed Description

Specifies an application that is available.

Friends And Related Function Documentation

void ua_applicationdescription_clear ( struct ua_applicationdescription * t )

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

int ua_applicationdescription_compare	(	const struct ua_applicationdescription *	a,
		const struct ua_applicationdescription *	b
	)

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

int ua_applicationdescription_copy	(	struct ua_applicationdescription *	dst,
		const struct ua_applicationdescription *	src
	)

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

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

static int ua_applicationdescription_resize_discovery_urls_array	(	struct ua_applicationdescription *	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 discovery_urls array in number of members.

Returns: Zero on success or ua_statuscode on failure.

Field Documentation

application_type

The type of application.

See ua_applicationtype

application_uri

The globally unique identifier for the application instance.

This URI is used as ServerUri in Services if the application is a Server.

discovery_profile_uri

A URI that identifies the discovery profile supported by the URLs provided.

This field is not used if the ApplicationType is client.

discovery_urls

A list of URLs for the discovery Endpoints provided by the application.

If the ApplicationType is Client, this field shall contain an empty list.

gateway_server_uri

A URI that identifies the Gateway Server associated with the DiscoveryUrls.

This value is not specified if the Server can be accessed directly.

This field is not used if the ApplicationType is Client.

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

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

Data Fields

Related Functions

Detailed Description

Friends And Related Function Documentation

Field Documentation