org.eclipse.milo.opcua.sdk.client.api.services

Interface ViewServices

All Known Subinterfaces:

UaClient

All Known Implementing Classes:

OpcUaClient

public interface ViewServices

Method Summary

Modifier and Type	Method and Description
default CompletableFuture<org.eclipse.milo.opcua.stack.core.types.structured.BrowseResult>	browse(org.eclipse.milo.opcua.stack.core.types.structured.BrowseDescription nodeToBrowse) Browse a single node, with no view and no max references specified.
default CompletableFuture<List<org.eclipse.milo.opcua.stack.core.types.structured.BrowseResult>>	browse(List<org.eclipse.milo.opcua.stack.core.types.structured.BrowseDescription> nodesToBrowse) Browse a list of nodes, with no view and no max references specified.
CompletableFuture<org.eclipse.milo.opcua.stack.core.types.structured.BrowseResponse>	browse(org.eclipse.milo.opcua.stack.core.types.structured.ViewDescription viewDescription, org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger maxReferencesPerNode, List<org.eclipse.milo.opcua.stack.core.types.structured.BrowseDescription> nodesToBrowse) This service is used to discover the references of a specified node.
default CompletableFuture<org.eclipse.milo.opcua.stack.core.types.structured.BrowseResult>	browseNext(boolean releaseContinuationPoint, org.eclipse.milo.opcua.stack.core.types.builtin.ByteString continuationPoint) This service is used to request the next set of Browse or BrowseNext response information that is too large to be sent in a single response.
CompletableFuture<org.eclipse.milo.opcua.stack.core.types.structured.BrowseNextResponse>	browseNext(boolean releaseContinuationPoints, List<org.eclipse.milo.opcua.stack.core.types.builtin.ByteString> continuationPoints) This service is used to request the next set of Browse or BrowseNext response information that is too large to be sent in a single response.
CompletableFuture<org.eclipse.milo.opcua.stack.core.types.structured.RegisterNodesResponse>	registerNodes(List<org.eclipse.milo.opcua.stack.core.types.builtin.NodeId> nodesToRegister) The RegisterNodes service can be used by clients to register the nodes that they know they will access repeatedly (e.g.
CompletableFuture<org.eclipse.milo.opcua.stack.core.types.structured.TranslateBrowsePathsToNodeIdsResponse>	translateBrowsePaths(List<org.eclipse.milo.opcua.stack.core.types.structured.BrowsePath> browsePaths) This service is used to request that the server translates one or more browse paths to NodeIds.
CompletableFuture<org.eclipse.milo.opcua.stack.core.types.structured.UnregisterNodesResponse>	unregisterNodes(List<org.eclipse.milo.opcua.stack.core.types.builtin.NodeId> nodesToUnregister) This service is used to unregister NodeIds that have been register via the RegisterNodes service.

Method Detail

browse

CompletableFuture<org.eclipse.milo.opcua.stack.core.types.structured.BrowseResponse> browse(org.eclipse.milo.opcua.stack.core.types.structured.ViewDescription viewDescription,
                                                                                            org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger maxReferencesPerNode,
                                                                                            List<org.eclipse.milo.opcua.stack.core.types.structured.BrowseDescription> nodesToBrowse)

This service is used to discover the references of a specified node.

The browse can be further limited by the use of a view. The Browse service also supports a primitive filtering capability.

Parameters:

viewDescription - a description of the view to browse. An empty ViewDescription indicates a view of the entire address space.

maxReferencesPerNode - the maximum number of references to return for each starting node specified in the request.

nodesToBrowse - a list of nodes to browse.

Returns:

a CompletableFuture containing the BrowseResponse.

browse

default CompletableFuture<org.eclipse.milo.opcua.stack.core.types.structured.BrowseResult> browse(org.eclipse.milo.opcua.stack.core.types.structured.BrowseDescription nodeToBrowse)

Browse a single node, with no view and no max references specified.

Parameters:

nodeToBrowse - the node to browse.

Returns:

a CompletableFuture containing the BrowseResult.

browse

default CompletableFuture<List<org.eclipse.milo.opcua.stack.core.types.structured.BrowseResult>> browse(List<org.eclipse.milo.opcua.stack.core.types.structured.BrowseDescription> nodesToBrowse)

Browse a list of nodes, with no view and no max references specified.

Parameters:

nodesToBrowse - the nodes to browse.

Returns:

a CompletableFuture containing the BrowseResults.

browseNext

CompletableFuture<org.eclipse.milo.opcua.stack.core.types.structured.BrowseNextResponse> browseNext(boolean releaseContinuationPoints,
                                                                                                    List<org.eclipse.milo.opcua.stack.core.types.builtin.ByteString> continuationPoints)

This service is used to request the next set of Browse or BrowseNext response information that is too large to be sent in a single response.

“Too large” in this context means that the server is not able to return a larger response or that the number of results to return exceeds the maximum number of results to return that was specified by the client in the original Browse request.

Parameters:

releaseContinuationPoints - if true, passed continuationPoints shall be reset to free resources in the server. If false, passed continuationPoints shall be used to get the next set of browse information.

continuationPoints - a list of server-defined opaque values that represent continuation points.

Returns:

a CompletableFuture containing the BrowseNextResponse.

browseNext

default CompletableFuture<org.eclipse.milo.opcua.stack.core.types.structured.BrowseResult> browseNext(boolean releaseContinuationPoint,
                                                                                                      org.eclipse.milo.opcua.stack.core.types.builtin.ByteString continuationPoint)

This service is used to request the next set of Browse or BrowseNext response information that is too large to be sent in a single response.

“Too large” in this context means that the server is not able to return a larger response or that the number of results to return exceeds the maximum number of results to return that was specified by the client in the original Browse request.

Parameters:

releaseContinuationPoint - if true, passed continuationPoint shall be reset to free resources in the server. If false, passed continuationPoint shall be used to get the next set of browse information.

continuationPoint - a server-defined opaque value that represents the next continuation point.

Returns:

a CompletableFuture containing the BrowseResult.

translateBrowsePaths

CompletableFuture<org.eclipse.milo.opcua.stack.core.types.structured.TranslateBrowsePathsToNodeIdsResponse> translateBrowsePaths(List<org.eclipse.milo.opcua.stack.core.types.structured.BrowsePath> browsePaths)

This service is used to request that the server translates one or more browse paths to NodeIds.

Each browse path is constructed of a starting NodeId and a RelativePath. The specified starting node identifies the node from which the RelativePath is based.

Parameters:

browsePaths - a list of browse paths for which NodeIds are being requested.

Returns:

a CompletableFuture containing the TranslateBrowsePathsToNodeIdsResponse.

registerNodes

CompletableFuture<org.eclipse.milo.opcua.stack.core.types.structured.RegisterNodesResponse> registerNodes(List<org.eclipse.milo.opcua.stack.core.types.builtin.NodeId> nodesToRegister)

The RegisterNodes service can be used by clients to register the nodes that they know they will access repeatedly (e.g. Write, Call). It allows servers to set up anything needed so that the access operations will be more efficient.

Parameters:

nodesToRegister - a list of NodeIds to register.

Returns:

a CompletableFuture containing the RegisterNodesResponse.

unregisterNodes

CompletableFuture<org.eclipse.milo.opcua.stack.core.types.structured.UnregisterNodesResponse> unregisterNodes(List<org.eclipse.milo.opcua.stack.core.types.builtin.NodeId> nodesToUnregister)

This service is used to unregister NodeIds that have been register via the RegisterNodes service.

Parameters:

nodesToUnregister - a list of NodeIds to unregister.

Returns:

a CompletableFuture containing the UnregisterNodesResponse.