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

Interface SystemStatusChangeEventType

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

  • Field Details

    • SYSTEM_STATE

      static final org.eclipse.milo.opcua.sdk.core.QualifiedProperty<org.eclipse.milo.opcua.stack.core.types.enumerated.ServerState> SYSTEM_STATE

  • Method Details

    • getSystemState

      org.eclipse.milo.opcua.stack.core.types.enumerated.ServerState getSystemState() throws org.eclipse.milo.opcua.stack.core.UaException
      Get the local value of the SystemState Node.

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

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

    • setSystemState

      void setSystemState(org.eclipse.milo.opcua.stack.core.types.enumerated.ServerState value) throws org.eclipse.milo.opcua.stack.core.UaException
      Set the local value of the SystemState Node.

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

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

    • readSystemState

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

    • writeSystemState

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

    • readSystemStateAsync

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

    • writeSystemStateAsync

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

    • getSystemStateNode

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

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

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

    • getSystemStateNodeAsync

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