org.eclipse.milo.opcua.sdk.client.model.nodes.variables

Class ServerStatusTypeNode

java.lang.Object

org.eclipse.milo.opcua.sdk.client.nodes.UaNode

org.eclipse.milo.opcua.sdk.client.nodes.UaVariableNode

org.eclipse.milo.opcua.sdk.client.model.nodes.variables.BaseVariableTypeNode

org.eclipse.milo.opcua.sdk.client.model.nodes.variables.BaseDataVariableTypeNode

org.eclipse.milo.opcua.sdk.client.model.nodes.variables.ServerStatusTypeNode

All Implemented Interfaces:

BaseDataVariableType, BaseVariableType, ServerStatusType, Node, VariableNode

public class ServerStatusTypeNode
extends BaseDataVariableTypeNode
implements ServerStatusType

Field Summary

Fields inherited from class org.eclipse.milo.opcua.sdk.client.nodes.UaNode

client

Constructor Summary

Constructors

Constructor and Description

ServerStatusTypeNode(OpcUaClient client, org.eclipse.milo.opcua.stack.core.types.builtin.NodeId nodeId, org.eclipse.milo.opcua.stack.core.types.enumerated.NodeClass nodeClass, org.eclipse.milo.opcua.stack.core.types.builtin.QualifiedName browseName, org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText displayName, org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText description, org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger writeMask, org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger userWriteMask, org.eclipse.milo.opcua.stack.core.types.builtin.DataValue value, org.eclipse.milo.opcua.stack.core.types.builtin.NodeId dataType, Integer valueRank, org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger[] arrayDimensions, org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UByte accessLevel, org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UByte userAccessLevel, Double minimumSamplingInterval, Boolean historizing)

Method Summary

