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

Interface AttributeServices

All Known Subinterfaces:

UaClient

All Known Implementing Classes:

OpcUaClient

public interface AttributeServices

Method Summary

Modifier and Type	Method and Description
CompletableFuture<org.eclipse.milo.opcua.stack.core.types.structured.HistoryReadResponse>	historyRead(org.eclipse.milo.opcua.stack.core.types.structured.HistoryReadDetails historyReadDetails, org.eclipse.milo.opcua.stack.core.types.enumerated.TimestampsToReturn timestampsToReturn, boolean releaseContinuationPoints, List<org.eclipse.milo.opcua.stack.core.types.structured.HistoryReadValueId> nodesToRead) This Service is used to read historical values or Events of one or more Nodes.
CompletableFuture<org.eclipse.milo.opcua.stack.core.types.structured.HistoryUpdateResponse>	historyUpdate(List<org.eclipse.milo.opcua.stack.core.types.structured.HistoryUpdateDetails> historyUpdateDetails) This Service is used to update historical values or Events of one or more Nodes.
default CompletableFuture<List<org.eclipse.milo.opcua.stack.core.types.builtin.DataValue>>	read(double maxAge, org.eclipse.milo.opcua.stack.core.types.enumerated.TimestampsToReturn timestampsToReturn, List<org.eclipse.milo.opcua.stack.core.types.builtin.NodeId> nodeIds, List<org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger> attributeIds) This service is used to read one or more attributes of one or more nodes.
CompletableFuture<org.eclipse.milo.opcua.stack.core.types.structured.ReadResponse>	read(double maxAge, org.eclipse.milo.opcua.stack.core.types.enumerated.TimestampsToReturn timestampsToReturn, List<org.eclipse.milo.opcua.stack.core.types.structured.ReadValueId> readValueIds) This service is used to read one or more attributes of one or more nodes.
default CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.DataValue>	readValue(double maxAge, org.eclipse.milo.opcua.stack.core.types.enumerated.TimestampsToReturn timestampsToReturn, org.eclipse.milo.opcua.stack.core.types.builtin.NodeId nodeId) This service is used to read the value attribute of a single Node.
default CompletableFuture<List<org.eclipse.milo.opcua.stack.core.types.builtin.DataValue>>	readValues(double maxAge, org.eclipse.milo.opcua.stack.core.types.enumerated.TimestampsToReturn timestampsToReturn, List<org.eclipse.milo.opcua.stack.core.types.builtin.NodeId> nodeIds) This service is used to read the value attribute of one or more Nodes.
CompletableFuture<org.eclipse.milo.opcua.stack.core.types.structured.WriteResponse>	write(List<org.eclipse.milo.opcua.stack.core.types.structured.WriteValue> writeValues) This service is used to write values to one or more attributes of one or more nodes.
default CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode>	writeValue(org.eclipse.milo.opcua.stack.core.types.builtin.NodeId nodeId, org.eclipse.milo.opcua.stack.core.types.builtin.DataValue value) This service is used to write to the value attribute of one node.
default CompletableFuture<List<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode>>	writeValues(List<org.eclipse.milo.opcua.stack.core.types.builtin.NodeId> nodeIds, List<org.eclipse.milo.opcua.stack.core.types.builtin.DataValue> values) This service is used to write to the value attribute of one or more nodes.

Method Detail

read

CompletableFuture<org.eclipse.milo.opcua.stack.core.types.structured.ReadResponse> read(double maxAge,
                                                                                        org.eclipse.milo.opcua.stack.core.types.enumerated.TimestampsToReturn timestampsToReturn,
                                                                                        List<org.eclipse.milo.opcua.stack.core.types.structured.ReadValueId> readValueIds)

This service is used to read one or more attributes of one or more nodes.

Parameters:

maxAge - the requested max age of the value, in milliseconds. If maxAge is set to 0, the Server shall attempt to read a new value from the data source. If maxAge is set to the max Int32 value or greater, the Server shall attempt to get a cached value. Negative values are invalid for maxAge.

timestampsToReturn - the requested TimestampsToReturn.

readValueIds - the ReadValueIds identifying the nodes and attributes to read.

Returns:

CompletableFuture containing the ReadResponse.

read

default CompletableFuture<List<org.eclipse.milo.opcua.stack.core.types.builtin.DataValue>> read(double maxAge,
                                                                                                org.eclipse.milo.opcua.stack.core.types.enumerated.TimestampsToReturn timestampsToReturn,
                                                                                                List<org.eclipse.milo.opcua.stack.core.types.builtin.NodeId> nodeIds,
                                                                                                List<org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger> attributeIds)

This service is used to read one or more attributes of one or more nodes.

Parameters:

