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

Interface DataSetReaderType

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

  • Field Details

    • PUBLISHER_ID

      static final org.eclipse.milo.opcua.sdk.core.QualifiedProperty<Object> PUBLISHER_ID

    • 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

    • DATA_SET_WRITER_ID

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

    • DATA_SET_META_DATA

      static final org.eclipse.milo.opcua.sdk.core.QualifiedProperty<org.eclipse.milo.opcua.stack.core.types.structured.DataSetMetaDataType> DATA_SET_META_DATA

    • DATA_SET_FIELD_CONTENT_MASK

      static final org.eclipse.milo.opcua.sdk.core.QualifiedProperty<org.eclipse.milo.opcua.stack.core.types.structured.DataSetFieldContentMask> DATA_SET_FIELD_CONTENT_MASK

    • MESSAGE_RECEIVE_TIMEOUT

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

    • KEY_FRAME_COUNT

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

    • HEADER_LAYOUT_URI

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

    • SECURITY_MODE

      static final org.eclipse.milo.opcua.sdk.core.QualifiedProperty<org.eclipse.milo.opcua.stack.core.types.enumerated.MessageSecurityMode> SECURITY_MODE

    • SECURITY_GROUP_ID

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

    • SECURITY_KEY_SERVICES

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

    • DATA_SET_READER_PROPERTIES

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

  • Method Details

    • getPublisherId

      Object getPublisherId() throws org.eclipse.milo.opcua.stack.core.UaException
      Get the local value of the PublisherId Node.

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

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

    • setPublisherId

      void setPublisherId(Object value) throws org.eclipse.milo.opcua.stack.core.UaException
      Set the local value of the PublisherId Node.

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

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

    • readPublisherId

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

    • writePublisherId

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

    • readPublisherIdAsync

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

    • writePublisherIdAsync

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

    • getPublisherIdNode

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

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

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

    • getPublisherIdNodeAsync

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

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

    • getDataSetWriterId

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

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

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

    • setDataSetWriterId

      void setDataSetWriterId(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 DataSetWriterId Node.

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

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

    • readDataSetWriterId

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

    • writeDataSetWriterId

      void writeDataSetWriterId(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 DataSetWriterId 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.

    • readDataSetWriterIdAsync

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

    • writeDataSetWriterIdAsync

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

    • getDataSetWriterIdNode

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

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

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

    • getDataSetWriterIdNodeAsync

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

    • getDataSetMetaData

      org.eclipse.milo.opcua.stack.core.types.structured.DataSetMetaDataType getDataSetMetaData() throws org.eclipse.milo.opcua.stack.core.UaException
      Get the local value of the DataSetMetaData Node.

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

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

    • setDataSetMetaData

      void setDataSetMetaData(org.eclipse.milo.opcua.stack.core.types.structured.DataSetMetaDataType value) throws org.eclipse.milo.opcua.stack.core.UaException
      Set the local value of the DataSetMetaData Node.

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

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

    • readDataSetMetaData

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

    • writeDataSetMetaData

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

    • readDataSetMetaDataAsync

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

    • writeDataSetMetaDataAsync

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

    • getDataSetMetaDataNode

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

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

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

    • getDataSetMetaDataNodeAsync

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

    • getDataSetFieldContentMask

      org.eclipse.milo.opcua.stack.core.types.structured.DataSetFieldContentMask getDataSetFieldContentMask() throws org.eclipse.milo.opcua.stack.core.UaException
      Get the local value of the DataSetFieldContentMask Node.

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

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

    • setDataSetFieldContentMask

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

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

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

    • readDataSetFieldContentMask

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

    • writeDataSetFieldContentMask

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

    • readDataSetFieldContentMaskAsync

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

    • writeDataSetFieldContentMaskAsync

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

    • getDataSetFieldContentMaskNode

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

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

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

    • getDataSetFieldContentMaskNodeAsync

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

    • getMessageReceiveTimeout

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

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

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

    • setMessageReceiveTimeout

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

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

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

    • readMessageReceiveTimeout

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

    • writeMessageReceiveTimeout

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

    • readMessageReceiveTimeoutAsync

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

    • writeMessageReceiveTimeoutAsync

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

    • getMessageReceiveTimeoutNode

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

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

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

    • getMessageReceiveTimeoutNodeAsync

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

    • getKeyFrameCount

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

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

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

    • setKeyFrameCount

      void setKeyFrameCount(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 KeyFrameCount Node.

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

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

    • readKeyFrameCount

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

    • writeKeyFrameCount

      void writeKeyFrameCount(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 KeyFrameCount 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.

    • readKeyFrameCountAsync

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

    • writeKeyFrameCountAsync

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

    • getKeyFrameCountNode

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

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

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

    • getKeyFrameCountNodeAsync

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

    • getSecurityMode

      org.eclipse.milo.opcua.stack.core.types.enumerated.MessageSecurityMode getSecurityMode() throws org.eclipse.milo.opcua.stack.core.UaException
      Get the local value of the SecurityMode Node.

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

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

    • setSecurityMode

      void setSecurityMode(org.eclipse.milo.opcua.stack.core.types.enumerated.MessageSecurityMode value) throws org.eclipse.milo.opcua.stack.core.UaException
      Set the local value of the SecurityMode Node.

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

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

    • readSecurityMode

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

    • writeSecurityMode

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

    • readSecurityModeAsync

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

    • writeSecurityModeAsync

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

    • getSecurityModeNode

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

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

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

    • getSecurityModeNodeAsync

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

    • getSecurityGroupId

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

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

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

    • setSecurityGroupId

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

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

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

    • readSecurityGroupId

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

    • writeSecurityGroupId

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

    • readSecurityGroupIdAsync

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

    • writeSecurityGroupIdAsync

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

    • getSecurityGroupIdNode

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

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

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

    • getSecurityGroupIdNodeAsync

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

    • getSecurityKeyServices

      org.eclipse.milo.opcua.stack.core.types.structured.EndpointDescription[] getSecurityKeyServices() throws org.eclipse.milo.opcua.stack.core.UaException
      Get the local value of the SecurityKeyServices Node.

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

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

    • setSecurityKeyServices

      void setSecurityKeyServices(org.eclipse.milo.opcua.stack.core.types.structured.EndpointDescription[] value) throws org.eclipse.milo.opcua.stack.core.UaException
      Set the local value of the SecurityKeyServices Node.

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

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

    • readSecurityKeyServices

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

    • writeSecurityKeyServices

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

    • readSecurityKeyServicesAsync

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

    • writeSecurityKeyServicesAsync

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

    • getSecurityKeyServicesNode

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

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

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

    • getSecurityKeyServicesNodeAsync

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

    • getDataSetReaderProperties

      org.eclipse.milo.opcua.stack.core.types.structured.KeyValuePair[] getDataSetReaderProperties() throws org.eclipse.milo.opcua.stack.core.UaException
      Get the local value of the DataSetReaderProperties Node.

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

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

    • setDataSetReaderProperties

      void setDataSetReaderProperties(org.eclipse.milo.opcua.stack.core.types.structured.KeyValuePair[] value) throws org.eclipse.milo.opcua.stack.core.UaException
      Set the local value of the DataSetReaderProperties Node.

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

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

    • readDataSetReaderProperties

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

    • writeDataSetReaderProperties

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

    • readDataSetReaderPropertiesAsync

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

    • writeDataSetReaderPropertiesAsync

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

    • getDataSetReaderPropertiesNode

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

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

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

    • getDataSetReaderPropertiesNodeAsync

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

    • getTransportSettingsNode

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

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

      Returns:
      the TransportSettings DataSetReaderTransportType 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 DataSetReaderTransportType> getTransportSettingsNodeAsync()
      Asynchronous implementation of getTransportSettingsNode().
      Returns:
      a CompletableFuture that completes successfully with the DataSetReaderTransportType Node or completes exceptionally if an error occurs creating or getting the Node.

    • getMessageSettingsNode

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

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

      Returns:
      the MessageSettings DataSetReaderMessageType 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 DataSetReaderMessageType> getMessageSettingsNodeAsync()
      Asynchronous implementation of getMessageSettingsNode().
      Returns:
      a CompletableFuture that completes successfully with the DataSetReaderMessageType Node or completes exceptionally if an error occurs creating or getting the Node.

    • getStatusNode

      PubSubStatusType getStatusNode() throws org.eclipse.milo.opcua.stack.core.UaException
      Get the Status PubSubStatusType Node, or null if it does not exist.

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

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

    • getStatusNodeAsync

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

    • getDiagnosticsNode

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

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

      Returns:
      the Diagnostics PubSubDiagnosticsDataSetReaderType 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 PubSubDiagnosticsDataSetReaderType> getDiagnosticsNodeAsync()
      Asynchronous implementation of getDiagnosticsNode().
      Returns:
      a CompletableFuture that completes successfully with the PubSubDiagnosticsDataSetReaderType Node or completes exceptionally if an error occurs creating or getting the Node.

    • getSubscribedDataSetNode

      SubscribedDataSetType getSubscribedDataSetNode() throws org.eclipse.milo.opcua.stack.core.UaException
      Get the SubscribedDataSet SubscribedDataSetType Node, or null if it does not exist.

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

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

    • getSubscribedDataSetNodeAsync

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