5 Service Sets ToC Previous Next

5.8 View Service Set ToC Previous Next

5.8.2 Browse ToC Previous Next

5.8.2.1 Description ToC

This Service is used to discover the References of a specified Node. The browse can be further limited by the use of a View. This Browse Service also supports a primitive filtering capability.

In some cases it may take longer than the Client timeout hint to process all nodes to browse. In this case the Server may return zero results with a continuation point for the affected nodes before the timeout expires.

5.8.2.2 Parameters ToC

Table 34 defines the parameters for the Service.

Table 34 – Browse Service Parameters

Name Type Description
Request    
   requestHeader RequestHeader Common request parameters (see 7.28 for RequestHeader definition).
   View ViewDescription Description of the View to browse (see 7.39 for ViewDescription definition). An empty ViewDescription value indicates the entire AddressSpace. Use of the empty ViewDescription value causes all References of the nodesToBrowse to be returned. Use of any other View causes only the References of the nodesToBrowse that are defined for that View to be returned.
   requestedMax
   ReferencesPerNode
Counter Indicates the maximum number of references to return for each starting Node specified in the request. The value 0 indicates that the Client is imposing no limitation (see 7.5 for Counter definition).
   nodesToBrowse [] BrowseDescription A list of nodes to Browse. This structure is defined in-line with the following indented items.
      nodeId NodeId NodeId   of the Node to be browsed. If a view is provided, it shall include this Node.
      browseDirection Enum
BrowseDirection
An enumeration that specifies the direction of References to follow. It has the following values:
   FORWARD_0 select only forward References.
   INVERSE_1 select only inverse References.
   BOTH_2 select forward and inverse References.
   INVALID_3 no value specified.
The returned References do indicate the direction the Server followed in the isForward parameter of the ReferenceDescription.
Symmetric References are always considered to be in forward direction therefore the isForward flag is always set to TRUE and symmetric References are not returned if browseDirection is set to INVERSE_1.
      referenceTypeId NodeId Specifies the NodeId of the ReferenceType to follow. Only instances of this ReferenceType or its subtypes are returned.
If not specified then all References are returned and includeSubtypes is ignored.
      includeSubtypes Boolean Indicates whether subtypes of the ReferenceType should be included in the browse. If TRUE, then instances of referenceTypeId and all of its subtypes are returned.
      nodeClassMask UInt32 Specifies the NodeClasses of the TargetNodes. Only TargetNodes with the selected NodeClasses are returned. The NodeClasses are assigned the following bits:
   Bit   NodeClass
   0   Object
   1   Variable
   2   Method
   3   ObjectType
   4   VariableType
   5   ReferenceType
   6   DataType
   7   View
If set to zero, then all NodeClasses are returned.
If the NodeClass is unknown for a remote Node, the nodeClassMask is ignored.
      resultMask UInt32 Specifies the fields in the ReferenceDescription structure that should be returned. The fields are assigned the following bits:
   Bit   Result
   0   ReferenceType
   1   IsForward
   2   NodeClass
   3   BrowseName
   4   DisplayName
   5   TypeDefinition
The ReferenceDescription type is defined in 7.25.
     
Response    
   responseHeader Response Header Common response parameters (see 7.29 for ResponseHeader definition).
   results [] BrowseResult A list of BrowseResults. The size and order of the list matches the size and order of the nodesToBrowse specified in the request.
The BrowseResult type is defined in 7.3.
   diagnosticInfos [] Diagnostic Info List of diagnostic information for the results (see 7.8 for DiagnosticInfo definition). The size and order of the list matches the size and order of the results response parameter. This list is empty if diagnostics information was not requested in the request header or if no diagnostic information was encountered in processing of the request.

5.8.2.3 Service results ToC

Table 35 defines the Service results specific to this Service. Common StatusCodes are defined in Table 177.

Table 35 – Browse Service Result Codes

Symbolic Id Description
Bad_ViewIdUnknown See Table 177 for the description of this result code.
Bad_ViewTimestampInvalid See Table 177 for the description of this result code.
Bad_ViewParameterMismatchInvalid See Table 177 for the description of this result code.
Bad_ViewVersionInvalid See Table 177 for the description of this result code.
Bad_NothingToDo See Table 177 for the description of this result code.
Bad_TooManyOperations See Table 177 for the description of this result code.

5.8.2.4 StatusCodes ToC

Table 36 defines values for the results parameter that are specific to this Service. Common StatusCodes are defined in Table 178.

Table 36 – Browse Operation Level Result Codes

Symbolic Id Description
Bad_NodeIdInvalid See Table 178 for the description of this result code.
Bad_NodeIdUnknown See Table 178 for the description of this result code.
Bad_ReferenceTypeIdInvalid See Table 178 for the description of this result code.
Bad_BrowseDirectionInvalid See Table 178 for the description of this result code.
Bad_NodeNotInView See Table 178 for the description of this result code.
Bad_NoContinuationPoints See Table 178 for the description of this result code.
Uncertain_NotAllNodesAvailable Browse results may be incomplete because of the unavailability of a subsystem.

Previous Next