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

Interface WriterGroupType

All Superinterfaces:
BaseObjectType, org.eclipse.milo.opcua.sdk.core.nodes.Node, org.eclipse.milo.opcua.sdk.core.nodes.ObjectNode, PubSubGroupType
All Known Implementing Classes:
WriterGroupTypeNode
public interface WriterGroupType extends PubSubGroupType
See Also:

  • Field Details

    • WRITER_GROUP_ID

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

    • PUBLISHING_INTERVAL

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

    • KEEP_ALIVE_TIME

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

    • PRIORITY

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

    • LOCALE_IDS

      static final org.eclipse.milo.opcua.sdk.core.QualifiedProperty<String[]> LOCALE_IDS

    • HEADER_LAYOUT_URI

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

  • Method Details

    • getWriterGroupId

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

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

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

    • setWriterGroupId

      void setWriterGroupId(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 WriterGroupId Node.

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

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

    • readWriterGroupId

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

    • writeWriterGroupId

      void writeWriterGroupId(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 WriterGroupId 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.

    • readWriterGroupIdAsync

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

    • writeWriterGroupIdAsync

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

    • getWriterGroupIdNode

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

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

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

    • getWriterGroupIdNodeAsync

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

    • getPublishingInterval

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

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

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

    • setPublishingInterval

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

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

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

    • readPublishingInterval

      Double readPublishingInterval() throws org.eclipse.milo.opcua.stack.core.UaException
      Read the value of the PublishingInterval 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.

    • writePublishingInterval

      void writePublishingInterval(Double value) throws org.eclipse.milo.opcua.stack.core.UaException
      Write a new value for the PublishingInterval 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.

    • readPublishingIntervalAsync

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

    • writePublishingIntervalAsync

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

    • getPublishingIntervalNode

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

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

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

    • getPublishingIntervalNodeAsync

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

    • getKeepAliveTime

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

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

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

    • setKeepAliveTime

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

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

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

    • readKeepAliveTime

      Double readKeepAliveTime() throws org.eclipse.milo.opcua.stack.core.UaException
      Read the value of the KeepAliveTime 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.

    • writeKeepAliveTime

      void writeKeepAliveTime(Double value) throws org.eclipse.milo.opcua.stack.core.UaException
      Write a new value for the KeepAliveTime 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.

    • readKeepAliveTimeAsync

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

    • writeKeepAliveTimeAsync

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

    • getKeepAliveTimeNode

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

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

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

    • getKeepAliveTimeNodeAsync

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

    • getPriority

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

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

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

    • setPriority

      void setPriority(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 Priority Node.

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

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

    • readPriority

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

    • writePriority

      void writePriority(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 Priority 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.

    • readPriorityAsync

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

    • writePriorityAsync

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

    • getPriorityNode

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

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

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

    • getPriorityNodeAsync

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

    • getLocaleIds

      String[] getLocaleIds() throws org.eclipse.milo.opcua.stack.core.UaException
      Get the local value of the LocaleIds Node.

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

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

    • setLocaleIds

      void setLocaleIds(String[] value) throws org.eclipse.milo.opcua.stack.core.UaException
      Set the local value of the LocaleIds Node.

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

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

    • readLocaleIds

      String[] readLocaleIds() throws org.eclipse.milo.opcua.stack.core.UaException
      Read the value of the LocaleIds 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.

    • writeLocaleIds

      void writeLocaleIds(String[] value) throws org.eclipse.milo.opcua.stack.core.UaException
      Write a new value for the LocaleIds 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.

    • readLocaleIdsAsync

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

    • writeLocaleIdsAsync

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

    • getLocaleIdsNode

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

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

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

    • getLocaleIdsNodeAsync

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

    • getHeaderLayoutUri

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

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

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

    • setHeaderLayoutUri

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

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

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

    • readHeaderLayoutUri

      String readHeaderLayoutUri() throws org.eclipse.milo.opcua.stack.core.UaException
      Read the value of the HeaderLayoutUri 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.

    • writeHeaderLayoutUri

      void writeHeaderLayoutUri(String value) throws org.eclipse.milo.opcua.stack.core.UaException
      Write a new value for the HeaderLayoutUri 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.

    • readHeaderLayoutUriAsync

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

    • writeHeaderLayoutUriAsync

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

    • getHeaderLayoutUriNode

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

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

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

    • getHeaderLayoutUriNodeAsync

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

    • getTransportSettingsNode

      WriterGroupTransportType getTransportSettingsNode() throws org.eclipse.milo.opcua.stack.core.UaException
      Get the TransportSettings WriterGroupTransportType Node, or null if it does not exist.

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

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

    • getTransportSettingsNodeAsync

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

    • getMessageSettingsNode

      WriterGroupMessageType getMessageSettingsNode() throws org.eclipse.milo.opcua.stack.core.UaException
      Get the MessageSettings WriterGroupMessageType Node, or null if it does not exist.

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

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

    • getMessageSettingsNodeAsync

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

    • getDiagnosticsNode

      PubSubDiagnosticsWriterGroupType getDiagnosticsNode() throws org.eclipse.milo.opcua.stack.core.UaException
      Get the Diagnostics PubSubDiagnosticsWriterGroupType Node, or null if it does not exist.

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

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

    • getDiagnosticsNodeAsync

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