Modifier and Type	Method and Description
org.eclipse.milo.opcua.stack.core.types.structured.BuildInfo	getBuildInfo() Get the local value of the BuildInfo Node.
BuildInfoTypeNode	getBuildInfoNode() Get the BuildInfo BuildInfoType Node, or null if it does not exist.
CompletableFuture<? extends BuildInfoTypeNode>	getBuildInfoNodeAsync() Asynchronous implementation of ServerStatusType.getBuildInfoNode().
org.eclipse.milo.opcua.stack.core.types.builtin.DateTime	getCurrentTime() Get the local value of the CurrentTime Node.
BaseDataVariableTypeNode	getCurrentTimeNode() Get the CurrentTime BaseDataVariableType Node, or null if it does not exist.
CompletableFuture<? extends BaseDataVariableTypeNode>	getCurrentTimeNodeAsync() Asynchronous implementation of ServerStatusType.getCurrentTimeNode().
org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger	getSecondsTillShutdown() Get the local value of the SecondsTillShutdown Node.
BaseDataVariableTypeNode	getSecondsTillShutdownNode() Get the SecondsTillShutdown BaseDataVariableType Node, or null if it does not exist.
CompletableFuture<? extends BaseDataVariableTypeNode>	getSecondsTillShutdownNodeAsync() Asynchronous implementation of ServerStatusType.getSecondsTillShutdownNode().
org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText	getShutdownReason() Get the local value of the ShutdownReason Node.
BaseDataVariableTypeNode	getShutdownReasonNode() Get the ShutdownReason BaseDataVariableType Node, or null if it does not exist.
CompletableFuture<? extends BaseDataVariableTypeNode>	getShutdownReasonNodeAsync() Asynchronous implementation of ServerStatusType.getShutdownReasonNode().
org.eclipse.milo.opcua.stack.core.types.builtin.DateTime	getStartTime() Get the local value of the StartTime Node.
BaseDataVariableTypeNode	getStartTimeNode() Get the StartTime BaseDataVariableType Node, or null if it does not exist.
CompletableFuture<? extends BaseDataVariableTypeNode>	getStartTimeNodeAsync() Asynchronous implementation of ServerStatusType.getStartTimeNode().
org.eclipse.milo.opcua.stack.core.types.enumerated.ServerState	getState() Get the local value of the State Node.
BaseDataVariableTypeNode	getStateNode() Get the State BaseDataVariableType Node, or null if it does not exist.
CompletableFuture<? extends BaseDataVariableTypeNode>	getStateNodeAsync() Asynchronous implementation of ServerStatusType.getStateNode().
org.eclipse.milo.opcua.stack.core.types.structured.BuildInfo	readBuildInfo() Read the value of the BuildInfo Node from the server and update the local value if the operation succeeds.
CompletableFuture<? extends org.eclipse.milo.opcua.stack.core.types.structured.BuildInfo>	readBuildInfoAsync() An asynchronous implementation of ServerStatusType.readBuildInfo().
org.eclipse.milo.opcua.stack.core.types.builtin.DateTime	readCurrentTime() Read the value of the CurrentTime Node from the server and update the local value if the operation succeeds.
CompletableFuture<? extends org.eclipse.milo.opcua.stack.core.types.builtin.DateTime>	readCurrentTimeAsync() An asynchronous implementation of ServerStatusType.readCurrentTime().
org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger	readSecondsTillShutdown() Read the value of the SecondsTillShutdown Node from the server and update the local value if the operation succeeds.
CompletableFuture<? extends org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger>	readSecondsTillShutdownAsync() An asynchronous implementation of ServerStatusType.readSecondsTillShutdown().
org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText	readShutdownReason() Read the value of the ShutdownReason Node from the server and update the local value if the operation succeeds.
CompletableFuture<? extends org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText>	readShutdownReasonAsync() An asynchronous implementation of ServerStatusType.readShutdownReason().
org.eclipse.milo.opcua.stack.core.types.builtin.DateTime	readStartTime() Read the value of the StartTime Node from the server and update the local value if the operation succeeds.
CompletableFuture<? extends org.eclipse.milo.opcua.stack.core.types.builtin.DateTime>	readStartTimeAsync() An asynchronous implementation of ServerStatusType.readStartTime().
org.eclipse.milo.opcua.stack.core.types.enumerated.ServerState	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.ServerState>	readStateAsync() An asynchronous implementation of ServerStatusType.readState().
void	setBuildInfo(org.eclipse.milo.opcua.stack.core.types.structured.BuildInfo buildInfo) Set the local value of the BuildInfo Node.
void	setCurrentTime(org.eclipse.milo.opcua.stack.core.types.builtin.DateTime currentTime) Set the local value of the CurrentTime Node.
void	setSecondsTillShutdown(org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger secondsTillShutdown) Set the local value of the SecondsTillShutdown Node.
void	setShutdownReason(org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText shutdownReason) Set the local value of the ShutdownReason Node.
void	setStartTime(org.eclipse.milo.opcua.stack.core.types.builtin.DateTime startTime) Set the local value of the StartTime Node.
void	setState(org.eclipse.milo.opcua.stack.core.types.enumerated.ServerState state) Set the local value of the State Node.
void	writeBuildInfo(org.eclipse.milo.opcua.stack.core.types.structured.BuildInfo buildInfo) Write a new value for the BuildInfo Node to the server and update the local value if the operation succeeds.
CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode>	writeBuildInfoAsync(org.eclipse.milo.opcua.stack.core.types.structured.BuildInfo buildInfo) An asynchronous implementation of ServerStatusType.writeBuildInfo(BuildInfo).
void	writeCurrentTime(org.eclipse.milo.opcua.stack.core.types.builtin.DateTime currentTime) Write a new value for the CurrentTime Node to the server and update the local value if the operation succeeds.
CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode>	writeCurrentTimeAsync(org.eclipse.milo.opcua.stack.core.types.builtin.DateTime currentTime) An asynchronous implementation of ServerStatusType.writeCurrentTime(DateTime).
void	writeSecondsTillShutdown(org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger secondsTillShutdown) Write a new value for the SecondsTillShutdown Node to the server and update the local value if the operation succeeds.
CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode>	writeSecondsTillShutdownAsync(org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger secondsTillShutdown) An asynchronous implementation of ServerStatusType.writeSecondsTillShutdown(UInteger).
void	writeShutdownReason(org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText shutdownReason) Write a new value for the ShutdownReason Node to the server and update the local value if the operation succeeds.
CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode>	writeShutdownReasonAsync(org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText shutdownReason) An asynchronous implementation of ServerStatusType.writeShutdownReason(LocalizedText).
void	writeStartTime(org.eclipse.milo.opcua.stack.core.types.builtin.DateTime startTime) Write a new value for the StartTime Node to the server and update the local value if the operation succeeds.
CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode>	writeStartTimeAsync(org.eclipse.milo.opcua.stack.core.types.builtin.DateTime startTime) An asynchronous implementation of ServerStatusType.writeStartTime(DateTime).
void	writeState(org.eclipse.milo.opcua.stack.core.types.enumerated.ServerState state) 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.ServerState state) An asynchronous implementation of ServerStatusType.writeState(ServerState).

