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

Interface DatagramConnectionTransportType

All Superinterfaces:
BaseObjectType, ConnectionTransportType, org.eclipse.milo.opcua.sdk.core.nodes.Node, org.eclipse.milo.opcua.sdk.core.nodes.ObjectNode
All Known Implementing Classes:
DatagramConnectionTransportTypeNode
public interface DatagramConnectionTransportType extends ConnectionTransportType
See Also:

  • Field Details

    • 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

    • DISCOVERY_MAX_MESSAGE_SIZE

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

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

  • Method Details

    • 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.

    • getDiscoveryMaxMessageSize

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

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

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

    • setDiscoveryMaxMessageSize

      void setDiscoveryMaxMessageSize(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 DiscoveryMaxMessageSize Node.

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

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

    • readDiscoveryMaxMessageSize

      org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger readDiscoveryMaxMessageSize() throws org.eclipse.milo.opcua.stack.core.UaException
      Read the value of the DiscoveryMaxMessageSize 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.

    • writeDiscoveryMaxMessageSize

      void writeDiscoveryMaxMessageSize(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 DiscoveryMaxMessageSize 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.

    • readDiscoveryMaxMessageSizeAsync

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

    • writeDiscoveryMaxMessageSizeAsync

      CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode> writeDiscoveryMaxMessageSizeAsync(org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger value)
      An asynchronous implementation of writeDiscoveryMaxMessageSize(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.

    • getDiscoveryMaxMessageSizeNode

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

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

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

    • getDiscoveryMaxMessageSizeNodeAsync

      CompletableFuture<? extends PropertyType> getDiscoveryMaxMessageSizeNodeAsync()
      Asynchronous implementation of getDiscoveryMaxMessageSizeNode().
      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.QosDataType[] 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.QosDataType[] 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.QosDataType[] 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 QosDataType 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.QosDataType[] 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 QosDataType 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.QosDataType[]> 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.QosDataType[] value)
      An asynchronous implementation of writeDatagramQos(org.eclipse.milo.opcua.stack.core.types.structured.QosDataType[]).
      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.

    • getDiscoveryAddressNode

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

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

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

    • getDiscoveryAddressNodeAsync

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