Data Structures
struct	_UaServer_SessionManager
	Holds all data needed to manage the sessions in an ua server. More...

Functions
OpcUa_StatusCode	UaServer_SessionManager_CreateSessionNode (UaServer_Session a_pSession, OpcUa_CreateSessionRequest a_pCreateSessionRequest, OpcUa_CreateSessionResponse *a_pCreateSessionResponse, OpcUa_Endpoint a_hEndpoint, OpcUa_Handle a_hContext)
	Create a NodeId associated with the session.
OpcUa_StatusCode	UaServer_SessionManager_DeleteSessionNode (UaServer_Session *a_pSession)
	Deletes the NodeId associated with the session.
OpcUa_StatusCode	UaServer_Fill_ApplicationDescription (UaServer a_pUaServer, OpcUa_ApplicationDescription a_pApplicationDescriptions)
	This function fills out the complete description of the application.
OpcUa_StatusCode	UaServer_Fill_Endpoints (UaServer a_pUaServer, OpcUa_Int32 a_iNoOfProfileUris, OpcUa_String a_ProfileUris, OpcUa_UInt32 a_piNoOfEndpointDescriptions, OpcUa_EndpointDescription *a_ppEndpointDescriptions)
	This function fill the endpoints.
OpcUa_StatusCode	UaServer_Fill_Servers (UaServer a_pUaServer, OpcUa_Int32 a_iNoOfLocaleIds, OpcUa_String a_LocaleIds, OpcUa_Int32 a_iNoOfServerUris, OpcUa_String a_ServerUris, OpcUa_UInt32 a_piNoOfServers, OpcUa_ApplicationDescription **a_ppServers)
	This function fills the server descriptions.
OpcUa_StatusCode	UaServer_SessionManager_BeginFindServers (OpcUa_Endpoint a_hEndpoint, OpcUa_Handle a_hContext, OpcUa_Void *a_ppRequest, OpcUa_EncodeableType a_pRequestType)
	A service function to find the server.
OpcUa_StatusCode	UaServer_SessionManager_BeginGetEndpoints (OpcUa_Endpoint a_hEndpoint, OpcUa_Handle a_hContext, OpcUa_Void *a_ppRequest, OpcUa_EncodeableType a_pRequestType)
	A service function to gett all available endpoints.
OpcUa_StatusCode	UaServer_SessionManager_Create (UaServer_SessionManager **a_ppSessionManager)
	This function creates a new session.
OpcUa_Void	UaServer_SessionManager_Delete (UaServer_SessionManager **a_ppSessionManager)
	This function deletes all sessions.
UaServer_Session *	UaServer_SessionManager_GetSession (UaServer_SessionManager *pSessionManager, OpcUa_UInt32 a_SessionId, OpcUa_Boolean a_UpdateSession)
	Get the actual Session.
OpcUa_Void	UaServer_SessionManager_Purge (UaServer_SessionManager *pSessionManager)
	Purges the Session.
OpcUa_StatusCode	UaServer_SessionManager_BeginCreateSession (OpcUa_Endpoint a_hEndpoint, OpcUa_Handle a_hContext, OpcUa_Void *a_ppRequest, OpcUa_EncodeableType a_pRequestType)
	Starts to create a new Session.
OpcUa_StatusCode	UaServer_SessionManager_BeginActivateSession (OpcUa_Endpoint a_hEndpoint, OpcUa_Handle a_hContext, OpcUa_Void *a_ppRequest, OpcUa_EncodeableType a_pRequestType)
	Starts to activate a new Session.
OpcUa_StatusCode	UaServer_SessionManager_BeginCloseSession (OpcUa_Endpoint a_hEndpoint, OpcUa_Handle a_hContext, OpcUa_Void *a_ppRequest, OpcUa_EncodeableType a_pRequestType)
	Begins to close an available Session.
OpcUa_StatusCode	UaServer_SessionManager_BeginCancel (OpcUa_Endpoint a_hEndpoint, OpcUa_Handle a_hContext, OpcUa_Void *a_ppRequest, OpcUa_EncodeableType a_pRequestType)
	Begins to cancel an outstanding request.