Methods inherited from class org.eclipse.milo.opcua.sdk.client.nodes.UaVariableNode

getAccessLevel, getArrayDimensions, getAttributeValue, getDataType, getHistorizing, getMinimumSamplingInterval, getTypeDefinition, getTypeDefinitionAsync, getUserAccessLevel, getValue, getValueRank, getVariableComponent, getVariableComponent, getVariableComponent, getVariableComponentAsync, getVariableComponentAsync, getVariableComponentAsync, readAccessLevel, readAllowNullsAsync, readArrayDimensions, readDataType, readDataTypeVersionAsync, readDictionaryFragmentAsync, readEngineeringUnitsAsync, readHistorizing, readLocalTimeAsync, readMaxArrayLengthAsync, readMaxStringLengthAsync, readMinimumSamplingInterval, readNodeVersionAsync, readUserAccessLevel, readValue, readValueAsTextAsync, readValueRank, setAccessLevel, setArrayDimensions, setAttributeValue, setDataType, setHistorizing, setMinimumSamplingInterval, setUserAccessLevel, setValue, setValue, setValueRank, writeAccessLevel, writeAllowNullsAsync, writeArrayDimensions, writeDataType, writeDataTypeVersionAsync, writeDictionaryFragmentAsync, writeEngineeringUnitsAsync, writeHistorizing, writeLocalTimeAsync, writeMaxArrayLengthAsync, writeMaxStringLengthAsync, writeMinimumSamplingInterval, writeNodeVersionAsync, writeUserAccessLevel, writeValue, writeValue, writeValueAsTextAsync, writeValueRank

Methods inherited from class org.eclipse.milo.opcua.sdk.client.nodes.UaNode

browse, browse, browseAsync, browseAsync, browseNodes, browseNodes, browseNodesAsync, browseNodesAsync, canonicalize, cast, findMemberNodeId, getBrowseName, getComponentAsync, getDescription, getDisplayName, getMemberNodeAsync, getNodeClass, getNodeId, getProperty, getPropertyNodeAsync, getPropertyNodeAsync, getUserWriteMask, getWriteMask, invalidate, readAttribute, readAttributeAsync, readBrowseName, readDescription, readDisplayName, readNamespaceIndex, readNodeClass, readNodeId, readProperty, readUserWriteMask, readWriteMask, refresh, refreshAsync, setBrowseName, setDescription, setDisplayName, setNodeClass, setNodeId, setProperty, setUserWriteMask, setWriteMask, synchronize, synchronizeAsync, writeAttribute, writeAttributeAsync, writeBrowseName, writeDescription, writeDisplayName, writeNodeClass, writeNodeId, writeProperty, writeUserWriteMask, writeWriteMask

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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

getAccessLevel, getArrayDimensions, getDataType, getHistorizing, getMinimumSamplingInterval, getUserAccessLevel, getValue, getValueRank, setAccessLevel, setArrayDimensions, setDataType, setHistorizing, setMinimumSamplingInterval, setUserAccessLevel, setValue, setValueRank

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

Constructor Detail

ServerStatusTypeNode

public ServerStatusTypeNode(OpcUaClient client,
                            org.eclipse.milo.opcua.stack.core.types.builtin.NodeId nodeId,
                            org.eclipse.milo.opcua.stack.core.types.enumerated.NodeClass nodeClass,
                            org.eclipse.milo.opcua.stack.core.types.builtin.QualifiedName browseName,
                            org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText displayName,
                            org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText description,
                            org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger writeMask,
                            org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger userWriteMask,
                            org.eclipse.milo.opcua.stack.core.types.builtin.DataValue value,
                            org.eclipse.milo.opcua.stack.core.types.builtin.NodeId dataType,
                            Integer valueRank,
                            org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger[] arrayDimensions,
                            org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UByte accessLevel,
                            org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UByte userAccessLevel,
                            Double minimumSamplingInterval,
                            Boolean historizing)

Method Detail

getStartTime

