UaServerSession

Data Structures
struct	UaServer_PublicSession
	Public Session. More...

Functions
OpcUa_UInt32	UaServer_Session_GetSecureChannelId (UaServer_PublicSession *a_pSession)
	Get the id of the current secure channel that is used for the given session. More...
OpcUa_StatusCode	UaServer_Session_GetClientName (UaServer_PublicSession *a_pSession, OpcUa_String *a_pClientName)
	Get the ClientName of the session. More...
OpcUa_DateTime	UaServer_Session_GetLastClientContact (UaServer_PublicSession *a_pSession)
	Get the timestamp of the last time the client used the session. More...
OpcUa_Boolean	UaServer_Session_IsEncrypted (UaServer_PublicSession *a_pSession)
	Checks if the session is encrypted. More...
OpcUa_Boolean	UaServer_Session_IsSigned (UaServer_PublicSession *a_pSession)
	Checks if the session is signed. More...
OpcUa_StatusCode	UaServer_Session_SetCurrentClientUserId (UaServer_PublicSession *a_pSession, OpcUa_String *a_pClientUserId)
	Set the current ClientUserId of the session. More...
OpcUa_UInt32	UaServer_Session_GetFileHandle (UaServer_PublicSession *a_pSession)
	Get a session-unique file handle. More...
OpcUa_StatusCode	UaServer_Session_Disconnect (UaServer_PublicSession *a_pSession)
	Close and disconnect an existing session. More...

Detailed Description

Function Documentation

OpcUa_StatusCode UaServer_Session_Disconnect

(

UaServer_PublicSession *

a_pSession

)

Close and disconnect an existing session.

The SecureChannel the session is using will also get closed if no other sessions are using it.

Parameters

a_pSession

A pointer to the session.

Returns

OpcUa_Good on success.

OpcUa_StatusCode UaServer_Session_GetClientName	(	UaServer_PublicSession *	a_pSession,
		OpcUa_String *	a_pClientName
	)

Get the ClientName of the session.

This function was introduced in version 1.2.1.

Parameters

a_pSession	a pointer to the actual session.
a_pClientName	the name of the client of the current session will be stored here.

Returns

OpcUa_Good on success.

OpcUa_UInt32 UaServer_Session_GetFileHandle

(

UaServer_PublicSession *

a_pSession

)

Get a session-unique file handle.

Parameters

a_pSession

A pointer to the session.

Returns

A session-unique file handle.

OpcUa_DateTime UaServer_Session_GetLastClientContact

(

UaServer_PublicSession *

a_pSession

)

Get the timestamp of the last time the client used the session.

This function was introduced in version 1.2.1.

Parameters

a_pSession

A pointer to the session.

Returns

The timestamp of last usage.

OpcUa_UInt32 UaServer_Session_GetSecureChannelId

(

UaServer_PublicSession *

a_pSession

)

Get the id of the current secure channel that is used for the given session.

Parameters

a_pSession

a pointer to the actual session.

Returns

the Id of the current secure channel.

OpcUa_Boolean UaServer_Session_IsEncrypted

(

UaServer_PublicSession *

a_pSession

)

Checks if the session is encrypted.

This function was introduced in version 1.3.0.

Parameters

a_pSession

A pointer to the session.

Returns

OpcUa_True if the SecureChannel is used with Sign&Encrypt.

OpcUa_Boolean UaServer_Session_IsSigned

(

UaServer_PublicSession *

a_pSession

)

Checks if the session is signed.

This function was introduced in version 1.3.0.

Parameters

a_pSession

A pointer to the session.

Returns

OpcUa_True if the SecureChannel is used with Sign or Sign&Encrypt.

OpcUa_StatusCode UaServer_Session_SetCurrentClientUserId	(	UaServer_PublicSession *	a_pSession,
		OpcUa_String *	a_pClientUserId
	)

Set the current ClientUserId of the session.

This function is to be used only by authentication modules.

Parameters

a_pSession	A pointer to the session.
a_pClientUserId	The new ClientUserId to set.

Returns

OpcUa_Good on success.