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

Interface PubSubCommunicationFailureEventType

All Superinterfaces:
BaseEventType, BaseObjectType, org.eclipse.milo.opcua.sdk.core.nodes.Node, org.eclipse.milo.opcua.sdk.core.nodes.ObjectNode, PubSubStatusEventType, SystemEventType
All Known Implementing Classes:
PubSubCommunicationFailureEventTypeNode
public interface PubSubCommunicationFailureEventType extends PubSubStatusEventType
See Also:

  • Field Details

    • ERROR

      static final org.eclipse.milo.opcua.sdk.core.QualifiedProperty<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode> ERROR

  • Method Details

    • getError

      org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode getError() throws org.eclipse.milo.opcua.stack.core.UaException
      Get the local value of the Error Node.

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

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

    • setError

      void setError(org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode value) throws org.eclipse.milo.opcua.stack.core.UaException
      Set the local value of the Error Node.

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

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

    • readError

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

    • writeError

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

    • readErrorAsync

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

    • writeErrorAsync

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

    • getErrorNode

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

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

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

    • getErrorNodeAsync

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