public org.eclipse.milo.opcua.stack.core.types.builtin.DateTime getStartTime()
                                                                      throws org.eclipse.milo.opcua.stack.core.UaException

Description copied from interface: ServerStatusType

Get the local value of the StartTime Node.

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

Specified by:

getStartTime in interface ServerStatusType

Returns:

the local value of the StartTime Node.

Throws:

org.eclipse.milo.opcua.stack.core.UaException - if an error occurs creating or getting the StartTime Node.

setStartTime

public void setStartTime(org.eclipse.milo.opcua.stack.core.types.builtin.DateTime startTime)
                  throws org.eclipse.milo.opcua.stack.core.UaException

Description copied from interface: ServerStatusType

Set the local value of the StartTime Node.

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

Specified by:

setStartTime in interface ServerStatusType

Parameters:

startTime - the local value to set for the StartTime Node.

Throws:

org.eclipse.milo.opcua.stack.core.UaException - if an error occurs creating or getting the StartTime Node.

readStartTime

public org.eclipse.milo.opcua.stack.core.types.builtin.DateTime readStartTime()
                                                                       throws org.eclipse.milo.opcua.stack.core.UaException

Description copied from interface: ServerStatusType

Read the value of the StartTime Node from the server and update the local value if the operation succeeds.

Specified by:

readStartTime in interface ServerStatusType

Returns:

the DateTime value read from the server.

Throws:

org.eclipse.milo.opcua.stack.core.UaException - if a service- or operation-level error occurs.

writeStartTime

public void writeStartTime(org.eclipse.milo.opcua.stack.core.types.builtin.DateTime startTime)
                    throws org.eclipse.milo.opcua.stack.core.UaException

Description copied from interface: ServerStatusType

Write a new value for the StartTime Node to the server and update the local value if the operation succeeds.

Specified by:

writeStartTime in interface ServerStatusType

Parameters:

startTime - the DateTime value to write to the server.

Throws:

org.eclipse.milo.opcua.stack.core.UaException - if a service- or operation-level error occurs.

readStartTimeAsync

public CompletableFuture<? extends org.eclipse.milo.opcua.stack.core.types.builtin.DateTime> readStartTimeAsync()

Description copied from interface: ServerStatusType

An asynchronous implementation of ServerStatusType.readStartTime().

Specified by:

readStartTimeAsync in interface ServerStatusType

Returns:

a CompletableFuture that completes successfully with the property value or completes exceptionally if an operation- or service-level error occurs.

writeStartTimeAsync

public CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode> writeStartTimeAsync(org.eclipse.milo.opcua.stack.core.types.builtin.DateTime startTime)

Description copied from interface: ServerStatusType

An asynchronous implementation of ServerStatusType.writeStartTime(DateTime).

Specified by:

writeStartTimeAsync in interface ServerStatusType

Returns:

a CompletableFuture that completes successfully with the operation result or completes exceptionally if a service-level error occurs.

getStartTimeNode

public BaseDataVariableTypeNode getStartTimeNode()
                                          throws org.eclipse.milo.opcua.stack.core.UaException

Description copied from interface: ServerStatusType

Get the StartTime BaseDataVariableType Node, or null if it does not exist.

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

Specified by:

getStartTimeNode in interface ServerStatusType

Returns:

the StartTime 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.

getStartTimeNodeAsync

public CompletableFuture<? extends BaseDataVariableTypeNode> getStartTimeNodeAsync()

Description copied from interface: ServerStatusType

Asynchronous implementation of ServerStatusType.getStartTimeNode().

Specified by:

getStartTimeNodeAsync in interface ServerStatusType

Returns:

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

getCurrentTime

public org.eclipse.milo.opcua.stack.core.types.builtin.DateTime getCurrentTime()
                                                                        throws org.eclipse.milo.opcua.stack.core.UaException

Description copied from interface: ServerStatusType

Get the local value of the CurrentTime Node.

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

Specified by:

getCurrentTime in interface ServerStatusType

Returns:

the local value of the CurrentTime Node.

Throws:

org.eclipse.milo.opcua.stack.core.UaException - if an error occurs creating or getting the CurrentTime Node.

setCurrentTime

public void setCurrentTime(org.eclipse.milo.opcua.stack.core.types.builtin.DateTime currentTime)
                    throws org.eclipse.milo.opcua.stack.core.UaException

