Data Structures
struct	_UaServer_SubscribeContext
	UaServer Subscribe Structure. More...
struct	_UaServer_CreateMonitoredItemsContext
	Holds all data to handle the CreateMonitoredItemsRequest. More...
struct	_UaServer_ModifyMonitoredItemsContext
	Holds all data to handle the ModifyMonitoredItemsRequest. More...
struct	_UaServer_DeleteMonitoredItemsContext
	Holds all data to handle the DeleteMonitoredItemsRequest. More...
struct	_UaServer_MonitoredItem
	A Monitored Item structure (Common) More...
struct	_UaServer_MonitoredItemData
	A Monitored Item structure (Data) More...
struct	_UaServer_MonitoredItemEvent
	A Monitored Item structure (Event) More...

Typedefs
typedef enum _MonitoredItemType	MonitoredItemType
	Typedef for the MonitoredItem types.

Enumerations
enum	_MonitoredItemType
	An enumeration of MonitoredItem types. More...

Functions
OpcUa_StatusCode	UaServer_CreateMonitoredItems (UaServer_CreateMonitoredItemsContext *a_pCreateMonitoredItemsContext)
	Creates monitored items.
OpcUa_StatusCode	UaServer_ModifyMonitoredItems (UaServer_ModifyMonitoredItemsContext *a_pModifyMonitoredItemsContext)
	Constructor.
OpcUa_StatusCode	UaServer_DeleteMonitoredItems (UaServer_DeleteMonitoredItemsContext *a_pDeleteMonitoredItemsContext)
	Deletes the monitored items.
OpcUa_StatusCode	UaServer_Providers_SubscribeComplete (UaServer_ProviderSubscribeContext *a_pCtx)
	A callback function which indicates if a subscribe was completed.
OpcUa_StatusCode	UaServer_DeleteMonitoredItemsContext_Create (UaServer_DeleteMonitoredItemsContext **a_ppDeleteMonitoredItemsContext)
	Create a new DeleteMonitoredItemsContext.
OpcUa_StatusCode	UaServer_EndDeleteMonitoredItems (OpcUa_StatusCode a_uStatusCode, UaServer_DeleteMonitoredItemsContext *a_pDeleteMonitoredItemsContext)
	Constructor.
OpcUa_Void	UaServer_DeleteMonitoredItemsContext_Delete (UaServer_DeleteMonitoredItemsContext **a_ppDeleteMonitoredItemsContext)
	Constructor.
OpcUa_StatusCode	UaServer_BeginDeleteMonitoredItems (OpcUa_Endpoint a_hEndpoint, OpcUa_Handle a_hContext, OpcUa_Void *a_ppRequest, OpcUa_EncodeableType a_pRequestType)
	Starts to delete monitored items.
OpcUa_StatusCode	UaServer_CreateMonitoredItemsContext_Create (UaServer_CreateMonitoredItemsContext **a_ppCreateMonitoredContext)
	Starts to create the monitored items context.
OpcUa_StatusCode	UaServer_EndCreateMonitoredItems (OpcUa_StatusCode a_uStatusCode, UaServer_CreateMonitoredItemsContext *a_pCreateMonitoredContext)
	Finishes the creation of monitored items.
OpcUa_Void	UaServer_CreateMonitoredItemsContext_Delete (UaServer_CreateMonitoredItemsContext **a_ppCreateMonitoredContext)
	ToDoDoc.
OpcUa_StatusCode	UaServer_BeginCreateMonitoredItems (OpcUa_Endpoint a_hEndpoint, OpcUa_Handle a_hContext, OpcUa_Void *a_ppRequest, OpcUa_EncodeableType a_pRequestType)
	Begins to create a monitored items context.
OpcUa_StatusCode	UaServer_ModifyMonitoredItemsContext_Create (UaServer_ModifyMonitoredItemsContext **a_ppModifyMonitoredContext)
	Starts to create the modify monitored items context.
