High Performance OPC UA Server SDK  1.2.0.193
ua_sessionsecuritydiagnosticsdatatype Struct Reference

contains security-related diagnostic information about client sessions. More...

#include <sessionsecuritydiagnosticsdatatype.h>

Data Fields

struct ua_nodeid session_id
 Server-assigned identifier of the session.
 
struct ua_string client_user_id_of_session
 Name of authenticated user when creating the session.
 
struct ua_stringclient_user_id_history
 Array containing the name of the authenticated user currently active (either from creating the session or from calling the ActivateSession Service) and the history of those names. More...
 
int32_t num_client_user_id_history
 Number of elements in ua_sessionsecuritydiagnosticsdatatype::client_user_id_history.
 
struct ua_string authentication_mechanism
 Type of authentication currently used by the session. More...
 
struct ua_string encoding
 Which encoding is used on the wire. More...
 
struct ua_string transport_protocol
 Which transport protocol is used. More...
 
enum ua_messagesecuritymode security_mode
 The message security mode used for the session.
 
struct ua_string security_policy_uri
 The name of the security policy used for the session.
 
struct ua_bytestring client_certificate
 The application instance certificate provided by the client in the CreateSession request.
 

Related Functions

void ua_sessionsecuritydiagnosticsdatatype_init (struct ua_sessionsecuritydiagnosticsdatatype *t)
 Initialize an ua_sessionsecuritydiagnosticsdatatype struct with a valid value. More...
 
void ua_sessionsecuritydiagnosticsdatatype_clear (struct ua_sessionsecuritydiagnosticsdatatype *t)
 Clear all resources alloctated in an ua_sessionsecuritydiagnosticsdatatype struct. More...
 
int ua_sessionsecuritydiagnosticsdatatype_compare (const struct ua_sessionsecuritydiagnosticsdatatype *a, const struct ua_sessionsecuritydiagnosticsdatatype *b)
 Compare two ua_sessionsecuritydiagnosticsdatatype structs. More...
 
int ua_sessionsecuritydiagnosticsdatatype_copy (struct ua_sessionsecuritydiagnosticsdatatype *dst, const struct ua_sessionsecuritydiagnosticsdatatype *src)
 Create a copy of a ua_sessionsecuritydiagnosticsdatatype struct. More...
 
static int ua_sessionsecuritydiagnosticsdatatype_resize_client_user_id_history_array (struct ua_sessionsecuritydiagnosticsdatatype *val, int32_t new_len)
 Resize the client_user_id_history array of a ua_sessionsecuritydiagnosticsdatatype struct. More...
 

Detailed Description

contains security-related diagnostic information about client sessions.

Because this information is security-related, it should not be made accessible to all users, but only to authorised users.

Friends And Related Function Documentation

void ua_sessionsecuritydiagnosticsdatatype_clear ( struct ua_sessionsecuritydiagnosticsdatatype t)
related

Clear all resources alloctated in an ua_sessionsecuritydiagnosticsdatatype struct.

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

int ua_sessionsecuritydiagnosticsdatatype_compare ( const struct ua_sessionsecuritydiagnosticsdatatype a,
const struct ua_sessionsecuritydiagnosticsdatatype b 
)
related

Compare two ua_sessionsecuritydiagnosticsdatatype structs.

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

int ua_sessionsecuritydiagnosticsdatatype_copy ( struct ua_sessionsecuritydiagnosticsdatatype dst,
const struct ua_sessionsecuritydiagnosticsdatatype src 
)
related

Create a copy of a ua_sessionsecuritydiagnosticsdatatype struct.

Copy all fields from struct ua_sessionsecuritydiagnosticsdatatype 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_sessionsecuritydiagnosticsdatatype_init ( struct ua_sessionsecuritydiagnosticsdatatype t)
related

Initialize an ua_sessionsecuritydiagnosticsdatatype struct with a valid value.

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

static int ua_sessionsecuritydiagnosticsdatatype_resize_client_user_id_history_array ( struct ua_sessionsecuritydiagnosticsdatatype val,
int32_t  new_len 
)
related

Resize the client_user_id_history array of a ua_sessionsecuritydiagnosticsdatatype struct.

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_lenNew length of the client_user_id_history array in number of members.
Returns
Zero on success or ua_statuscode on failure.

Field Documentation

authentication_mechanism

Type of authentication currently used by the session.

The string shall be one of the UserIdentityTokenType enum.

client_user_id_history

Array containing the name of the authenticated user currently active (either from creating the session or from calling the ActivateSession Service) and the history of those names.

Each time the active user changes, an entry shall be made at the end of the array. The active user is always at the end of the array. Servers may restrict the size of this array, but shall support at least a size of 2.

encoding

Which encoding is used on the wire.

The string shall be “XML” or “UA Binary”.

transport_protocol

Which transport protocol is used.

The string shall be the scheme from the URL used to establish the session, for example “opc.tcp” or “https”.


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