UaServerSession


Data Structures

struct  _UaServer_Session
 Holds all data needed to manage a session. More...
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 wether the Session has expired or not.
OpcUa_Boolean UaServer_Session_IsValid (UaServer_Session *a_pSession)
 Check wether 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.

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_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 wether the Session has expired or not.

Parameters:
a_pSession a pointer to the actual session.
Returns:
True if the Session has expired False if not.

OpcUa_Boolean UaServer_Session_IsValid ( UaServer_Session *  a_pSession  ) 

Check wether the Session is valid or not not.

Parameters:
a_pSession a pointer to the actual 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.