OpcUa_StatusCode	UaServer_EndModifyMonitoredItems (OpcUa_StatusCode a_uStatusCode, UaServer_ModifyMonitoredItemsContext *a_pModifyMonitoredContext)
	Finishes the modifying of the monitored items.
OpcUa_Void	UaServer_ModifyMonitoredItemsContext_Delete (UaServer_ModifyMonitoredItemsContext **a_ppModifyMonitoredContext)
	ToDoDoc.
OpcUa_StatusCode	UaServer_BeginModifyMonitoredItems (OpcUa_Endpoint a_hEndpoint, OpcUa_Handle a_hContext, OpcUa_Void *a_ppRequest, OpcUa_EncodeableType a_pRequestType)
	Begins to modify monitored items.
OpcUa_Void	UaServer_MonitoredItem_Clear (UaServer_MonitoredItem *a_pMonitoredItem)
	Clears the monitored item.
OpcUa_Void	UaServer_MonitoredItem_Delete (UaServer_MonitoredItem **a_ppMonitoredItem)
	Deletes the monitored item.
OpcUa_Void	UaServer_MonitoredItemData_Delete (UaServer_MonitoredItemData **a_ppMonitoredItem)
	Deletes the monitored item (data).
OpcUa_Void	UaServer_MonitoredItemEvent_Delete (UaServer_MonitoredItemEvent **a_ppMonitoredItem)
	Deletes the monitored item (event).
OpcUa_StatusCode	UaServer_MonitoredItemData_Initialize (UaServer_MonitoredItemData a_pMonitoredItem, OpcUa_NodeId a_pNodeId, OpcUa_UInt32 a_AttributeId, OpcUa_MonitoringMode a_MonitoringMode, OpcUa_UInt32 a_uClientHandle, OpcUa_Int32 a_iSamplingInterval, OpcUa_UInt32 a_QueueSize, OpcUa_Boolean a_bDiscardOldest, OpcUa_TimestampsToReturn a_TimestampsToReturn, OpcUa_String a_IndexRange, OpcUa_ExtensionObject a_pFilter)
	Initializes the Monitoring of data items.
OpcUa_StatusCode	UaServer_MonitoredItemEvent_Initialize (UaServer_MonitoredItemEvent a_pMonitoredItem, OpcUa_NodeId a_pNodeId, OpcUa_MonitoringMode a_MonitoringMode, OpcUa_UInt32 a_uClientHandle, OpcUa_Boolean a_bDiscardOldest, UaServer_EventFilter *a_pInternalEventFilter)
	Initializes the Monitoring of event items.
OpcUa_StatusCode	UaServer_SetMonitoringMode (OpcUa_Endpoint a_hEndpoint, OpcUa_Handle a_hContext, OpcUa_Void *a_ppRequest, OpcUa_EncodeableType a_pRequestType)
	Starts to monitor the items.
OpcUa_StatusCode	UaServer_SetTriggering (OpcUa_Endpoint a_hEndpoint, OpcUa_Handle a_hContext, OpcUa_Void *a_ppRequest, OpcUa_EncodeableType a_pRequestType)
	Constructor.

Detailed Description

Enumeration Type Documentation

enum _MonitoredItemType

An enumeration of MonitoredItem types.

Depending on the type, a UaServer_MonitoredItem can be cast to UaServer_MonitoredItemData or UaServer_MonitoredItemEvent.

Function Documentation

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

Begins to create a monitored items context.

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	The type of request.

Returns: the OPC UA Status code.

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

Starts to delete monitored items.

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	The type of request.

Returns: the OPC UA Status code.

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

Begins to modify monitored items.

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	The type of request.

Returns: the OPC UA Status code.

OpcUa_StatusCode UaServer_CreateMonitoredItems ( UaServer_CreateMonitoredItemsContext * a_pCreateMonitoredItemsContext )

Creates monitored items.

Parameters

a_pCreateMonitoredItemsContext a pointer to the monitored item context.

