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

Interface UadpDataSetWriterMessageType

All Superinterfaces:
BaseObjectType, DataSetWriterMessageType, org.eclipse.milo.opcua.sdk.core.nodes.Node, org.eclipse.milo.opcua.sdk.core.nodes.ObjectNode
All Known Implementing Classes:
UadpDataSetWriterMessageTypeNode
public interface UadpDataSetWriterMessageType extends DataSetWriterMessageType
See Also:

  • Field Details

    • DATA_SET_MESSAGE_CONTENT_MASK

      static final org.eclipse.milo.opcua.sdk.core.QualifiedProperty<org.eclipse.milo.opcua.stack.core.types.structured.UadpDataSetMessageContentMask> DATA_SET_MESSAGE_CONTENT_MASK

    • CONFIGURED_SIZE

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

    • NETWORK_MESSAGE_NUMBER

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

    • DATA_SET_OFFSET

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

  • Method Details

    • getDataSetMessageContentMask

      org.eclipse.milo.opcua.stack.core.types.structured.UadpDataSetMessageContentMask getDataSetMessageContentMask() throws org.eclipse.milo.opcua.stack.core.UaException
      Get the local value of the DataSetMessageContentMask Node.

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

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

    • setDataSetMessageContentMask

      void setDataSetMessageContentMask(org.eclipse.milo.opcua.stack.core.types.structured.UadpDataSetMessageContentMask value) throws org.eclipse.milo.opcua.stack.core.UaException
      Set the local value of the DataSetMessageContentMask Node.

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

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

    • readDataSetMessageContentMask

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

    • writeDataSetMessageContentMask

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

    • readDataSetMessageContentMaskAsync

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

    • writeDataSetMessageContentMaskAsync

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

    • getDataSetMessageContentMaskNode

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

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

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

    • getDataSetMessageContentMaskNodeAsync

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

    • getConfiguredSize

      org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UShort getConfiguredSize() throws org.eclipse.milo.opcua.stack.core.UaException
      Get the local value of the ConfiguredSize Node.

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

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

    • setConfiguredSize

      void setConfiguredSize(org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UShort value) throws org.eclipse.milo.opcua.stack.core.UaException
      Set the local value of the ConfiguredSize Node.

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

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

    • readConfiguredSize

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

    • writeConfiguredSize

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

    • readConfiguredSizeAsync

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

    • writeConfiguredSizeAsync

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

    • getConfiguredSizeNode

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

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

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

    • getConfiguredSizeNodeAsync

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

    • getNetworkMessageNumber

      org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UShort getNetworkMessageNumber() throws org.eclipse.milo.opcua.stack.core.UaException
      Get the local value of the NetworkMessageNumber Node.

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

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

    • setNetworkMessageNumber

      void setNetworkMessageNumber(org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UShort value) throws org.eclipse.milo.opcua.stack.core.UaException
      Set the local value of the NetworkMessageNumber Node.

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

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

    • readNetworkMessageNumber

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

    • writeNetworkMessageNumber

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

    • readNetworkMessageNumberAsync

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

    • writeNetworkMessageNumberAsync

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

    • getNetworkMessageNumberNode

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

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

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

    • getNetworkMessageNumberNodeAsync

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

    • getDataSetOffset

      org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UShort getDataSetOffset() throws org.eclipse.milo.opcua.stack.core.UaException
      Get the local value of the DataSetOffset Node.

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

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

    • setDataSetOffset

      void setDataSetOffset(org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UShort value) throws org.eclipse.milo.opcua.stack.core.UaException
      Set the local value of the DataSetOffset Node.

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

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

    • readDataSetOffset

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

    • writeDataSetOffset

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

    • readDataSetOffsetAsync

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

    • writeDataSetOffsetAsync

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

    • getDataSetOffsetNode

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

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

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

    • getDataSetOffsetNodeAsync

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