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

Interface PubSubStatusType

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

  • Method Summary

    Modifier and Type
    Method
    Description
    org.eclipse.milo.opcua.stack.core.types.enumerated.PubSubState
    getState()
    Get the local value of the State Node.
    BaseDataVariableType
    getStateNode()
    Get the State BaseDataVariableType Node, or null if it does not exist.
    CompletableFuture<? extends BaseDataVariableType>
    getStateNodeAsync()
    Asynchronous implementation of getStateNode().
    org.eclipse.milo.opcua.stack.core.types.enumerated.PubSubState
    readState()
    Read the value of the State Node from the server and update the local value if the operation succeeds.
    CompletableFuture<? extends org.eclipse.milo.opcua.stack.core.types.enumerated.PubSubState>
    readStateAsync()
    An asynchronous implementation of readState().
    void
    setState(org.eclipse.milo.opcua.stack.core.types.enumerated.PubSubState value)
    Set the local value of the State Node.
    void
    writeState(org.eclipse.milo.opcua.stack.core.types.enumerated.PubSubState value)
    Write a new value for the State Node to the server and update the local value if the operation succeeds.
    CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode>
    writeStateAsync(org.eclipse.milo.opcua.stack.core.types.enumerated.PubSubState value)
    An asynchronous implementation of writeState(org.eclipse.milo.opcua.stack.core.types.enumerated.PubSubState).

    Methods inherited from interface org.eclipse.milo.opcua.sdk.core.nodes.Node

    getAccessRestrictions, getBrowseName, getDescription, getDisplayName, getNodeClass, getNodeId, getRolePermissions, getUserRolePermissions, getUserWriteMask, getWriteMask, setAccessRestrictions, setBrowseName, setDescription, setDisplayName, setNodeClass, setNodeId, setRolePermissions, setUserRolePermissions, setUserWriteMask, setWriteMask

    Methods inherited from interface org.eclipse.milo.opcua.sdk.core.nodes.ObjectNode

    getEventNotifier, setEventNotifier

  • Method Details

    • getState

      org.eclipse.milo.opcua.stack.core.types.enumerated.PubSubState getState() throws org.eclipse.milo.opcua.stack.core.UaException
      Get the local value of the State Node.

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

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

    • setState

      void setState(org.eclipse.milo.opcua.stack.core.types.enumerated.PubSubState value) throws org.eclipse.milo.opcua.stack.core.UaException
      Set the local value of the State Node.

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

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

    • readState

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

    • writeState

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

    • readStateAsync

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

    • writeStateAsync

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

    • getStateNode

      BaseDataVariableType getStateNode() throws org.eclipse.milo.opcua.stack.core.UaException
      Get the State BaseDataVariableType Node, or null if it does not exist.

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

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

    • getStateNodeAsync

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