Returns: the OPC UA Status code.

OpcUa_StatusCode UaServer_CreateMonitoredItemsContext_Create ( UaServer_CreateMonitoredItemsContext ** a_ppCreateMonitoredContext )

Starts to create the monitored items context.

Parameters

a_ppCreateMonitoredContext a pointer to the context of the monitored items context.

Returns: the OPC UA Status code.

OpcUa_Void UaServer_CreateMonitoredItemsContext_Delete ( UaServer_CreateMonitoredItemsContext ** a_ppCreateMonitoredContext )

ToDoDoc.

Parameters

a_ppCreateMonitoredContext a pointer to the context of the monitored items context.

OpcUa_StatusCode UaServer_DeleteMonitoredItems ( UaServer_DeleteMonitoredItemsContext * a_pDeleteMonitoredItemsContext )

Deletes the monitored items.

Parameters

a_pDeleteMonitoredItemsContext a pointer to the monitored item context.

Returns: the OPC UA Status code.

OpcUa_StatusCode UaServer_DeleteMonitoredItemsContext_Create ( UaServer_DeleteMonitoredItemsContext ** a_ppDeleteMonitoredItemsContext )

Create a new DeleteMonitoredItemsContext.

Parameters

a_ppDeleteMonitoredItemsContext a pointer to the DeleteMonitoredItemsContext.

Returns: the OPC UA Status code.

OpcUa_Void UaServer_DeleteMonitoredItemsContext_Delete ( UaServer_DeleteMonitoredItemsContext ** a_ppDeleteMonitoredItemsContext )

Constructor.

Parameters

[in] a_ppDeleteMonitoredItemsContext a pointer to the DeleteMonitoredItemsContext to delete.

Returns: DESCRIPTION

OpcUa_StatusCode UaServer_EndCreateMonitoredItems	(	OpcUa_StatusCode	a_uStatusCode,
		UaServer_CreateMonitoredItemsContext *	a_pCreateMonitoredContext
	)

Finishes the creation of monitored items.

Parameters

a_uStatusCode	Error code.
a_pCreateMonitoredContext	a pointer to the context of the monitored item.

Returns: the OPC UA Status code.

OpcUa_StatusCode UaServer_EndDeleteMonitoredItems	(	OpcUa_StatusCode	a_uStatusCode,
		UaServer_DeleteMonitoredItemsContext *	a_pDeleteMonitoredItemsContext
	)

Constructor.

Parameters

a_uStatusCode	Error code.
a_pDeleteMonitoredItemsContext	a pointer to the DeleteMonitoredItemsContext.

Returns: the OPC UA Status code.

OpcUa_StatusCode UaServer_EndModifyMonitoredItems	(	OpcUa_StatusCode	a_uStatusCode,
		UaServer_ModifyMonitoredItemsContext *	a_pModifyMonitoredContext
	)

Finishes the modifying of the monitored items.

Parameters

a_uStatusCode	Error code.
a_pModifyMonitoredContext	a pointer to the context of the monitored item.

Returns: the OPC UA Status code.

OpcUa_StatusCode UaServer_ModifyMonitoredItems ( UaServer_ModifyMonitoredItemsContext * a_pModifyMonitoredItemsContext )

Constructor.

Parameters

[in] a_pModifyMonitoredItemsContext DESCRIPTION

Returns: the OPC UA Status code.

OpcUa_StatusCode UaServer_ModifyMonitoredItemsContext_Create ( UaServer_ModifyMonitoredItemsContext ** a_ppModifyMonitoredContext )

Starts to create the modify monitored items context.

Parameters

a_ppModifyMonitoredContext a pointer to the context of the monitored items context.

Returns: the OPC UA Status code.

OpcUa_Void UaServer_ModifyMonitoredItemsContext_Delete ( UaServer_ModifyMonitoredItemsContext ** a_ppModifyMonitoredContext )

ToDoDoc.

Parameters

a_ppModifyMonitoredContext a pointer to the context of the monitored items context.

