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

Interface PubSubStatusEventType

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

  • Field Details

    • CONNECTION_ID

      static final org.eclipse.milo.opcua.sdk.core.QualifiedProperty<org.eclipse.milo.opcua.stack.core.types.builtin.NodeId> CONNECTION_ID

    • GROUP_ID

      static final org.eclipse.milo.opcua.sdk.core.QualifiedProperty<org.eclipse.milo.opcua.stack.core.types.builtin.NodeId> GROUP_ID

    • STATE

      static final org.eclipse.milo.opcua.sdk.core.QualifiedProperty<org.eclipse.milo.opcua.stack.core.types.enumerated.PubSubState> STATE

  • Method Details

    • getConnectionId

      org.eclipse.milo.opcua.stack.core.types.builtin.NodeId getConnectionId() throws org.eclipse.milo.opcua.stack.core.UaException
      Get the local value of the ConnectionId Node.

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

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

    • setConnectionId

      void setConnectionId(org.eclipse.milo.opcua.stack.core.types.builtin.NodeId value) throws org.eclipse.milo.opcua.stack.core.UaException
      Set the local value of the ConnectionId Node.

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

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

    • readConnectionId

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

    • writeConnectionId

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

    • readConnectionIdAsync

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

    • writeConnectionIdAsync

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

    • getConnectionIdNode

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

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

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

    • getConnectionIdNodeAsync

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

    • getGroupId

      org.eclipse.milo.opcua.stack.core.types.builtin.NodeId getGroupId() throws org.eclipse.milo.opcua.stack.core.UaException
      Get the local value of the GroupId Node.

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

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

    • setGroupId

      void setGroupId(org.eclipse.milo.opcua.stack.core.types.builtin.NodeId value) throws org.eclipse.milo.opcua.stack.core.UaException
      Set the local value of the GroupId Node.

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

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

    • readGroupId

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

    • writeGroupId

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

    • readGroupIdAsync

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

    • writeGroupIdAsync

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

    • getGroupIdNode

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

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

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

    • getGroupIdNodeAsync

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

    • 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

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

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

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

    • getStateNodeAsync

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