Detailed Description

Function Documentation

OpcUa_StatusCode UaServer_Fill_ApplicationDescription	(	UaServer *	a_pUaServer,
		OpcUa_ApplicationDescription *	a_pApplicationDescriptions
	)

This function fills out the complete description of the application.

Parameters

a_pUaServer	a pointer to the Server.
a_pApplicationDescriptions	a struct of the complete application description.

Returns: the OPC UA Status code.

OpcUa_StatusCode UaServer_Fill_Endpoints	(	UaServer *	a_pUaServer,
		OpcUa_Int32	a_iNoOfProfileUris,
		OpcUa_String *	a_ProfileUris,
		OpcUa_UInt32 *	a_piNoOfEndpointDescriptions,
		OpcUa_EndpointDescription **	a_ppEndpointDescriptions
	)

This function fill the endpoints.

Parameters

a_pUaServer	a pointer to the Server.
a_iNoOfProfileUris	the number of transport profile URIs. if the endpoint list shall not be filtered, set this parameter to 0.
a_ProfileUris	the transport profile URIs to be applied as filter on the endpoint list. if the endpoint list shall not be filtered, set this parameter to OpcUa_Null.
a_piNoOfEndpointDescriptions	the counted number of endpoint descriptions.
a_ppEndpointDescriptions	the description of the endpoints itself.

Returns: the OPC UA Status code.

OpcUa_StatusCode UaServer_Fill_Servers	(	UaServer *	a_pUaServer,
		OpcUa_Int32	a_iNoOfLocaleIds,
		OpcUa_String *	a_LocaleIds,
		OpcUa_Int32	a_iNoOfServerUris,
		OpcUa_String *	a_ServerUris,
		OpcUa_UInt32 *	a_piNoOfServers,
		OpcUa_ApplicationDescription **	a_ppServers
	)

This function fills the server descriptions.

Parameters

[in]	a_pUaServer	a pointer to the Server.
[in]	a_iNoOfLocaleIds	the number of locale ids. if the server list shall not be filtered, set this parameter to 0.
[in]	a_LocaleIds	the locale ids to be applied as filter on the server list. if the server list shall not be filtered, set this parameter to OpcUa_Null.
[in]	a_iNoOfServerUris	the number of server URIs. if the server list shall not be filtered, set this parameter to 0.
[in]	a_ServerUris	the server URIs to be applied as filter on the server list. if the server list shall not be filtered, set this parameter to OpcUa_Null.
[in]	a_piNoOfServers	the counted number of server descriptions.
[out]	a_ppServers	the description of the servers itself.

Returns: the OPC UA Status code.

OpcUa_StatusCode UaServer_SessionManager_BeginActivateSession	(	OpcUa_Endpoint	a_hEndpoint,
		OpcUa_Handle	a_hContext,
		OpcUa_Void **	a_ppRequest,
		OpcUa_EncodeableType *	a_pRequestType
	)

Starts to activate a new Session.

Parameters

a_hEndpoint	handle to the endpoint.
a_hContext	General context containing information like the session object.
a_ppRequest	the request of the current send information.
a_pRequestType	[in] The type of request.

Returns: the OPC UA Status code.

OpcUa_StatusCode UaServer_SessionManager_BeginCancel	(	OpcUa_Endpoint	a_hEndpoint,
		OpcUa_Handle	a_hContext,
		OpcUa_Void **	a_ppRequest,
		OpcUa_EncodeableType *	a_pRequestType
	)

Begins to cancel an outstanding request.

Parameters

a_hEndpoint	handle to the endpoint.
a_hContext	General context containing information like the session object.
a_ppRequest	the request of the current send information.
a_pRequestType	[in] The type of request.

Returns: the OPC UA Status code.

OpcUa_StatusCode UaServer_SessionManager_BeginCloseSession	(	OpcUa_Endpoint	a_hEndpoint,
		OpcUa_Handle	a_hContext,
		OpcUa_Void **	a_ppRequest,
		OpcUa_EncodeableType *	a_pRequestType
	)

Begins to close an available Session.

