Module org.eclipse.milo.opcua.sdk.client
Package org.eclipse.milo.opcua.sdk.client.model.objects

Interface DatagramDataSetReaderTransportType

All Superinterfaces:
BaseObjectType, DataSetReaderTransportType, org.eclipse.milo.opcua.sdk.core.nodes.Node, org.eclipse.milo.opcua.sdk.core.nodes.ObjectNode
All Known Implementing Classes:
DatagramDataSetReaderTransportTypeNode
public interface DatagramDataSetReaderTransportType extends DataSetReaderTransportType
See Also:

  • Field Details

    • QOS_CATEGORY

      static final org.eclipse.milo.opcua.sdk.core.QualifiedProperty<String> QOS_CATEGORY

    • DATAGRAM_QOS

      static final org.eclipse.milo.opcua.sdk.core.QualifiedProperty<org.eclipse.milo.opcua.stack.core.types.structured.ReceiveQosDataType[]> DATAGRAM_QOS

    • TOPIC

      static final org.eclipse.milo.opcua.sdk.core.QualifiedProperty<String> TOPIC

  • Method Details

    • getQosCategory

      String getQosCategory() throws org.eclipse.milo.opcua.stack.core.UaException
      Get the local value of the QosCategory Node.

      The returned value is the last seen; it is not read live from the server.

      Returns:
      the local value of the QosCategory Node.
      Throws:
      org.eclipse.milo.opcua.stack.core.UaException - if an error occurs creating or getting the QosCategory Node.

    • setQosCategory

      void setQosCategory(String value) throws org.eclipse.milo.opcua.stack.core.UaException
      Set the local value of the QosCategory Node.

      The value is only updated locally; it is not written to the server.

      Parameters:
      value - the local value to set for the QosCategory Node.
      Throws:
      org.eclipse.milo.opcua.stack.core.UaException - if an error occurs creating or getting the QosCategory Node.

    • readQosCategory

      String readQosCategory() throws org.eclipse.milo.opcua.stack.core.UaException
      Read the value of the QosCategory Node from the server and update the local value if the operation succeeds.
      Returns:
      the String value read from the server.
      Throws:
      org.eclipse.milo.opcua.stack.core.UaException - if a service- or operation-level error occurs.

    • writeQosCategory

      void writeQosCategory(String value) throws org.eclipse.milo.opcua.stack.core.UaException
      Write a new value for the QosCategory Node to the server and update the local value if the operation succeeds.
      Parameters:
      value - the String value to write to the server.
      Throws:
      org.eclipse.milo.opcua.stack.core.UaException - if a service- or operation-level error occurs.

    • readQosCategoryAsync

      CompletableFuture<? extends String> readQosCategoryAsync()
      An asynchronous implementation of readQosCategory().
      Returns:
      a CompletableFuture that completes successfully with the value or completes exceptionally if an operation- or service-level error occurs.

    • writeQosCategoryAsync

      CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode> writeQosCategoryAsync(String value)
      An asynchronous implementation of writeQosCategory(java.lang.String).
      Returns:
      a CompletableFuture that completes successfully with the operation result or completes exceptionally if a service-level error occurs.

    • getQosCategoryNode

      PropertyType getQosCategoryNode() throws org.eclipse.milo.opcua.stack.core.UaException
      Get the QosCategory PropertyType Node, or null if it does not exist.

      The Node is created when first accessed and cached for subsequent calls.

      Returns:
      the QosCategory PropertyType Node, or null if it does not exist.
      Throws:
      org.eclipse.milo.opcua.stack.core.UaException - if an error occurs creating or getting the Node.

    • getQosCategoryNodeAsync

      CompletableFuture<? extends PropertyType> getQosCategoryNodeAsync()
      Asynchronous implementation of getQosCategoryNode().
      Returns:
      a CompletableFuture that completes successfully with the PropertyType Node or completes exceptionally if an error occurs creating or getting the Node.

    • getDatagramQos

      org.eclipse.milo.opcua.stack.core.types.structured.ReceiveQosDataType[] getDatagramQos() throws org.eclipse.milo.opcua.stack.core.UaException
      Get the local value of the DatagramQos Node.

      The returned value is the last seen; it is not read live from the server.

      Returns:
      the local value of the DatagramQos Node.
      Throws:
      org.eclipse.milo.opcua.stack.core.UaException - if an error occurs creating or getting the DatagramQos Node.

    • setDatagramQos

      void setDatagramQos(org.eclipse.milo.opcua.stack.core.types.structured.ReceiveQosDataType[] value) throws org.eclipse.milo.opcua.stack.core.UaException
      Set the local value of the DatagramQos Node.

      The value is only updated locally; it is not written to the server.

      Parameters:
      value - the local value to set for the DatagramQos Node.
      Throws:
      org.eclipse.milo.opcua.stack.core.UaException - if an error occurs creating or getting the DatagramQos Node.

    • readDatagramQos

      org.eclipse.milo.opcua.stack.core.types.structured.ReceiveQosDataType[] readDatagramQos() throws org.eclipse.milo.opcua.stack.core.UaException
      Read the value of the DatagramQos Node from the server and update the local value if the operation succeeds.
      Returns:
      the ReceiveQosDataType value read from the server.
      Throws:
      org.eclipse.milo.opcua.stack.core.UaException - if a service- or operation-level error occurs.

    • writeDatagramQos

      void writeDatagramQos(org.eclipse.milo.opcua.stack.core.types.structured.ReceiveQosDataType[] value) throws org.eclipse.milo.opcua.stack.core.UaException
      Write a new value for the DatagramQos Node to the server and update the local value if the operation succeeds.
      Parameters:
      value - the ReceiveQosDataType value to write to the server.
      Throws:
      org.eclipse.milo.opcua.stack.core.UaException - if a service- or operation-level error occurs.

    • readDatagramQosAsync

      CompletableFuture<? extends org.eclipse.milo.opcua.stack.core.types.structured.ReceiveQosDataType[]> readDatagramQosAsync()
      An asynchronous implementation of readDatagramQos().
      Returns:
      a CompletableFuture that completes successfully with the value or completes exceptionally if an operation- or service-level error occurs.

    • writeDatagramQosAsync

      CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode> writeDatagramQosAsync(org.eclipse.milo.opcua.stack.core.types.structured.ReceiveQosDataType[] value)
      An asynchronous implementation of writeDatagramQos(org.eclipse.milo.opcua.stack.core.types.structured.ReceiveQosDataType[]).
      Returns:
      a CompletableFuture that completes successfully with the operation result or completes exceptionally if a service-level error occurs.

    • getDatagramQosNode

      PropertyType getDatagramQosNode() throws org.eclipse.milo.opcua.stack.core.UaException
      Get the DatagramQos PropertyType Node, or null if it does not exist.

      The Node is created when first accessed and cached for subsequent calls.

      Returns:
      the DatagramQos PropertyType Node, or null if it does not exist.
      Throws:
      org.eclipse.milo.opcua.stack.core.UaException - if an error occurs creating or getting the Node.

    • getDatagramQosNodeAsync

      CompletableFuture<? extends PropertyType> getDatagramQosNodeAsync()
      Asynchronous implementation of getDatagramQosNode().
      Returns:
      a CompletableFuture that completes successfully with the PropertyType Node or completes exceptionally if an error occurs creating or getting the Node.

    • getTopic

      String getTopic() throws org.eclipse.milo.opcua.stack.core.UaException
      Get the local value of the Topic Node.

      The returned value is the last seen; it is not read live from the server.

      Returns:
      the local value of the Topic Node.
      Throws:
      org.eclipse.milo.opcua.stack.core.UaException - if an error occurs creating or getting the Topic Node.

    • setTopic

      void setTopic(String value) throws org.eclipse.milo.opcua.stack.core.UaException
      Set the local value of the Topic Node.

      The value is only updated locally; it is not written to the server.

      Parameters:
      value - the local value to set for the Topic Node.
      Throws:
      org.eclipse.milo.opcua.stack.core.UaException - if an error occurs creating or getting the Topic Node.

    • readTopic

      String readTopic() throws org.eclipse.milo.opcua.stack.core.UaException
      Read the value of the Topic Node from the server and update the local value if the operation succeeds.
      Returns:
      the String value read from the server.
      Throws:
      org.eclipse.milo.opcua.stack.core.UaException - if a service- or operation-level error occurs.

    • writeTopic

      void writeTopic(String value) throws org.eclipse.milo.opcua.stack.core.UaException
      Write a new value for the Topic Node to the server and update the local value if the operation succeeds.
      Parameters:
      value - the String value to write to the server.
      Throws:
      org.eclipse.milo.opcua.stack.core.UaException - if a service- or operation-level error occurs.

    • readTopicAsync

      CompletableFuture<? extends String> readTopicAsync()
      An asynchronous implementation of readTopic().
      Returns:
      a CompletableFuture that completes successfully with the value or completes exceptionally if an operation- or service-level error occurs.

    • writeTopicAsync

      CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode> writeTopicAsync(String value)
      An asynchronous implementation of writeTopic(java.lang.String).
      Returns:
      a CompletableFuture that completes successfully with the operation result or completes exceptionally if a service-level error occurs.

    • getTopicNode

      PropertyType getTopicNode() throws org.eclipse.milo.opcua.stack.core.UaException
      Get the Topic PropertyType Node, or null if it does not exist.

      The Node is created when first accessed and cached for subsequent calls.

      Returns:
      the Topic PropertyType Node, or null if it does not exist.
      Throws:
      org.eclipse.milo.opcua.stack.core.UaException - if an error occurs creating or getting the Node.

    • getTopicNodeAsync

      CompletableFuture<? extends PropertyType> getTopicNodeAsync()
      Asynchronous implementation of getTopicNode().
      Returns:
      a CompletableFuture that completes successfully with the PropertyType Node or completes exceptionally if an error occurs creating or getting the Node.

    • getAddressNode

      NetworkAddressType getAddressNode() throws org.eclipse.milo.opcua.stack.core.UaException
      Get the Address NetworkAddressType Node, or null if it does not exist.

      The Node is created when first accessed and cached for subsequent calls.

      Returns:
      the Address NetworkAddressType Node, or null if it does not exist.
      Throws:
      org.eclipse.milo.opcua.stack.core.UaException - if an error occurs creating or getting the Node.

    • getAddressNodeAsync

      CompletableFuture<? extends NetworkAddressType> getAddressNodeAsync()
      Asynchronous implementation of getAddressNode().
      Returns:
      a CompletableFuture that completes successfully with the NetworkAddressType Node or completes exceptionally if an error occurs creating or getting the Node.