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

Interface TransparentRedundancyType

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

  • Field Details

    • REDUNDANT_SERVER_ARRAY

      static final org.eclipse.milo.opcua.sdk.core.QualifiedProperty<org.eclipse.milo.opcua.stack.core.types.structured.RedundantServerDataType[]> REDUNDANT_SERVER_ARRAY

    • CURRENT_SERVER_ID

      static final org.eclipse.milo.opcua.sdk.core.QualifiedProperty<String> CURRENT_SERVER_ID

  • Method Details

    • getRedundantServerArray

      org.eclipse.milo.opcua.stack.core.types.structured.RedundantServerDataType[] getRedundantServerArray() throws org.eclipse.milo.opcua.stack.core.UaException
      Get the local value of the RedundantServerArray Node.

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

      Specified by:
      getRedundantServerArray in interface ServerRedundancyType
      Returns:
      the local value of the RedundantServerArray Node.
      Throws:
      org.eclipse.milo.opcua.stack.core.UaException - if an error occurs creating or getting the RedundantServerArray Node.

    • setRedundantServerArray

      void setRedundantServerArray(org.eclipse.milo.opcua.stack.core.types.structured.RedundantServerDataType[] value) throws org.eclipse.milo.opcua.stack.core.UaException
      Set the local value of the RedundantServerArray Node.

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

      Specified by:
      setRedundantServerArray in interface ServerRedundancyType
      Parameters:
      value - the local value to set for the RedundantServerArray Node.
      Throws:
      org.eclipse.milo.opcua.stack.core.UaException - if an error occurs creating or getting the RedundantServerArray Node.

    • readRedundantServerArray

      org.eclipse.milo.opcua.stack.core.types.structured.RedundantServerDataType[] readRedundantServerArray() throws org.eclipse.milo.opcua.stack.core.UaException
      Read the value of the RedundantServerArray Node from the server and update the local value if the operation succeeds.
      Specified by:
      readRedundantServerArray in interface ServerRedundancyType
      Returns:
      the RedundantServerDataType value read from the server.
      Throws:
      org.eclipse.milo.opcua.stack.core.UaException - if a service- or operation-level error occurs.

    • writeRedundantServerArray

      void writeRedundantServerArray(org.eclipse.milo.opcua.stack.core.types.structured.RedundantServerDataType[] value) throws org.eclipse.milo.opcua.stack.core.UaException
      Write a new value for the RedundantServerArray Node to the server and update the local value if the operation succeeds.
      Specified by:
      writeRedundantServerArray in interface ServerRedundancyType
      Parameters:
      value - the RedundantServerDataType value to write to the server.
      Throws:
      org.eclipse.milo.opcua.stack.core.UaException - if a service- or operation-level error occurs.

    • readRedundantServerArrayAsync

      CompletableFuture<? extends org.eclipse.milo.opcua.stack.core.types.structured.RedundantServerDataType[]> readRedundantServerArrayAsync()
      An asynchronous implementation of readRedundantServerArray().
      Specified by:
      readRedundantServerArrayAsync in interface ServerRedundancyType
      Returns:
      a CompletableFuture that completes successfully with the value or completes exceptionally if an operation- or service-level error occurs.

    • writeRedundantServerArrayAsync

      CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode> writeRedundantServerArrayAsync(org.eclipse.milo.opcua.stack.core.types.structured.RedundantServerDataType[] value)
      An asynchronous implementation of writeRedundantServerArray(org.eclipse.milo.opcua.stack.core.types.structured.RedundantServerDataType[]).
      Specified by:
      writeRedundantServerArrayAsync in interface ServerRedundancyType
      Returns:
      a CompletableFuture that completes successfully with the operation result or completes exceptionally if a service-level error occurs.

    • getRedundantServerArrayNode

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

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

      Specified by:
      getRedundantServerArrayNode in interface ServerRedundancyType
      Returns:
      the RedundantServerArray 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.

    • getRedundantServerArrayNodeAsync

      CompletableFuture<? extends PropertyType> getRedundantServerArrayNodeAsync()
      Asynchronous implementation of getRedundantServerArrayNode().
      Specified by:
      getRedundantServerArrayNodeAsync in interface ServerRedundancyType
      Returns:
      a CompletableFuture that completes successfully with the PropertyType Node or completes exceptionally if an error occurs creating or getting the Node.

    • getCurrentServerId

      String getCurrentServerId() throws org.eclipse.milo.opcua.stack.core.UaException
      Get the local value of the CurrentServerId Node.

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

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

    • setCurrentServerId

      void setCurrentServerId(String value) throws org.eclipse.milo.opcua.stack.core.UaException
      Set the local value of the CurrentServerId Node.

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

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

    • readCurrentServerId

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

    • writeCurrentServerId

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

    • readCurrentServerIdAsync

      CompletableFuture<? extends String> readCurrentServerIdAsync()
      An asynchronous implementation of readCurrentServerId().
      Returns:
      a CompletableFuture that completes successfully with the value or completes exceptionally if an operation- or service-level error occurs.

    • writeCurrentServerIdAsync

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

    • getCurrentServerIdNode

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

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

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

    • getCurrentServerIdNodeAsync

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