OpcUa_Void UaServer_MonitoredItem_Clear ( UaServer_MonitoredItem * a_pMonitoredItem )

Clears the monitored item.

Parameters

a_pMonitoredItem a pointer to a monitored item.

OpcUa_Void UaServer_MonitoredItem_Delete ( UaServer_MonitoredItem ** a_ppMonitoredItem )

Deletes the monitored item.

Parameters

a_ppMonitoredItem a pointer to a monitored item.

OpcUa_Void UaServer_MonitoredItemData_Delete ( UaServer_MonitoredItemData ** a_ppMonitoredItem )

Deletes the monitored item (data).

Parameters

a_ppMonitoredItem a pointer to a monitored item.

OpcUa_StatusCode UaServer_MonitoredItemData_Initialize	(	UaServer_MonitoredItemData *	a_pMonitoredItem,
		OpcUa_NodeId *	a_pNodeId,
		OpcUa_UInt32	a_AttributeId,
		OpcUa_MonitoringMode	a_MonitoringMode,
		OpcUa_UInt32	a_uClientHandle,
		OpcUa_Int32	a_iSamplingInterval,
		OpcUa_UInt32	a_QueueSize,
		OpcUa_Boolean	a_bDiscardOldest,
		OpcUa_TimestampsToReturn	a_TimestampsToReturn,
		OpcUa_String *	a_IndexRange,
		OpcUa_ExtensionObject *	a_pFilter
	)

Initializes the Monitoring of data items.

Parameters

[in]	a_pMonitoredItem	a pointer to a monitored item.
[in]	a_pNodeId	the Id of a Node.
[in]	a_AttributeId	the attribute id of the actual node.
[in]	a_MonitoringMode	the monitoring mode itself.
[in]	a_uClientHandle	a handle to the client.
[in]	a_iSamplingInterval	a value for the sampling rate in msec.
[in]	a_QueueSize	the size of the queue.
[in]	a_bDiscardOldest	indicates if the oldest should be discard or not.
[in]	a_TimestampsToReturn	DESCRIPTION
[in]	a_IndexRange	DESCRIPTION
[in]	a_pFilter	DESCRIPTION

Returns: the OPC UA Status code.

OpcUa_Void UaServer_MonitoredItemEvent_Delete ( UaServer_MonitoredItemEvent ** a_ppMonitoredItem )

Deletes the monitored item (event).

Parameters

a_ppMonitoredItem a pointer to a monitored item.

OpcUa_StatusCode UaServer_MonitoredItemEvent_Initialize	(	UaServer_MonitoredItemEvent *	a_pMonitoredItem,
		OpcUa_NodeId *	a_pNodeId,
		OpcUa_MonitoringMode	a_MonitoringMode,
		OpcUa_UInt32	a_uClientHandle,
		OpcUa_Boolean	a_bDiscardOldest,
		UaServer_EventFilter *	a_pInternalEventFilter
	)

Initializes the Monitoring of event items.

Parameters

[in]	a_pMonitoredItem	a pointer to a monitored item.
[in]	a_pNodeId	the Id of a Node.
[in]	a_MonitoringMode	the monitoring mode itself.
[in]	a_uClientHandle	a handle to the client.
[in]	a_bDiscardOldest	DESCRIPTION
[in]	a_pInternalEventFilter	the event filter.

Returns: the OPC UA Status code.

OpcUa_StatusCode UaServer_Providers_SubscribeComplete ( UaServer_ProviderSubscribeContext * a_pCtx )

A callback function which indicates if a subscribe was completed.

Parameters

a_pCtx a pointer to the provider subscription context.

Returns: only good if successful.

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

Starts to monitor the items.

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	The type of request.

Returns: the OPC UA Status code.

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

Constructor.

Parameters

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

Returns: the OPC UA Status code.

Data Structures

Typedefs

Enumerations

Functions

Detailed Description

Enumeration Type Documentation

Function Documentation