Description copied from interface: ServerStatusType

Set the local value of the CurrentTime Node.

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

Specified by:

setCurrentTime in interface ServerStatusType

Parameters:

currentTime - the local value to set for the CurrentTime Node.

Throws:

org.eclipse.milo.opcua.stack.core.UaException - if an error occurs creating or getting the CurrentTime Node.

readCurrentTime

public org.eclipse.milo.opcua.stack.core.types.builtin.DateTime readCurrentTime()
                                                                         throws org.eclipse.milo.opcua.stack.core.UaException

Description copied from interface: ServerStatusType

Read the value of the CurrentTime Node from the server and update the local value if the operation succeeds.

Specified by:

readCurrentTime in interface ServerStatusType

Returns:

the DateTime value read from the server.

Throws:

org.eclipse.milo.opcua.stack.core.UaException - if a service- or operation-level error occurs.

writeCurrentTime

public void writeCurrentTime(org.eclipse.milo.opcua.stack.core.types.builtin.DateTime currentTime)
                      throws org.eclipse.milo.opcua.stack.core.UaException

Description copied from interface: ServerStatusType

Write a new value for the CurrentTime Node to the server and update the local value if the operation succeeds.

Specified by:

writeCurrentTime in interface ServerStatusType

Parameters:

currentTime - the DateTime value to write to the server.

Throws:

org.eclipse.milo.opcua.stack.core.UaException - if a service- or operation-level error occurs.

readCurrentTimeAsync

public CompletableFuture<? extends org.eclipse.milo.opcua.stack.core.types.builtin.DateTime> readCurrentTimeAsync()

Description copied from interface: ServerStatusType

An asynchronous implementation of ServerStatusType.readCurrentTime().

Specified by:

readCurrentTimeAsync in interface ServerStatusType

Returns:

a CompletableFuture that completes successfully with the property value or completes exceptionally if an operation- or service-level error occurs.

writeCurrentTimeAsync

public CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode> writeCurrentTimeAsync(org.eclipse.milo.opcua.stack.core.types.builtin.DateTime currentTime)

Description copied from interface: ServerStatusType

An asynchronous implementation of ServerStatusType.writeCurrentTime(DateTime).

Specified by:

writeCurrentTimeAsync in interface ServerStatusType

Returns:

a CompletableFuture that completes successfully with the operation result or completes exceptionally if a service-level error occurs.

getCurrentTimeNode

public BaseDataVariableTypeNode getCurrentTimeNode()
                                            throws org.eclipse.milo.opcua.stack.core.UaException

Description copied from interface: ServerStatusType

Get the CurrentTime BaseDataVariableType Node, or null if it does not exist.

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

Specified by:

getCurrentTimeNode in interface ServerStatusType

Returns:

the CurrentTime 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.

getCurrentTimeNodeAsync

public CompletableFuture<? extends BaseDataVariableTypeNode> getCurrentTimeNodeAsync()

Description copied from interface: ServerStatusType

Asynchronous implementation of ServerStatusType.getCurrentTimeNode().

Specified by:

getCurrentTimeNodeAsync in interface ServerStatusType

Returns:

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

getState

public org.eclipse.milo.opcua.stack.core.types.enumerated.ServerState getState()
                                                                        throws org.eclipse.milo.opcua.stack.core.UaException

Description copied from interface: ServerStatusType

Get the local value of the State Node.

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

Specified by:

getState in interface ServerStatusType

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

public void setState(org.eclipse.milo.opcua.stack.core.types.enumerated.ServerState state)
              throws org.eclipse.milo.opcua.stack.core.UaException

Description copied from interface: ServerStatusType

Set the local value of the State Node.

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

Specified by:

setState in interface ServerStatusType

Parameters:

state - 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

public org.eclipse.milo.opcua.stack.core.types.enumerated.ServerState readState()
                                                                         throws org.eclipse.milo.opcua.stack.core.UaException

Description copied from interface: ServerStatusType

Read the value of the State Node from the server and update the local value if the operation succeeds.

Specified by:

readState in interface ServerStatusType

Returns:

the ServerState value read from the server.

Throws:

org.eclipse.milo.opcua.stack.core.UaException - if a service- or operation-level error occurs.

writeState

public void writeState(org.eclipse.milo.opcua.stack.core.types.enumerated.ServerState state)
                throws org.eclipse.milo.opcua.stack.core.UaException

