UaServerSession

Data Structures
struct	_UaServer_PublicSession
	Public Session. More...

Functions
OpcUa_StatusCode	UaServer_Session_Create (UaServer_Session **a_ppSession, OpcUa_Int32 a_SessionId, OpcUa_String *a_psClientName, OpcUa_Int32 a_SessionTimeout)
	Create a new Session.
OpcUa_Void	UaServer_Session_Delete (UaServer_Session **a_ppSession)
	Delete the current Session.
OpcUa_StatusCode	UaServer_Session_Activate (UaServer_Session *a_pSession)
	Activate the current Session.
OpcUa_StatusCode	UaServer_Session_Close (UaServer_Session *a_pSession)
	Close the current Session.
OpcUa_Void	UaServer_Session_ResetTimeout (UaServer_Session *a_pSession)
	Reset the Timeout of the current Session.
OpcUa_Boolean	UaServer_Session_HasExpired (UaServer_Session *a_pSession)
	Check whether the Session has expired or not.
OpcUa_Boolean	UaServer_Session_IsValid (UaServer_Session *a_pSession)
	Check whether the Session is valid or not not.
OpcUa_Boolean	UaServer_Session_MustDelete (UaServer_Session *a_pSession)
	Deletes the Session if the Session has expired.
OpcUa_UInt32	UaServer_Session_GetSessionId (UaServer_Session *a_pSession)
	Get the Id of the actual Session.
OpcUa_StatusCode	UaServer_Session_GetClientName (UaServer_PublicSession *a_pSession, OpcUa_String *a_pClientName)
	Get the ClientName of the session.
OpcUa_DateTime	UaServer_Session_GetLastClientContact (UaServer_PublicSession *a_pSession)
	Get the timestamp of the last time the client used the session.
OpcUa_Boolean	UaServer_Session_IsEncrypted (UaServer_PublicSession *a_pSession)
	Checks if the session is encrypted.
OpcUa_Boolean	UaServer_Session_IsSigned (UaServer_PublicSession *a_pSession)
	Checks if the session is signed.
UaServer_TurboList *	UaServer_Session_GetContinuationPoints (UaServer_PublicSession *a_pSession)
	Get the list of currently active browse continuation points.

Detailed Description

Function Documentation

OpcUa_StatusCode UaServer_Session_Activate

(

UaServer_Session *

a_pSession

)

Activate the current Session.

Parameters

a_pSession

a pointer to the actual session.

Returns

the OPC UA Status code.

OpcUa_StatusCode UaServer_Session_Close

(

UaServer_Session *

a_pSession

)

Close the current Session.

Parameters

a_pSession

a pointer to the actual session.

Returns

the OPC UA Status code.

OpcUa_StatusCode UaServer_Session_Create	(	UaServer_Session **	a_ppSession,
		OpcUa_Int32	a_SessionId,
		OpcUa_String *	a_psClientName,
		OpcUa_Int32	a_SessionTimeout
	)

Create a new Session.

Parameters

a_ppSession	a pointer to the actual session.
a_SessionId	the actual session id.
a_psClientName	the name of the actual Client.
a_SessionTimeout	a value when the session expires.

Returns

the OPC UA Status code.

OpcUa_Void UaServer_Session_Delete

(

UaServer_Session **

a_ppSession

)

Delete the current Session.

Parameters

a_ppSession

a pointer to the actual session.

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.

UaServer_TurboList * UaServer_Session_GetContinuationPoints

(

UaServer_PublicSession *

a_pSession

)

Get the list of currently active browse continuation points.

This function was introduced in version 1.3.1.

Parameters

a_pSession

A pointer to the session.

Returns

The list of currently active browse continuation points.

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_GetSessionId

(

UaServer_Session *

a_pSession

)

Get the Id of the actual Session.

Parameters

a_pSession

a pointer to the actual session.

Returns

the Id of the current Session.

OpcUa_Boolean UaServer_Session_HasExpired

(

UaServer_Session *

a_pSession

)

Check whether the Session has expired or not.

Parameters

a_pSession

A pointer to the session.

Returns

True if the Session has expired, false if not.

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_Boolean UaServer_Session_IsValid

(

UaServer_Session *

a_pSession

)

Check whether the Session is valid or not not.

Parameters

a_pSession

A pointer to the session.

Returns

True if the Session is valid, false if not.

OpcUa_Boolean UaServer_Session_MustDelete

(

UaServer_Session *

a_pSession

)

Deletes the Session if the Session has expired.

Parameters

a_pSession

a pointer to the actual session.

Returns

True if the Session has to be deleted False if not.

OpcUa_Void UaServer_Session_ResetTimeout

(

UaServer_Session *

a_pSession

)

Reset the Timeout of the current Session.

Parameters

a_pSession

a pointer to the actual session.