UaServerMonitoring


Data Structures

struct  _UaServer_SubscribeContext
 UaServer Subscribe Structure. More...

Typedefs

typedef
typedefOPCUA_BEGIN_EXTERN_C
struct
_UaServer_CreateMonitoredItemsContext 		UaServer_CreateMonitoredItemsContext
 Holds all data to handle the CreateMonitoredItemsRequest.
typedef struct
_UaServer_ModifyMonitoredItemsContext 		UaServer_ModifyMonitoredItemsContext
 Holds all data to handle the ModifyMonitoredItemsRequest.
typedef struct
_UaServer_DeleteMonitoredItemsContext 		UaServer_DeleteMonitoredItemsContext
 Holds all data to handle the DeleteMonitoredItemsRequest.

Functions

OpcUa_StatusCode UaServer_CreateMonitoredItems (UaServer_CreateMonitoredItemsContext *a_pCreateMonitoredItemsContext)
 Creates monitored items.
OpcUa_StatusCode UaServer_DeleteMonitoredItems (UaServer_DeleteMonitoredItemsContext *a_pDeleteMonitoredItemsContext)
 Deletes the monitored items.
OpcUa_StatusCode UaServer_DeleteMonitoredItemsContext_Create (UaServer_DeleteMonitoredItemsContext **a_ppDeleteMonitoredItemsContext)
 Delete the actual MonitoredItemsContext.
OpcUa_StatusCode UaServer_EndDeleteMonitoredItems (OpcUa_StatusCode a_uStatusCode, UaServer_DeleteMonitoredItemsContext *a_pDeleteMonitoredItemsContext)
 Ends up deleting the actual MonitoredItemsContext.
OpcUa_Void UaServer_DeleteMonitoredItemsContext_Delete (UaServer_DeleteMonitoredItemsContext **a_ppDeleteMonitoredItemsContext)
 ToDoDoc.
OpcUa_StatusCode UaServer_BeginDeleteMonitoredItems (OpcUa_Endpoint a_hEndpoint, OpcUa_Handle a_hContext, OpcUa_Void **a_ppRequest, OpcUa_EncodeableType *a_pRequestType)
 Starts to delete the monitored items ontext.
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 the monitored item context.
IFMETHODIMP() UaServer_Providers_SubscribeComplete (UaServer_ProviderSubscribeContext *a_pCtx)
 A callback function which indicates if a subscribe was completed.
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_ModifyMonitoredItems (OpcUa_Endpoint a_hEndpoint, OpcUa_Handle a_hContext, OpcUa_Void **a_ppRequest, OpcUa_EncodeableType *a_pRequestType)
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_StatusCode UaServer_MonitoredItem_Initialize (UaServer_MonitoredItem *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)
 Initializes the Monitoring of items.
OpcUa_StatusCode UaServer_Server_SetMonitoringMode (OpcUa_Endpoint a_hEndpoint, OpcUa_Handle a_hContext, OpcUa_Void **a_ppRequest, OpcUa_EncodeableType *a_pRequestType)
 Starts to monitore the items.

Typedef Documentation

typedef typedefOPCUA_BEGIN_EXTERN_C struct _UaServer_CreateMonitoredItemsContext UaServer_CreateMonitoredItemsContext

Holds all data to handle the CreateMonitoredItemsRequest.

typedef struct _UaServer_DeleteMonitoredItemsContext UaServer_DeleteMonitoredItemsContext

Holds all data to handle the DeleteMonitoredItemsRequest.

typedef struct _UaServer_ModifyMonitoredItemsContext UaServer_ModifyMonitoredItemsContext

Holds all data to handle the ModifyMonitoredItemsRequest.

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 [in] 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 the monitored items ontext.

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_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  ) 

Delete the actual MonitoredItemsContext.

Parameters:
a_ppDeleteMonitoredItemsContext a pointer to the Monitored items Context.
Returns:
the OPC UA Status code.

OpcUa_Void UaServer_DeleteMonitoredItemsContext_Delete ( UaServer_DeleteMonitoredItemsContext **  a_ppDeleteMonitoredItemsContext  ) 

ToDoDoc.

Parameters:
a_ppDeleteMonitoredItemsContext a pointer to the monitored items context to delete.

OpcUa_StatusCode UaServer_EndCreateMonitoredItems ( OpcUa_StatusCode  a_uStatusCode,
UaServer_CreateMonitoredItemsContext *  a_pCreateMonitoredContext 
)

Finishes the creation of the monitored item context.

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 
)

Ends up deleting the actual MonitoredItemsContext.

Parameters:
a_uStatusCode Error code.
a_pDeleteMonitoredItemsContext a pointer to the monitored items context to delete.
Returns:
the OPC UA Status code.

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

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_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_StatusCode UaServer_MonitoredItem_Initialize ( UaServer_MonitoredItem *  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 
)

Initializes the Monitoring of items.

Parameters:
a_pMonitoredItem a pointer to a monitored item.
a_pNodeId the Id of a Node.
a_AttributeId the attribute id of the actual node.
a_MonitoringMode the monitoring mode itself.
a_uClientHandle a handle to the client.
a_iSamplingInterval a value for the sampling rate in msec.
a_QueueSize the size of the queue.
a_bDiscardOldest indicates if the oldest should be discard or not.
Returns:
the OPC UA Status code.

IFMETHODIMP() 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_Server_SetMonitoringMode ( OpcUa_Endpoint  a_hEndpoint,
OpcUa_Handle  a_hContext,
OpcUa_Void **  a_ppRequest,
OpcUa_EncodeableType *  a_pRequestType 
)

Starts to monitore 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 [in] The type of request.
Returns:
the OPC UA Status code.