Description copied from interface: ServerStatusType

Write a new value for the State Node to the server and update the local value if the operation succeeds.

Specified by:

writeState in interface ServerStatusType

Parameters:

state - the ServerState value to write to the server.

Throws:

org.eclipse.milo.opcua.stack.core.UaException - if a service- or operation-level error occurs.

readStateAsync

public CompletableFuture<? extends org.eclipse.milo.opcua.stack.core.types.enumerated.ServerState> readStateAsync()

Description copied from interface: ServerStatusType

An asynchronous implementation of ServerStatusType.readState().

Specified by:

readStateAsync in interface ServerStatusType

Returns:

a CompletableFuture that completes successfully with the property value or completes exceptionally if an operation- or service-level error occurs.

writeStateAsync

public CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode> writeStateAsync(org.eclipse.milo.opcua.stack.core.types.enumerated.ServerState state)

Description copied from interface: ServerStatusType

An asynchronous implementation of ServerStatusType.writeState(ServerState).

Specified by:

writeStateAsync in interface ServerStatusType

Returns:

a CompletableFuture that completes successfully with the operation result or completes exceptionally if a service-level error occurs.

getStateNode

public BaseDataVariableTypeNode getStateNode()
                                      throws org.eclipse.milo.opcua.stack.core.UaException

Description copied from interface: ServerStatusType

Get the State BaseDataVariableType Node, or null if it does not exist.

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

Specified by:

getStateNode in interface ServerStatusType

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

public CompletableFuture<? extends BaseDataVariableTypeNode> getStateNodeAsync()

Description copied from interface: ServerStatusType

Asynchronous implementation of ServerStatusType.getStateNode().

Specified by:

getStateNodeAsync in interface ServerStatusType

Returns:

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

getBuildInfo

public org.eclipse.milo.opcua.stack.core.types.structured.BuildInfo getBuildInfo()
                                                                          throws org.eclipse.milo.opcua.stack.core.UaException

Description copied from interface: ServerStatusType

Get the local value of the BuildInfo Node.

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

Specified by:

getBuildInfo in interface ServerStatusType

Returns:

the local value of the BuildInfo Node.

Throws:

org.eclipse.milo.opcua.stack.core.UaException - if an error occurs creating or getting the BuildInfo Node.

setBuildInfo

public void setBuildInfo(org.eclipse.milo.opcua.stack.core.types.structured.BuildInfo buildInfo)
                  throws org.eclipse.milo.opcua.stack.core.UaException

Description copied from interface: ServerStatusType

Set the local value of the BuildInfo Node.

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

Specified by:

setBuildInfo in interface ServerStatusType

Parameters:

buildInfo - the local value to set for the BuildInfo Node.

Throws:

org.eclipse.milo.opcua.stack.core.UaException - if an error occurs creating or getting the BuildInfo Node.

readBuildInfo

public org.eclipse.milo.opcua.stack.core.types.structured.BuildInfo readBuildInfo()
                                                                           throws org.eclipse.milo.opcua.stack.core.UaException

Description copied from interface: ServerStatusType

Read the value of the BuildInfo Node from the server and update the local value if the operation succeeds.

Specified by:

readBuildInfo in interface ServerStatusType

Returns:

the BuildInfo value read from the server.

Throws:

org.eclipse.milo.opcua.stack.core.UaException - if a service- or operation-level error occurs.

writeBuildInfo

public void writeBuildInfo(org.eclipse.milo.opcua.stack.core.types.structured.BuildInfo buildInfo)
                    throws org.eclipse.milo.opcua.stack.core.UaException

Description copied from interface: ServerStatusType

Write a new value for the BuildInfo Node to the server and update the local value if the operation succeeds.

Specified by:

writeBuildInfo in interface ServerStatusType

Parameters:

buildInfo - the BuildInfo value to write to the server.

Throws:

org.eclipse.milo.opcua.stack.core.UaException - if a service- or operation-level error occurs.

readBuildInfoAsync

public CompletableFuture<? extends org.eclipse.milo.opcua.stack.core.types.structured.BuildInfo> readBuildInfoAsync()

Description copied from interface: ServerStatusType

An asynchronous implementation of ServerStatusType.readBuildInfo().

Specified by:

readBuildInfoAsync in interface ServerStatusType

Returns:

