UaServerSessionManager

Data Structures
struct	_UaServer_SessionManager
	Holds all data needed to manage the sessions in an ua server. More...
struct	_UaServer_SubscriptionManager
	A UaServer SubscriptionManager Struct. More...
Functions
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_UInt32 *a_piNoOfEndpointDescriptions, OpcUa_EndpointDescription **a_ppEndpointDescriptions)
	This function fill the endpoints.
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_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_SubscriptionManager_Create (UaServer_SubscriptionManager **ppSubscriptionManager, OpcUa_UInt32 uMinPublishRate)
	Create A New Subscription Manager.
OpcUa_StatusCode	UaServer_SubscriptionManager_Delete (UaServer_SubscriptionManager **ppSubscriptionManager)
	Delete A Subscription Manager.
OpcUa_StatusCode	UaServer_SubscriptionManager_AddSubscription (UaServer_SubscriptionManager *pSubscriptionManager, UaServer_Subscription *pSubscription)
	Add A Subscription To A Subscription Manager.
OpcUa_StatusCode	UaServer_SubscriptionManager_DeleteSubscription (UaServer_SubscriptionManager *pSubscriptionManager, OpcUa_Int32 iSubscriptionId)
	Delete A Subscription From A Subscription Manager.
OpcUa_StatusCode	UaServer_SubscriptionManager_FindSubscription (UaServer_SubscriptionManager *pSubscriptionManager, UaServer_Subscription **ppSubscription, OpcUa_Int32 iSubscriptionId)
	Find A Subscription From A Subscription Manager.
OpcUa_StatusCode	UaServer_SubscriptionManager_AddSubscriptionToSortedList (UaServer_Subscription *pSubscription)
	Locks the access to g_SubscriptionLists.
OpcUa_Void	UaServer_SubscriptionManager_RemoveSubscriptionFromSortedList (UaServer_Subscription *pSubscription)
	Removes the subscription from the according sampling list You should lock the list before using this function with LockSubscriptionList.
OpcUa_StatusCode	UaServer_SubscriptionManager_DeleteAllSubscriptionsBySession (UaServer_Session *pSession)
	Delete all subscriptions, that belong to the given session.
OpcUa_StatusCode	UaServer_SubscriptionManager_UnlinkAllSubscriptionsBySession (UaServer_Session *pSession)
	Remove handles to a given session handles from all subscriptions.
OpcUa_StatusCode	UaServer_SubscriptionManager_InitSubscriptionTimer (OpcUa_Void)
	Initialising Subscription.
OpcUa_Void	UaServer_SubscriptionManager_CleanupSubscriptionTimer (OpcUa_Void)
	Cleans up everything InitSubscriptionTimer has initialized.

---

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_UInt32 *	a_piNoOfEndpointDescriptions,
		OpcUa_EndpointDescription **	a_ppEndpointDescriptions
	)

This function fill the endpoints.

Parameters:

	a_pUaServer	a pointer to the Server.
	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_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_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.

create server signature

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_Void UaServer_SessionManager_Delete

(

UaServer_SessionManager **

a_ppSessionManager

)

This function deletes all sessions.

Parameters:

a_ppSessionManager

a pointer to the actual sessionmanager.

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_StatusCode UaServer_SubscriptionManager_AddSubscription	(	UaServer_SubscriptionManager *	a_pSubscriptionManager,
		UaServer_Subscription *	a_pSubscription
	)

Add A Subscription To A Subscription Manager.

Parameters:

	a_pSubscriptionManager	a pointer to the actual subscription manager.
	a_pSubscription	a pointer to the subscription.

Returns:

the OPC UA Status code.

OpcUa_StatusCode UaServer_SubscriptionManager_AddSubscriptionToSortedList

(

UaServer_Subscription *

pSubscription

)

Locks the access to g_SubscriptionLists.

Unlocks the access to g_SubscriptionLists Adds subscription to sorted sampling list. This functions sorts the item into the according sampling lists. You should lock the list before using this function with LockSubscriptionList.

Parameters:

pSubscription

the actual subscription.

Returns:

the OPC UA Status code.

OpcUa_Void UaServer_SubscriptionManager_CleanupSubscriptionTimer

(

OpcUa_Void

)

Cleans up everything InitSubscriptionTimer has initialized.

What else?

OpcUa_StatusCode UaServer_SubscriptionManager_Create	(	UaServer_SubscriptionManager **	a_ppSubscriptionManager,
		OpcUa_UInt32	a_uMinPublishRate
	)

Create A New Subscription Manager.

Parameters:

	a_ppSubscriptionManager	a pointer to the actual subscription manager.
	a_uMinPublishRate	the minimum publish rate.

Returns:

the OPC UA Status code.

OpcUa_StatusCode UaServer_SubscriptionManager_Delete

(

UaServer_SubscriptionManager **

a_ppSubscriptionManager

)

Delete A Subscription Manager.

Parameters:

a_ppSubscriptionManager

a pointer to the actual subscription manager.

Returns:

the OPC UA Status code.

OpcUa_StatusCode UaServer_SubscriptionManager_DeleteAllSubscriptionsBySession

(

UaServer_Session *

pSession

)

Delete all subscriptions, that belong to the given session.

Parameters:

pSession

a pointer to the actual session.

Returns:

the OPC UA Status code.

OpcUa_StatusCode UaServer_SubscriptionManager_DeleteSubscription	(	UaServer_SubscriptionManager *	a_pSubscriptionManager,
		OpcUa_Int32	a_iSubscriptionId
	)

Delete A Subscription From A Subscription Manager.

Parameters:

	a_pSubscriptionManager	a pointer to the actual subscription manager.
	a_iSubscriptionId	the actual id of the subscription.

Returns:

the OPC UA Status code.

OpcUa_StatusCode UaServer_SubscriptionManager_FindSubscription	(	UaServer_SubscriptionManager *	a_pSubscriptionManager,
		UaServer_Subscription **	a_ppSubscription,
		OpcUa_Int32	a_iSubscriptionId
	)

Find A Subscription From A Subscription Manager.

Parameters:

	a_pSubscriptionManager	a pointer to the actual subscription manager.
	a_ppSubscription	a pointer to the subscription structure.
	a_iSubscriptionId	the actual id of the subscription.

Returns:

the OPC UA Status code.

OpcUa_StatusCode UaServer_SubscriptionManager_InitSubscriptionTimer

(

OpcUa_Void

)

Initialising Subscription.

This functions sets up configured sampling rates and system timer.

Returns:

OPC UA Status code.

OpcUa_Void UaServer_SubscriptionManager_RemoveSubscriptionFromSortedList

(

UaServer_Subscription *

pSubscription

)

Removes the subscription from the according sampling list You should lock the list before using this function with LockSubscriptionList.

Parameters:

pSubscription

the actual subscription.

OpcUa_StatusCode UaServer_SubscriptionManager_UnlinkAllSubscriptionsBySession

(

UaServer_Session *

pSession

)

Remove handles to a given session handles from all subscriptions.

Parameters:

pSession

a pointer to the actual session.

Returns:

the OPC UA Status code.