maxAge - the requested max age of the value, in milliseconds. If maxAge is set to 0, the Server shall attempt to read a new value from the data source. If maxAge is set to the max Int32 value or greater, the Server shall attempt to get a cached value. Negative values are invalid for maxAge.

timestampsToReturn - the requested TimestampsToReturn.

nodeIds - the NodeIds identifying the nodes to read.

attributeIds - the attribute ids to read, the size and order matching the provided NodeIds.

Returns:

a CompletableFuture containing a list of DataValues, the size and order matching the provided NodeIds.

readValue

default CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.DataValue> readValue(double maxAge,
                                                                                               org.eclipse.milo.opcua.stack.core.types.enumerated.TimestampsToReturn timestampsToReturn,
                                                                                               org.eclipse.milo.opcua.stack.core.types.builtin.NodeId nodeId)

This service is used to read the value attribute of a single Node.

Parameters:

maxAge - the requested max age of the value, in milliseconds. If maxAge is set to 0, the Server shall attempt to read a new value from the data source. If maxAge is set to the max Int32 value or greater, the Server shall attempt to get a cached value. Negative values are invalid for maxAge.

timestampsToReturn - the requested TimestampsToReturn.

nodeId - the NodeId identifying the node to read.

Returns:

a CompletableFuture containing the DataValue.

readValues

default CompletableFuture<List<org.eclipse.milo.opcua.stack.core.types.builtin.DataValue>> readValues(double maxAge,
                                                                                                      org.eclipse.milo.opcua.stack.core.types.enumerated.TimestampsToReturn timestampsToReturn,
                                                                                                      List<org.eclipse.milo.opcua.stack.core.types.builtin.NodeId> nodeIds)

This service is used to read the value attribute of one or more Nodes.

Parameters:

maxAge - the requested max age of the value, in milliseconds. If maxAge is set to 0, the Server shall attempt to read a new value from the data source. If maxAge is set to the max Int32 value or greater, the Server shall attempt to get a cached value. Negative values are invalid for maxAge.

timestampsToReturn - the requested TimestampsToReturn.

nodeIds - the NodeIds identifying the nodes to read.

Returns:

a CompletableFuture containing a list of DataValues, the size and order matching the provided NodeIds.

write

CompletableFuture<org.eclipse.milo.opcua.stack.core.types.structured.WriteResponse> write(List<org.eclipse.milo.opcua.stack.core.types.structured.WriteValue> writeValues)

This service is used to write values to one or more attributes of one or more nodes.

Parameters:

writeValues - the list of nodes and their attributes to write.

Returns:

a CompletableFuture containing the WriteResponse.

writeValues

default CompletableFuture<List<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode>> writeValues(List<org.eclipse.milo.opcua.stack.core.types.builtin.NodeId> nodeIds,
                                                                                                        List<org.eclipse.milo.opcua.stack.core.types.builtin.DataValue> values)

This service is used to write to the value attribute of one or more nodes.

Parameters:

nodeIds - the NodeIds identifying the nodes to write to.

values - the DataValues to write.

Returns:

a CompletableFuture containing a list of results for the writes.

writeValue

default CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode> writeValue(org.eclipse.milo.opcua.stack.core.types.builtin.NodeId nodeId,
                                                                                                 org.eclipse.milo.opcua.stack.core.types.builtin.DataValue value)

This service is used to write to the value attribute of one node.

Parameters:

nodeId - the NodeId identifying the node to write to.

value - the DataValue to write.

Returns:

a CompletableFuture containing the result for the write.

historyRead

CompletableFuture<org.eclipse.milo.opcua.stack.core.types.structured.HistoryReadResponse> historyRead(org.eclipse.milo.opcua.stack.core.types.structured.HistoryReadDetails historyReadDetails,
                                                                                                      org.eclipse.milo.opcua.stack.core.types.enumerated.TimestampsToReturn timestampsToReturn,
                                                                                                      boolean releaseContinuationPoints,
                                                                                                      List<org.eclipse.milo.opcua.stack.core.types.structured.HistoryReadValueId> nodesToRead)

This Service is used to read historical values or Events of one or more Nodes.

Parameters:

historyReadDetails - defines the types of history read to be performed.

timestampsToReturn - specifies the timestamps to be returned for each requested value attribute.

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 historical information.

nodesToRead - the list of items upon which the historical retrieval is to be performed.

Returns:

a CompletableFuture containing the HistoryReadResponse.

historyUpdate

CompletableFuture<org.eclipse.milo.opcua.stack.core.types.structured.HistoryUpdateResponse> historyUpdate(List<org.eclipse.milo.opcua.stack.core.types.structured.HistoryUpdateDetails> historyUpdateDetails)

This Service is used to update historical values or Events of one or more Nodes.

Parameters:

historyUpdateDetails - the details defined for this update.

Returns:

a CompletableFuture containing the HistoryUpdateResponse.