Contains diagnostic information about client sessions. More...

#include <sessiondiagnosticsdatatype.h>

Data Fields
struct ua_nodeid	session_id
	Server-assigned identifier of the session.

struct ua_string	session_name
	The name of the session provided in the CreateSession request.

struct ua_applicationdescription	client_description
	The description provided by the client in the CreateSession request.

struct ua_string	server_uri
	The serverUri request in the CreateSession request.

struct ua_string	endpoint_url
	The endpointUrl passed by the client to the CreateSession request.

struct ua_string *	locale_ids
	Array of LocaleIds specified by the client in the open session call.

int32_t	num_locale_ids
	Number of elements in ua_sessiondiagnosticsdatatype::locale_ids.

double	actual_session_timeout
	The requested session timeout specified by the client in the open session call.

uint32_t	max_response_message_size
	The maximum size for the response message sent to the client.

ua_datetime	client_connection_time
	The server timestamp when the client opens the session.

ua_datetime	client_last_contact_time
	The server timestamp of the last request of the client in the context of the session.

uint32_t	current_subscriptions_count
	The number of subscriptions currently used by the session.

uint32_t	current_monitored_items_count
	The number of MonitoredItems currently used by the session.

uint32_t	current_publish_requests_in_queue
	The number of publish timer expirations when there are data to be sent, but there are no publish requests for this session. More...

struct ua_servicecounterdatatype	total_request_count
	Counter of allServices, identifying the number of received requests of any Services on the session.

uint32_t	unauthorized_request_count
	Counter of all Services, identifying the number of Service requests that were rejected due to authorization failure.

struct ua_servicecounterdatatype	read_count
	Counter of the Read Service, identifying the number of received requests of this Service on the session.

struct ua_servicecounterdatatype	history_read_count
	Counter of the HistoryRead Service, identifying the number of received requests of this Service on the session.

struct ua_servicecounterdatatype	write_count
	Counter of the Write Service, identifying the number of received requests of this Service on the session.

struct ua_servicecounterdatatype	history_update_count
	Counter of the HistoryUpdate Service, identifying the number of received requests of this Service on the session.

struct ua_servicecounterdatatype	call_count
	Counter of the Call Service, identifying the number of received requests of this Service on the session.

struct ua_servicecounterdatatype	create_monitored_items_count
	Counter of the CreateMonitoredItems Service, identifying the number of received requests of this Service on the session.

struct ua_servicecounterdatatype	modify_monitored_items_count
	Counter of the ModifyMonitoredItems Service, identifying the number of received requests of this Service on the session.

struct ua_servicecounterdatatype	set_monitoring_mode_count
	Counter of the SetMonitoringMode Service, identifying the number of received requests of this Service on the session.

struct ua_servicecounterdatatype	set_triggering_count
	Counter of the SetTriggering Service, identifying the number of received requests of this Service on the session.

struct ua_servicecounterdatatype	delete_monitored_items_count
	Counter of the DeleteMonitoredItems Service, identifying the number of received requests of this Service on the session.

struct ua_servicecounterdatatype	create_subscription_count
	Counter of the CreateSubscription Service, identifying the number of received requests of this Service on the session.

struct ua_servicecounterdatatype	modify_subscription_count
	Counter of the ModifySubscription Service, identifying the number of received requests of this Service on the session.

struct ua_servicecounterdatatype	set_publishing_mode_count
	Counter of the SetPublishingMode Service, identifying the number of received requests of this Service on the session.

struct ua_servicecounterdatatype	publish_count
	Counter of the Publish Service, identifying the number of received requests of this Service on the session.

struct ua_servicecounterdatatype	republish_count
	Counter of the Republish Service, identifying the number of received requests of this Service on the session.

struct ua_servicecounterdatatype	transfer_subscriptions_count
	Counter of the TransferSubscriptions Service, identifying the number of received requests of this Service on the session.

struct ua_servicecounterdatatype	delete_subscriptions_count
	Counter of the DeleteSubscriptions Service, identifying the number of received requests of this Service on the session.

struct ua_servicecounterdatatype	add_nodes_count
	Counter of the AddNodes Service, identifying the number of received requests of this Service on the session.

struct ua_servicecounterdatatype	add_references_count
	Counter of the AddReferences Service, identifying the number of received requests of this Service on the session.

struct ua_servicecounterdatatype	delete_nodes_count
	Counter of the DeleteNodes Service, identifying the number of received requests of this Service on the session.

struct ua_servicecounterdatatype	delete_references_count
	Counter of the DeleteReferences Service, identifying the number of received requests of this Service on the session.

struct ua_servicecounterdatatype	browse_count
	Counter of the Browse Service, identifying the number of received requests of this Service on the session.

struct ua_servicecounterdatatype	browse_next_count
	Counter of the BrowseNext Service, identifying the number of received requests of this Service on the session.

struct ua_servicecounterdatatype	translate_browse_paths_to_node_ids_count
	Counter of the TranslateBrowsePathsToNodeIds Service, identifying the number of received requests of this Service on the session.

struct ua_servicecounterdatatype	query_first_count
	Counter of the QueryFirst Service, identifying the number of received requests of this Service on the session.

struct ua_servicecounterdatatype	query_next_count
	Counter of the QueryNext Service, identifying the number of received requests of this Service on the session.

struct ua_servicecounterdatatype	register_nodes_count
	Counter of the RegisterNodes Service, identifying the number of received requests of this Service on the session.

struct ua_servicecounterdatatype	unregister_nodes_count
	Counter of the UnregisterNodesService, identifying the number of received requests of this Service on the session.

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

void	ua_sessiondiagnosticsdatatype_clear (struct ua_sessiondiagnosticsdatatype *t)
	Clear all resources alloctated in an ua_sessiondiagnosticsdatatype struct. More...

int	ua_sessiondiagnosticsdatatype_compare (const struct ua_sessiondiagnosticsdatatype a, const struct ua_sessiondiagnosticsdatatype b)
	Compare two ua_sessiondiagnosticsdatatype structs. More...

int	ua_sessiondiagnosticsdatatype_copy (struct ua_sessiondiagnosticsdatatype dst, const struct ua_sessiondiagnosticsdatatype src)
	Create a copy of a ua_sessiondiagnosticsdatatype struct. More...

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

Detailed Description

Contains diagnostic information about client sessions.

Most of the values represented in this structure provide information about the number of calls of a Service, the number of currently used MonitoredItems, etc. Those numbers need not provide the exact value; they need only provide the approximate number, so that the Server is not burdened with providing the exact numbers.

Friends And Related Function Documentation

void ua_sessiondiagnosticsdatatype_clear ( struct ua_sessiondiagnosticsdatatype * t )

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

int ua_sessiondiagnosticsdatatype_compare	(	const struct ua_sessiondiagnosticsdatatype *	a,
		const struct ua_sessiondiagnosticsdatatype *	b
	)

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

int ua_sessiondiagnosticsdatatype_copy	(	struct ua_sessiondiagnosticsdatatype *	dst,
		const struct ua_sessiondiagnosticsdatatype *	src
	)

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

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

static int ua_sessiondiagnosticsdatatype_resize_locale_ids_array	(	struct ua_sessiondiagnosticsdatatype *	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.

Field Documentation

current_publish_requests_in_queue

The number of publish timer expirations when there are data to be sent, but there are no publish requests for this session.

The value shall be 0 if there are no data to be sent or publish requests queued.

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

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

Data Fields

Related Functions

Detailed Description

Friends And Related Function Documentation

Field Documentation