Describes an Endpoint for a Server. More...

#include <endpointdescription.h>

Data Fields
struct ua_string	endpoint_url
	The URL for the Endpoint described.

struct ua_applicationdescription	server
	The description for the Server that the Endpoint belongs to.

struct ua_bytestring	server_certificate
	The application instance certificate issued to the Server.

enum ua_messagesecuritymode	security_mode
	The type of security to apply to the messages. More...

struct ua_string	security_policy_uri
	The URI for SecurityPolicy to use when securing messages.

struct ua_usertokenpolicy *	user_identity_tokens
	The user identity tokens that the Server will accept. More...

int32_t	num_user_identity_tokens
	Number of elements in ua_endpointdescription::user_identity_tokens.

struct ua_string	transport_profile_uri
	The URI of the Transport Profile supported by the Endpoint.

uint8_t	security_level
	A numeric value that indicates how secure the EndpointDescription is compared to other EndpointDescriptions for the same Server. More...

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

void	ua_endpointdescription_clear (struct ua_endpointdescription *t)
	Clear all resources alloctated in an ua_endpointdescription struct. More...

int	ua_endpointdescription_compare (const struct ua_endpointdescription a, const struct ua_endpointdescription b)
	Compare two ua_endpointdescription structs. More...

int	ua_endpointdescription_copy (struct ua_endpointdescription dst, const struct ua_endpointdescription src)
	Create a copy of a ua_endpointdescription struct. More...

static int	ua_endpointdescription_resize_user_identity_tokens_array (struct ua_endpointdescription *val, int32_t new_len)
	Resize the user_identity_tokens array of a ua_endpointdescription struct. More...

Detailed Description

Describes an Endpoint for a Server.

Friends And Related Function Documentation

void ua_endpointdescription_clear ( struct ua_endpointdescription * t )

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

int ua_endpointdescription_compare	(	const struct ua_endpointdescription *	a,
		const struct ua_endpointdescription *	b
	)

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

int ua_endpointdescription_copy	(	struct ua_endpointdescription *	dst,
		const struct ua_endpointdescription *	src
	)

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

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

static int ua_endpointdescription_resize_user_identity_tokens_array	(	struct ua_endpointdescription *	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 user_identity_tokens array in number of members.

Returns: Zero on success or ua_statuscode on failure.

Field Documentation

security_level

A numeric value that indicates how secure the EndpointDescription is compared to other EndpointDescriptions for the same Server.

A value of 0 indicates that the EndpointDescription is not recommended and is only supported for backward compatibility.

A higher value indicates better security.

security_mode

The type of security to apply to the messages.

A SecureChannel may have to be created even if the securityMode is NONE.

user_identity_tokens

The user identity tokens that the Server will accept.

The Client shall pass one of the UserIdentityTokens in the ActivateSession request.

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

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

Data Fields

Related Functions

Detailed Description

Friends And Related Function Documentation

Field Documentation