UA Ansi C Server Professional  1.3.1.232
 All Data Structures Functions Variables Typedefs Enumerations Enumerator Groups Pages
UaServerSubscriptionManager

Data Structures

struct  _UaServer_SubscriptionManager
 A UaServer SubscriptionManager struct. More...

Functions

OpcUa_Void UaServer_SubscriptionManager_PublishCallback ()
 DoSubscription is called from Timer.
OpcUa_StatusCode UaServer_SubscriptionManager_TimerCallback (OpcUa_Void *a_pvCallbackData, OpcUa_Timer a_hTimer, OpcUa_UInt32 a_msecElapsed)
 A callback function for the timer.
OpcUa_StatusCode UaServer_SubscriptionManager_TimerStoppedCallback (OpcUa_Void *a_pvCallbackData, OpcUa_Timer a_hTimer, OpcUa_UInt32 a_msecElapsed)
 A callback function for the timer.
OpcUa_StatusCode UaServer_SubscriptionManager_InitSubscriptionTimer ()
 Initialising Subscription.
OpcUa_Void UaServer_SubscriptionManager_CleanupSubscriptionTimer ()
 Cleans up everything InitSubscriptionTimer has initialized.
OpcUa_Void UaServer_SubscriptionManager_LockList ()
 Locks the access to g_SubscriptionLists.
OpcUa_Void UaServer_SubscriptionManager_UnlockList ()
 Unlocks the access to g_SubscriptionLists.
OpcUa_StatusCode UaServer_SubscriptionManager_AddSubscriptionToSortedList (UaServer_Subscription *pSubscription)
 Adds subscription to sorted sampling list.
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_Create (UaServer_SubscriptionManager **a_ppSubscriptionManager, OpcUa_UInt32 a_uMinPublishRate)
 Create A New Subscription Manager.
OpcUa_StatusCode UaServer_SubscriptionManager_Delete (UaServer_SubscriptionManager **a_ppSubscriptionManager)
 Delete A Subscription Manager.
OpcUa_StatusCode UaServer_SubscriptionManager_AddSubscription (UaServer_SubscriptionManager *a_pSubscriptionManager, UaServer_Subscription *a_pSubscription)
 Add A Subscription To A Subscription Manager.
OpcUa_StatusCode UaServer_SubscriptionManager_DeleteSubscription (UaServer_SubscriptionManager *a_pSubscriptionManager, OpcUa_UInt32 a_uSubscriptionId)
 Delete A Subscription From A Subscription Manager.
OpcUa_StatusCode UaServer_SubscriptionManager_FindSubscription (UaServer_SubscriptionManager *a_pSubscriptionManager, UaServer_Subscription **a_ppSubscription, OpcUa_UInt32 a_uSubscriptionId)
 Find A Subscription From A Subscription Manager.
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.

Detailed Description

Function Documentation

OpcUa_StatusCode UaServer_SubscriptionManager_AddSubscription ( UaServer_SubscriptionManager a_pSubscriptionManager,
UaServer_Subscription a_pSubscription 
)

Add A Subscription To A Subscription Manager.

Parameters
a_pSubscriptionManagera pointer to the actual subscription manager.
a_pSubscriptiona pointer to the subscription.
Returns
the OPC UA Status code.
OpcUa_StatusCode UaServer_SubscriptionManager_AddSubscriptionToSortedList ( UaServer_Subscription pSubscription)

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
pSubscriptionthe actual subscription.
Returns
the OPC UA Status code.
OpcUa_Void UaServer_SubscriptionManager_CleanupSubscriptionTimer ( )

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_ppSubscriptionManagera pointer to the actual subscription manager.
a_uMinPublishRatethe minimum publish rate.
Returns
the OPC UA Status code.
OpcUa_StatusCode UaServer_SubscriptionManager_Delete ( UaServer_SubscriptionManager **  a_ppSubscriptionManager)

Delete A Subscription Manager.

Parameters
a_ppSubscriptionManagera 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
pSessiona pointer to the actual session.
Returns
the OPC UA Status code.
OpcUa_StatusCode UaServer_SubscriptionManager_DeleteSubscription ( UaServer_SubscriptionManager a_pSubscriptionManager,
OpcUa_UInt32  a_uSubscriptionId 
)

Delete A Subscription From A Subscription Manager.

Parameters
a_pSubscriptionManagera pointer to the actual subscription manager.
a_uSubscriptionIdthe 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_UInt32  a_uSubscriptionId 
)

Find A Subscription From A Subscription Manager.

Parameters
a_pSubscriptionManagera pointer to the actual subscription manager.
a_ppSubscriptiona pointer to the subscription structure.
a_uSubscriptionIdthe actual id of the subscription.
Returns
the OPC UA Status code.
OpcUa_StatusCode UaServer_SubscriptionManager_InitSubscriptionTimer ( )

Initialising Subscription.

This functions sets up configured sampling rates and system timer.

Returns
OPC UA Status code.
OpcUa_Void UaServer_SubscriptionManager_PublishCallback ( )

DoSubscription is called from Timer.

It decrements the counters for the different sampling rates and does the actual subscription handling if one has expired.

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
pSubscriptionthe actual subscription.
OpcUa_StatusCode UaServer_SubscriptionManager_TimerCallback ( OpcUa_Void *  a_pvCallbackData,
OpcUa_Timer  a_hTimer,
OpcUa_UInt32  a_msecElapsed 
)

A callback function for the timer.

Parameters
a_pvCallbackDatathe actual callback data.
a_hTimerthe value of the timer.
a_msecElapsedthe elapsed msec for this operation.
Returns
the OPC UA Status code.
OpcUa_StatusCode UaServer_SubscriptionManager_TimerStoppedCallback ( OpcUa_Void *  a_pvCallbackData,
OpcUa_Timer  a_hTimer,
OpcUa_UInt32  a_msecElapsed 
)

A callback function for the timer.

Parameters
a_pvCallbackDatathe actual callback data.
a_hTimerthe value of the timer.
a_msecElapsedthe elapsed msec for this operation.
Returns
the OPC UA Status code.
OpcUa_StatusCode UaServer_SubscriptionManager_UnlinkAllSubscriptionsBySession ( UaServer_Session *  pSession)

Remove handles to a given session handles from all subscriptions.

Parameters
pSessiona pointer to the actual session.
Returns
the OPC UA Status code.