a CompletableFuture that completes successfully with the property value or completes exceptionally if an operation- or service-level error occurs.

writeBuildInfoAsync

public CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode> writeBuildInfoAsync(org.eclipse.milo.opcua.stack.core.types.structured.BuildInfo buildInfo)

Description copied from interface: ServerStatusType

An asynchronous implementation of ServerStatusType.writeBuildInfo(BuildInfo).

Specified by:

writeBuildInfoAsync in interface ServerStatusType

Returns:

a CompletableFuture that completes successfully with the operation result or completes exceptionally if a service-level error occurs.

getBuildInfoNode

public BuildInfoTypeNode getBuildInfoNode()
                                   throws org.eclipse.milo.opcua.stack.core.UaException

Description copied from interface: ServerStatusType

Get the BuildInfo BuildInfoType Node, or null if it does not exist.

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

Specified by:

getBuildInfoNode in interface ServerStatusType

Returns:

the BuildInfo BuildInfoType 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.

getBuildInfoNodeAsync

public CompletableFuture<? extends BuildInfoTypeNode> getBuildInfoNodeAsync()

Description copied from interface: ServerStatusType

Asynchronous implementation of ServerStatusType.getBuildInfoNode().

Specified by:

getBuildInfoNodeAsync in interface ServerStatusType

Returns:

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

getSecondsTillShutdown

public org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger getSecondsTillShutdown()
                                                                                         throws org.eclipse.milo.opcua.stack.core.UaException

Description copied from interface: ServerStatusType

Get the local value of the SecondsTillShutdown Node.

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

Specified by:

getSecondsTillShutdown in interface ServerStatusType

Returns:

the local value of the SecondsTillShutdown Node.

Throws:

org.eclipse.milo.opcua.stack.core.UaException - if an error occurs creating or getting the SecondsTillShutdown Node.

setSecondsTillShutdown

public void setSecondsTillShutdown(org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger secondsTillShutdown)
                            throws org.eclipse.milo.opcua.stack.core.UaException

Description copied from interface: ServerStatusType

Set the local value of the SecondsTillShutdown Node.

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

Specified by:

setSecondsTillShutdown in interface ServerStatusType

Parameters:

secondsTillShutdown - the local value to set for the SecondsTillShutdown Node.

Throws:

org.eclipse.milo.opcua.stack.core.UaException - if an error occurs creating or getting the SecondsTillShutdown Node.

readSecondsTillShutdown

public org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger readSecondsTillShutdown()
                                                                                          throws org.eclipse.milo.opcua.stack.core.UaException

Description copied from interface: ServerStatusType

Read the value of the SecondsTillShutdown Node from the server and update the local value if the operation succeeds.

Specified by:

readSecondsTillShutdown in interface ServerStatusType

Returns:

the UInteger value read from the server.

Throws:

org.eclipse.milo.opcua.stack.core.UaException - if a service- or operation-level error occurs.

writeSecondsTillShutdown

public void writeSecondsTillShutdown(org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger secondsTillShutdown)
                              throws org.eclipse.milo.opcua.stack.core.UaException

Description copied from interface: ServerStatusType

Write a new value for the SecondsTillShutdown Node to the server and update the local value if the operation succeeds.

Specified by:

writeSecondsTillShutdown in interface ServerStatusType

Parameters:

secondsTillShutdown - the UInteger value to write to the server.

Throws:

org.eclipse.milo.opcua.stack.core.UaException - if a service- or operation-level error occurs.

readSecondsTillShutdownAsync

public CompletableFuture<? extends org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger> readSecondsTillShutdownAsync()

Description copied from interface: ServerStatusType

An asynchronous implementation of ServerStatusType.readSecondsTillShutdown().

Specified by:

readSecondsTillShutdownAsync in interface ServerStatusType

Returns:

a CompletableFuture that completes successfully with the property value or completes exceptionally if an operation- or service-level error occurs.

writeSecondsTillShutdownAsync

public CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode> writeSecondsTillShutdownAsync(org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger secondsTillShutdown)

Description copied from interface: ServerStatusType

An asynchronous implementation of ServerStatusType.writeSecondsTillShutdown(UInteger).

Specified by:

writeSecondsTillShutdownAsync in interface ServerStatusType

Returns:

a CompletableFuture that completes successfully with the operation result or completes exceptionally if a service-level error occurs.

