UaServerMonitoredItemManager

Functions
OpcUa_Void	UaServer_MonitoredItem_Clear (UaServer_MonitoredItem *a_pMonitoredItem)
	Clears the monitored item.
OpcUa_StatusCode	UaServer_MonitoredItemManager_TimerStoppedCallback (OpcUa_Void *a_pvCallbackData, OpcUa_Timer a_hTimer, OpcUa_UInt32 a_msecElapsed)
	A callback function for the timer.
OpcUa_StatusCode	UaServer_MonitoredItemManager_Initialize ()
	Initialising Sampling.
OpcUa_Void	UaServer_MonitoredItemManager_Cleanup ()
	Cleans up everything InitSampling has initialized.
OpcUa_StatusCode	UaServer_Providers_ItemChanged (UaServer_MonitoredItem *a_pMonitoredItem)
	Informs if an item has changed.
OpcUa_StatusCode	UaServer_Providers_NewItemValue (UaServer_MonitoredItemData *a_pMonitoredItemData, OpcUa_DataValue *a_pValue)
	Informs about the current value of the monitored item.
OpcUa_StatusCode	UaServer_MonitoredItemManager_AddMonitoredItem (UaServer_Subscription *a_pSubscription, UaServer_MonitoredItem *a_pMonitoredItem)
	Adds item that should be sampled.
UaServer_MonitoredItem *	UaServer_MonitoredItemManager_FindMonitoredItem (OpcUa_UInt32 a_uServerHandle, UaServer_Subscription *a_pSubscription)
	Find a monitored item based on server handle and subscription.
OpcUa_StatusCode	UaServer_MonitoredItemManager_RemoveMonitoredItem (OpcUa_UInt32 a_uServerHandle, UaServer_Subscription *a_pSubscription, UaServer_MonitoredItem **a_ppRet)
	Removes the item from the according sampling list.
OpcUa_Void	UaServer_MonitoredItemManager_LockList ()
	Locks the access to g_SamplingLists.
OpcUa_Void	UaServer_MonitoredItemManager_UnlockList ()
	Unlocks the access to g_SamplingLists.
UaServer_TurboList *	UaServer_MonitoredItemManager_GetList (UaServer_Subscription *a_pSubscription)
	Get the list with all monitored items.

Detailed Description

Function Documentation

OpcUa_Void UaServer_MonitoredItem_Clear

(

UaServer_MonitoredItem *

a_pMonitoredItem

)

Clears the monitored item.

Parameters

a_pMonitoredItem

a pointer to a monitored item.

OpcUa_StatusCode UaServer_MonitoredItemManager_AddMonitoredItem	(	UaServer_Subscription *	a_pSubscription,
		UaServer_MonitoredItem *	a_pMonitoredItem
	)

Adds item that should be sampled.

This functions sorts the item into the according sampling lists. You should lock the list before using this function with UaServer_Sampling_LockList.

Parameters

a_pSubscription	a pointer to the subscription structure.
a_pMonitoredItem	a pointer to the monitored item.

Returns

the OPC UA Status code.

OpcUa_Void UaServer_MonitoredItemManager_Cleanup

(

)

Cleans up everything InitSampling has initialized.

What else?

UaServer_MonitoredItem* UaServer_MonitoredItemManager_FindMonitoredItem	(	OpcUa_UInt32	a_uServerHandle,
		UaServer_Subscription *	a_pSubscription
	)

Find a monitored item based on server handle and subscription.

Parameters

a_uServerHandle	a handle to the server.
a_pSubscription	a pointer to the subscription structure.

Returns

a monitored item based on server handle and subscription.

UaServer_TurboList* UaServer_MonitoredItemManager_GetList

(

UaServer_Subscription *

a_pSubscription

)

Get the list with all monitored items.

Parameters

a_pSubscription

a pointer to the subscription structure.

Returns

the monitored items.

OpcUa_StatusCode UaServer_MonitoredItemManager_Initialize

(

)

Initialising Sampling.

This functions sets up configured sampling rates and system timer.

Returns

the OPC UA Status code.

OpcUa_StatusCode UaServer_MonitoredItemManager_RemoveMonitoredItem	(	OpcUa_UInt32	a_uServerHandle,
		UaServer_Subscription *	a_pSubscription,
		UaServer_MonitoredItem **	a_ppRet
	)

Removes the item from the according sampling list.

Parameters

a_uServerHandle	a handle to the server.
a_pSubscription	a pointer to the subscription structure.
a_ppRet	a pointer to the return of the monitored item which will be removed.

Returns

the OPC UA Status code.

OpcUa_StatusCode UaServer_MonitoredItemManager_TimerStoppedCallback	(	OpcUa_Void *	a_pvCallbackData,
		OpcUa_Timer	a_hTimer,
		OpcUa_UInt32	a_msecElapsed
	)

A callback function for the timer.

Parameters

a_pvCallbackData	the actual callback data.
a_hTimer	the value of the timer.
a_msecElapsed	the elapsed msec for this operation.

Returns

the OPC UA Status code. A callback function for the timer which indicates if the timer stopped or not.

Parameters

a_pvCallbackData	the actual callback data.
a_hTimer	the value of the timer.
a_msecElapsed	the elapsed msec for this operation.

Returns

the OPC UA Status code.

OpcUa_StatusCode UaServer_Providers_ItemChanged

(

UaServer_MonitoredItem *

a_pMonitoredItem

)

Informs if an item has changed.

Parameters

a_pMonitoredItem

The item which has changed.

Returns

OpcUa_Good on success.

OpcUa_StatusCode UaServer_Providers_NewItemValue	(	UaServer_MonitoredItemData *	a_pMonitoredItemData,
		OpcUa_DataValue *	a_pValue
	)

Informs about the current value of the monitored item.

The SDK does the data change detection and informs the subscription about changed data if necessary.

This function was introduced in V1.3.0.

Parameters

a_pMonitoredItemData	The item which has changed.
a_pValue	The current value of the item. The SDK takes the ownership of this argument and will free it if it's not longer needed.

Returns

OpcUa_Good on success.