org.eclipse.milo.opcua.sdk.client.model.types.objects

Interface TransparentRedundancyType

All Superinterfaces:

BaseObjectType, Node, ObjectNode, ServerRedundancyType

All Known Implementing Classes:

TransparentRedundancyTypeNode

public interface TransparentRedundancyType
extends ServerRedundancyType

Field Summary

Fields

Modifier and Type	Field and Description
static QualifiedProperty<String>	CURRENT_SERVER_ID
static QualifiedProperty<org.eclipse.milo.opcua.stack.core.types.structured.RedundantServerDataType[]>	REDUNDANT_SERVER_ARRAY

Fields inherited from interface org.eclipse.milo.opcua.sdk.client.model.types.objects.ServerRedundancyType

REDUNDANCY_SUPPORT

Method Summary

Modifier and Type	Method and Description
String	getCurrentServerId() Get the local value of the CurrentServerId Node.
PropertyType	getCurrentServerIdNode() Get the CurrentServerId PropertyType Node, or null if it does not exist.
CompletableFuture<? extends PropertyType>	getCurrentServerIdNodeAsync() Asynchronous implementation of getCurrentServerIdNode().
org.eclipse.milo.opcua.stack.core.types.structured.RedundantServerDataType[]	getRedundantServerArray() Get the local value of the RedundantServerArray Node.
PropertyType	getRedundantServerArrayNode() Get the RedundantServerArray PropertyType Node, or null if it does not exist.
CompletableFuture<? extends PropertyType>	getRedundantServerArrayNodeAsync() Asynchronous implementation of getRedundantServerArrayNode().
String	readCurrentServerId() Read the value of the CurrentServerId Node from the server and update the local value if the operation succeeds.
CompletableFuture<? extends String>	readCurrentServerIdAsync() An asynchronous implementation of readCurrentServerId().
org.eclipse.milo.opcua.stack.core.types.structured.RedundantServerDataType[]	readRedundantServerArray() Read the value of the RedundantServerArray Node from the server and update the local value if the operation succeeds.
CompletableFuture<? extends org.eclipse.milo.opcua.stack.core.types.structured.RedundantServerDataType[]>	readRedundantServerArrayAsync() An asynchronous implementation of readRedundantServerArray().
void	setCurrentServerId(String currentServerId) Set the local value of the CurrentServerId Node.
void	setRedundantServerArray(org.eclipse.milo.opcua.stack.core.types.structured.RedundantServerDataType[] redundantServerArray) Set the local value of the RedundantServerArray Node.
void	writeCurrentServerId(String currentServerId) Write a new value for the CurrentServerId Node to the server and update the local value if the operation succeeds.
CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode>	writeCurrentServerIdAsync(String currentServerId) An asynchronous implementation of writeCurrentServerId(String).
void	writeRedundantServerArray(org.eclipse.milo.opcua.stack.core.types.structured.RedundantServerDataType[] redundantServerArray) Write a new value for the RedundantServerArray Node to the server and update the local value if the operation succeeds.
CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode>	writeRedundantServerArrayAsync(org.eclipse.milo.opcua.stack.core.types.structured.RedundantServerDataType[] redundantServerArray) An asynchronous implementation of writeRedundantServerArray(RedundantServerDataType[]).

Methods inherited from interface org.eclipse.milo.opcua.sdk.client.model.types.objects.ServerRedundancyType

getRedundancySupport, getRedundancySupportNode, getRedundancySupportNodeAsync, readRedundancySupport, readRedundancySupportAsync, setRedundancySupport, writeRedundancySupport, writeRedundancySupportAsync

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

getEventNotifier, setEventNotifier

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

getBrowseName, getDescription, getDisplayName, getNodeClass, getNodeId, getUserWriteMask, getWriteMask, setBrowseName, setDescription, setDisplayName, setNodeClass, setNodeId, setUserWriteMask, setWriteMask

Field Detail

CURRENT_SERVER_ID

static final QualifiedProperty<String> CURRENT_SERVER_ID

REDUNDANT_SERVER_ARRAY

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

Method Detail

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 currentServerId)
                 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:

currentServerId - 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 currentServerId)
                   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:

currentServerId - 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 property 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 currentServerId)

An asynchronous implementation of writeCurrentServerId(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 ? extends PropertyType Node or completes exceptionally if an error occurs creating or getting the Node.

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.

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[] redundantServerArray)
                      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.

Parameters:

redundantServerArray - 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.

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[] redundantServerArray)
                        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.

Parameters:

redundantServerArray - 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().

Returns:

a CompletableFuture that completes successfully with the property 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[] redundantServerArray)

An asynchronous implementation of writeRedundantServerArray(RedundantServerDataType[]).

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.

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().

Returns:

a CompletableFuture that completes successfully with the ? extends PropertyType Node or completes exceptionally if an error occurs creating or getting the Node.