ANSI C Based OPC UA Client/Server SDK  1.9.0.430
UaServerRead

Functions

OpcUa_StatusCode UaServer_ReadComplete (UaServer_ProviderReadContext *a_pReadContext)
 Called by the provider to signal that he finished handling the Read call. More...
 
OpcUa_StatusCode UaServer_ValidateReadParams (OpcUa_BaseNode *a_pNode, UaServer_ProviderReadContext *a_pReadContext, OpcUa_Int32 a_iNodeIndex, OpcUa_UInt32 *a_pNoOfNumericRanges, UaServer_NumericRange *a_pNumericRanges)
 Check if all read parameters are valid and match the given node. More...
 
OpcUa_StatusCode UaServer_ReadNodeInternal (OpcUa_BaseNode *a_pNode, UaServer_ProviderReadContext *a_pReadContext, OpcUa_Int32 a_iNodeIndex, OpcUa_UInt32 *a_pNoOfNumericRanges, UaServer_NumericRange *a_pNumericRanges)
 Read the given node. More...
 
OpcUa_StatusCode UaServer_ReadInternal (OpcUa_BaseNode *a_pNode, UaServer_ProviderReadContext *a_pReadContext, OpcUa_Int32 a_iNodeIndex)
 Called by a provider to let the SDK handle the read call. More...
 

Detailed Description

Function Documentation

OpcUa_StatusCode UaServer_ReadComplete ( UaServer_ProviderReadContext a_pReadContext)

Called by the provider to signal that he finished handling the Read call.

Note
This function is thread-safe.
Parameters
a_pReadContextThe processed ReadContext.
Returns
Always returns OpcUa_Good.
OpcUa_StatusCode UaServer_ReadInternal ( OpcUa_BaseNode *  a_pNode,
UaServer_ProviderReadContext a_pReadContext,
OpcUa_Int32  a_iNodeIndex 
)

Called by a provider to let the SDK handle the read call.

Parameters
[in]a_pNodeThe node to read
[in]a_pReadContextThe associated read context.
[in]a_iNodeIndexThe index of the node to read from the list of the request.
Returns
the OPC UA Status code.
OpcUa_StatusCode UaServer_ReadNodeInternal ( OpcUa_BaseNode *  a_pNode,
UaServer_ProviderReadContext a_pReadContext,
OpcUa_Int32  a_iNodeIndex,
OpcUa_UInt32 *  a_pNoOfNumericRanges,
UaServer_NumericRange *  a_pNumericRanges 
)

Read the given node.

Use this only after verifying the read parameters using UaServer_ValidateReadParams.

Parameters
[in]a_pNodeThe node to read.
[in]a_pReadContextThe associated read context.
[in]a_iNodeIndexThe index of the node to read from the list of the request.
[in]a_pNoOfNumericRangesThe number of numeric ranges in a_pNumericRanges.
[in]a_pNumericRangesArray of numeric range representing the index range.
Returns
the OPC UA Status code.
OpcUa_StatusCode UaServer_ValidateReadParams ( OpcUa_BaseNode *  a_pNode,
UaServer_ProviderReadContext a_pReadContext,
OpcUa_Int32  a_iNodeIndex,
OpcUa_UInt32 *  a_pNoOfNumericRanges,
UaServer_NumericRange *  a_pNumericRanges 
)

Check if all read parameters are valid and match the given node.

Can be used to only validate the read parameters without accessing the OpcUa_BaseNode's value.

Parameters
[in]a_pNodeThe node to read.
[in]a_pReadContextThe associated read context.
[in]a_iNodeIndexThe index of the node to read from the list of the request.
[in,out]a_pNoOfNumericRangesThe size of a_pNumericRanges. Will contain the number of numeric ranges on return.
[in]a_pNumericRangesArray of numeric range to store the index range in.
Returns
the OPC UA Status code.