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

Interface DatagramWriterGroupTransportType

All Superinterfaces:
BaseObjectType, org.eclipse.milo.opcua.sdk.core.nodes.Node, org.eclipse.milo.opcua.sdk.core.nodes.ObjectNode, WriterGroupTransportType
All Known Implementing Classes:
DatagramWriterGroupTransportTypeNode
public interface DatagramWriterGroupTransportType extends WriterGroupTransportType
See Also:

  • Field Details

    • MESSAGE_REPEAT_COUNT

      static final org.eclipse.milo.opcua.sdk.core.QualifiedProperty<org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UByte> MESSAGE_REPEAT_COUNT

    • MESSAGE_REPEAT_DELAY

      static final org.eclipse.milo.opcua.sdk.core.QualifiedProperty<Double> MESSAGE_REPEAT_DELAY

    • 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.TransmitQosDataType[]> DATAGRAM_QOS

    • DISCOVERY_ANNOUNCE_RATE

      static final org.eclipse.milo.opcua.sdk.core.QualifiedProperty<org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger> DISCOVERY_ANNOUNCE_RATE

    • TOPIC

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

  • Method Details

    • getMessageRepeatCount

      org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UByte getMessageRepeatCount() throws org.eclipse.milo.opcua.stack.core.UaException
      Get the local value of the MessageRepeatCount Node.

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

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

    • setMessageRepeatCount

      void setMessageRepeatCount(org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UByte value) throws org.eclipse.milo.opcua.stack.core.UaException
      Set the local value of the MessageRepeatCount Node.

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

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

    • readMessageRepeatCount

      org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UByte readMessageRepeatCount() throws org.eclipse.milo.opcua.stack.core.UaException
      Read the value of the MessageRepeatCount Node from the server and update the local value if the operation succeeds.
      Returns:
      the UByte value read from the server.
      Throws:
      org.eclipse.milo.opcua.stack.core.UaException - if a service- or operation-level error occurs.

    • writeMessageRepeatCount

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

    • readMessageRepeatCountAsync

      CompletableFuture<? extends org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UByte> readMessageRepeatCountAsync()
      An asynchronous implementation of readMessageRepeatCount().
      Returns:
      a CompletableFuture that completes successfully with the value or completes exceptionally if an operation- or service-level error occurs.

    • writeMessageRepeatCountAsync

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

    • getMessageRepeatCountNode

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

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

      Returns:
      the MessageRepeatCount 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.

    • getMessageRepeatCountNodeAsync

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

    • getMessageRepeatDelay

      Double getMessageRepeatDelay() throws org.eclipse.milo.opcua.stack.core.UaException
      Get the local value of the MessageRepeatDelay Node.

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

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

    • setMessageRepeatDelay

      void setMessageRepeatDelay(Double value) throws org.eclipse.milo.opcua.stack.core.UaException
      Set the local value of the MessageRepeatDelay Node.

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

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

    • readMessageRepeatDelay

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

    • writeMessageRepeatDelay

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

    • readMessageRepeatDelayAsync

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

    • writeMessageRepeatDelayAsync

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

    • getMessageRepeatDelayNode

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

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

      Returns:
      the MessageRepeatDelay 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.

    • getMessageRepeatDelayNodeAsync

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

    • 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.TransmitQosDataType[] 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.TransmitQosDataType[] 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.TransmitQosDataType[] 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 TransmitQosDataType 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.TransmitQosDataType[] 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 TransmitQosDataType 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.TransmitQosDataType[]> 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.TransmitQosDataType[] value)
      An asynchronous implementation of writeDatagramQos(org.eclipse.milo.opcua.stack.core.types.structured.TransmitQosDataType[]).
      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.

    • getDiscoveryAnnounceRate

      org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger getDiscoveryAnnounceRate() throws org.eclipse.milo.opcua.stack.core.UaException
      Get the local value of the DiscoveryAnnounceRate Node.

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

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

    • setDiscoveryAnnounceRate

      void setDiscoveryAnnounceRate(org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger value) throws org.eclipse.milo.opcua.stack.core.UaException
      Set the local value of the DiscoveryAnnounceRate Node.

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

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

    • readDiscoveryAnnounceRate

      org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger readDiscoveryAnnounceRate() throws org.eclipse.milo.opcua.stack.core.UaException
      Read the value of the DiscoveryAnnounceRate Node from the server and update the local value if the operation succeeds.
      Returns:
      the UInteger value read from the server.
      Throws:
      org.eclipse.milo.opcua.stack.core.UaException - if a service- or operation-level error occurs.

    • writeDiscoveryAnnounceRate

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

    • readDiscoveryAnnounceRateAsync

      CompletableFuture<? extends org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger> readDiscoveryAnnounceRateAsync()
      An asynchronous implementation of readDiscoveryAnnounceRate().
      Returns:
      a CompletableFuture that completes successfully with the value or completes exceptionally if an operation- or service-level error occurs.

    • writeDiscoveryAnnounceRateAsync

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

    • getDiscoveryAnnounceRateNode

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

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

      Returns:
      the DiscoveryAnnounceRate 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.

    • getDiscoveryAnnounceRateNodeAsync

      CompletableFuture<? extends PropertyType> getDiscoveryAnnounceRateNodeAsync()
      Asynchronous implementation of getDiscoveryAnnounceRateNode().
      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.