getSecondsTillShutdownNode

public BaseDataVariableTypeNode getSecondsTillShutdownNode()
                                                    throws org.eclipse.milo.opcua.stack.core.UaException

Description copied from interface: ServerStatusType

Get the SecondsTillShutdown BaseDataVariableType Node, or null if it does not exist.

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

Specified by:

getSecondsTillShutdownNode in interface ServerStatusType

Returns:

the SecondsTillShutdown 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.

getSecondsTillShutdownNodeAsync

public CompletableFuture<? extends BaseDataVariableTypeNode> getSecondsTillShutdownNodeAsync()

Description copied from interface: ServerStatusType

Asynchronous implementation of ServerStatusType.getSecondsTillShutdownNode().

Specified by:

getSecondsTillShutdownNodeAsync in interface ServerStatusType

Returns:

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

getShutdownReason

public org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText getShutdownReason()
                                                                                throws org.eclipse.milo.opcua.stack.core.UaException

Description copied from interface: ServerStatusType

Get the local value of the ShutdownReason Node.

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

Specified by:

getShutdownReason in interface ServerStatusType

Returns:

the local value of the ShutdownReason Node.

Throws:

org.eclipse.milo.opcua.stack.core.UaException - if an error occurs creating or getting the ShutdownReason Node.

setShutdownReason

public void setShutdownReason(org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText shutdownReason)
                       throws org.eclipse.milo.opcua.stack.core.UaException

Description copied from interface: ServerStatusType

Set the local value of the ShutdownReason Node.

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

Specified by:

setShutdownReason in interface ServerStatusType

Parameters:

shutdownReason - the local value to set for the ShutdownReason Node.

Throws:

org.eclipse.milo.opcua.stack.core.UaException - if an error occurs creating or getting the ShutdownReason Node.

readShutdownReason

public org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText readShutdownReason()
                                                                                 throws org.eclipse.milo.opcua.stack.core.UaException

Description copied from interface: ServerStatusType

Read the value of the ShutdownReason Node from the server and update the local value if the operation succeeds.

Specified by:

readShutdownReason in interface ServerStatusType

Returns:

the LocalizedText value read from the server.

Throws:

org.eclipse.milo.opcua.stack.core.UaException - if a service- or operation-level error occurs.

writeShutdownReason

public void writeShutdownReason(org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText shutdownReason)
                         throws org.eclipse.milo.opcua.stack.core.UaException

Description copied from interface: ServerStatusType

Write a new value for the ShutdownReason Node to the server and update the local value if the operation succeeds.

Specified by:

writeShutdownReason in interface ServerStatusType

Parameters:

shutdownReason - the LocalizedText value to write to the server.

Throws:

org.eclipse.milo.opcua.stack.core.UaException - if a service- or operation-level error occurs.

readShutdownReasonAsync

public CompletableFuture<? extends org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText> readShutdownReasonAsync()

Description copied from interface: ServerStatusType

An asynchronous implementation of ServerStatusType.readShutdownReason().

Specified by:

readShutdownReasonAsync in interface ServerStatusType

Returns:

a CompletableFuture that completes successfully with the property value or completes exceptionally if an operation- or service-level error occurs.

writeShutdownReasonAsync

public CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode> writeShutdownReasonAsync(org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText shutdownReason)

Description copied from interface: ServerStatusType

An asynchronous implementation of ServerStatusType.writeShutdownReason(LocalizedText).

Specified by:

writeShutdownReasonAsync in interface ServerStatusType

Returns:

a CompletableFuture that completes successfully with the operation result or completes exceptionally if a service-level error occurs.

getShutdownReasonNode

public BaseDataVariableTypeNode getShutdownReasonNode()
                                               throws org.eclipse.milo.opcua.stack.core.UaException

Description copied from interface: ServerStatusType

Get the ShutdownReason BaseDataVariableType Node, or null if it does not exist.

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

Specified by:

getShutdownReasonNode in interface ServerStatusType

Returns:

the ShutdownReason 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.

getShutdownReasonNodeAsync

public CompletableFuture<? extends BaseDataVariableTypeNode> getShutdownReasonNodeAsync()

Description copied from interface: ServerStatusType

Asynchronous implementation of ServerStatusType.getShutdownReasonNode().

Specified by:

getShutdownReasonNodeAsync in interface ServerStatusType

Returns:

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