Parameters

a_hEndpoint	handle to the endpoint.
a_hContext	General context containing information like the session object.
a_ppRequest	the request of the current send information.
a_pRequestType	[in] The type of request.

Returns: the OPC UA Status code.

OpcUa_StatusCode UaServer_SessionManager_BeginCreateSession	(	OpcUa_Endpoint	a_hEndpoint,
		OpcUa_Handle	a_hContext,
		OpcUa_Void **	a_ppRequest,
		OpcUa_EncodeableType *	a_pRequestType
	)

Starts to create a new Session.

Parameters

a_hEndpoint	handle to the endpoint.
a_hContext	General context containing information like the session object.
a_ppRequest	the request of the current send information.
a_pRequestType	[in] The type of request.

Returns: the OPC UA Status code.

OpcUa_StatusCode UaServer_SessionManager_BeginFindServers	(	OpcUa_Endpoint	a_hEndpoint,
		OpcUa_Handle	a_hContext,
		OpcUa_Void **	a_ppRequest,
		OpcUa_EncodeableType *	a_pRequestType
	)

A service function to find the server.

Parameters

a_hEndpoint	handle to the endpoint.
a_hContext	General context containing information like the session object.
a_ppRequest	the request of the current send information.
a_pRequestType	[in] The type of request.

Returns: the OPC UA Status code.

OpcUa_StatusCode UaServer_SessionManager_BeginGetEndpoints	(	OpcUa_Endpoint	a_hEndpoint,
		OpcUa_Handle	a_hContext,
		OpcUa_Void **	a_ppRequest,
		OpcUa_EncodeableType *	a_pRequestType
	)

A service function to gett all available endpoints.

Parameters

a_hEndpoint	handle to the endpoint.
a_hContext	General context containing information like the session object.
a_ppRequest	the request of the current send information.
a_pRequestType	[in] The type of request.

Returns: the OPC UA Status code.

OpcUa_StatusCode UaServer_SessionManager_Create ( UaServer_SessionManager ** a_ppSessionManager )

This function creates a new session.

Parameters

a_ppSessionManager a pointer to the actual sessionmanager.

Returns: the OPC UA Status code.

OpcUa_StatusCode UaServer_SessionManager_CreateSessionNode	(	UaServer_Session *	a_pSession,
		OpcUa_CreateSessionRequest *	a_pCreateSessionRequest,
		OpcUa_CreateSessionResponse *	a_pCreateSessionResponse,
		OpcUa_Endpoint	a_hEndpoint,
		OpcUa_Handle	a_hContext
	)

Create a NodeId associated with the session.

Parameters

a_pSession	the session.
a_pCreateSessionRequest	the request that creates the session.
a_pCreateSessionResponse	the response to the CreateSessionRequest.
a_hEndpoint	the endpoint associated with the session.
a_hContext	the context handle of the CreateSession call.

Returns: the OPC UA Status code.

OpcUa_Void UaServer_SessionManager_Delete ( UaServer_SessionManager ** a_ppSessionManager )

This function deletes all sessions.

Parameters

a_ppSessionManager a pointer to the actual sessionmanager.

OpcUa_StatusCode UaServer_SessionManager_DeleteSessionNode ( UaServer_Session * a_pSession )

Deletes the NodeId associated with the session.

Parameters

a_pSession the session.

Returns: the OPC UA Status code.

UaServer_Session * UaServer_SessionManager_GetSession	(	UaServer_SessionManager *	pSessionManager,
		OpcUa_UInt32	a_SessionId,
		OpcUa_Boolean	a_UpdateSession
	)

Get the actual Session.

Parameters

pSessionManager	a pointer to the actual sessionmanager.
a_SessionId	Server unique number that identifies the session.
a_UpdateSession	Indicates if the timeout of the returned session should be updated.

Returns: Corresponding session for passed session ID

OpcUa_Void UaServer_SessionManager_Purge ( UaServer_SessionManager * pSessionManager )

Purges the Session.

Parameters

pSessionManager a pointer to the actual sessionmanager.

Data Structures

Functions

Detailed Description

Function Documentation