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

Interface AuditCancelEventType

All Superinterfaces:
AuditEventType, AuditSecurityEventType, AuditSessionEventType, BaseEventType, BaseObjectType, org.eclipse.milo.opcua.sdk.core.nodes.Node, org.eclipse.milo.opcua.sdk.core.nodes.ObjectNode
All Known Implementing Classes:
AuditCancelEventTypeNode
public interface AuditCancelEventType extends AuditSessionEventType
See Also:

  • Field Details

    • REQUEST_HANDLE

      static final org.eclipse.milo.opcua.sdk.core.QualifiedProperty<org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger> REQUEST_HANDLE

  • Method Details

    • getRequestHandle

      org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger getRequestHandle() throws org.eclipse.milo.opcua.stack.core.UaException
      Get the local value of the RequestHandle Node.

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

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

    • setRequestHandle

      void setRequestHandle(org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger value) throws org.eclipse.milo.opcua.stack.core.UaException
      Set the local value of the RequestHandle Node.

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

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

    • readRequestHandle

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

    • writeRequestHandle

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

    • readRequestHandleAsync

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

    • writeRequestHandleAsync

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

    • getRequestHandleNode

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

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

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

    • getRequestHandleNodeAsync

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