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

Interface PubSubConnectionType

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

  • Field Details

    • PUBLISHER_ID

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

    • CONNECTION_PROPERTIES

      static final org.eclipse.milo.opcua.sdk.core.QualifiedProperty<org.eclipse.milo.opcua.stack.core.types.structured.KeyValuePair[]> CONNECTION_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.

    • getConnectionProperties

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

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

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

    • setConnectionProperties

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

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

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

    • readConnectionProperties

      org.eclipse.milo.opcua.stack.core.types.structured.KeyValuePair[] readConnectionProperties() throws org.eclipse.milo.opcua.stack.core.UaException
      Read the value of the ConnectionProperties 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.

    • writeConnectionProperties

      void writeConnectionProperties(org.eclipse.milo.opcua.stack.core.types.structured.KeyValuePair[] value) throws org.eclipse.milo.opcua.stack.core.UaException
      Write a new value for the ConnectionProperties 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.

    • readConnectionPropertiesAsync

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

    • writeConnectionPropertiesAsync

      CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode> writeConnectionPropertiesAsync(org.eclipse.milo.opcua.stack.core.types.structured.KeyValuePair[] value)
      An asynchronous implementation of writeConnectionProperties(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.

    • getConnectionPropertiesNode

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

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

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

    • getConnectionPropertiesNodeAsync

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

    • getTransportProfileUri

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

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

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

    • setTransportProfileUri

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

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

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

    • readTransportProfileUri

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

    • writeTransportProfileUri

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

    • readTransportProfileUriAsync

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

    • writeTransportProfileUriAsync

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

    • getTransportProfileUriNode

      SelectionListType getTransportProfileUriNode() throws org.eclipse.milo.opcua.stack.core.UaException
      Get the TransportProfileUri SelectionListType Node, or null if it does not exist.

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

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

    • getTransportProfileUriNodeAsync

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

    • getAddressNode

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

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

      Returns:
      the Address NetworkAddressType Node, or null if it does not exist.
      Throws:
      org.eclipse.milo.opcua.stack.core.UaException - if an error occurs creating or getting the Node.

    • getAddressNodeAsync

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

    • getTransportSettingsNode

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

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

      Returns:
      the TransportSettings ConnectionTransportType 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 ConnectionTransportType> getTransportSettingsNodeAsync()
      Asynchronous implementation of getTransportSettingsNode().
      Returns:
      a CompletableFuture that completes successfully with the ConnectionTransportType 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

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

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

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