Module org.eclipse.milo.opcua.sdk.client

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

Class PubSubStatusEventTypeNode

java.lang.Object

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

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

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

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

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

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

All Implemented Interfaces:

BaseEventType, BaseObjectType, PubSubStatusEventType, SystemEventType, org.eclipse.milo.opcua.sdk.core.nodes.Node, org.eclipse.milo.opcua.sdk.core.nodes.ObjectNode

Direct Known Subclasses:

PubSubCommunicationFailureEventTypeNode, PubSubTransportLimitsExceedEventTypeNode

public class PubSubStatusEventTypeNode
extends SystemEventTypeNode
implements PubSubStatusEventType

Field Summary

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

client

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

CONDITION_CLASS_ID, CONDITION_CLASS_NAME, CONDITION_SUB_CLASS_ID, CONDITION_SUB_CLASS_NAME, EVENT_ID, EVENT_TYPE, LOCAL_TIME, MESSAGE, RECEIVE_TIME, SEVERITY, SOURCE_NAME, SOURCE_NODE, TIME

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

CONNECTION_ID, GROUP_ID, STATE

Constructor Summary

Constructors

Constructor

Description

PubSubStatusEventTypeNode(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.structured.RolePermissionType[] rolePermissions, org.eclipse.milo.opcua.stack.core.types.structured.RolePermissionType[] userRolePermissions, org.eclipse.milo.opcua.stack.core.types.structured.AccessRestrictionType accessRestrictions, org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UByte eventNotifier)

Method Summary

Modifier and Type	Method	Description
org.eclipse.milo.opcua.stack.core.types.builtin.NodeId	getConnectionId()	Get the local value of the ConnectionId Node.
PropertyTypeNode	getConnectionIdNode()	Get the ConnectionId PropertyType Node, or null if it does not exist.
CompletableFuture<? extends PropertyTypeNode>	getConnectionIdNodeAsync()	Asynchronous implementation of PubSubStatusEventType.getConnectionIdNode().
org.eclipse.milo.opcua.stack.core.types.builtin.NodeId	getGroupId()	Get the local value of the GroupId Node.
PropertyTypeNode	getGroupIdNode()	Get the GroupId PropertyType Node, or null if it does not exist.
CompletableFuture<? extends PropertyTypeNode>	getGroupIdNodeAsync()	Asynchronous implementation of PubSubStatusEventType.getGroupIdNode().
org.eclipse.milo.opcua.stack.core.types.enumerated.PubSubState	getState()	Get the local value of the State Node.
PropertyTypeNode	getStateNode()	Get the State PropertyType Node, or null if it does not exist.
CompletableFuture<? extends PropertyTypeNode>	getStateNodeAsync()	Asynchronous implementation of PubSubStatusEventType.getStateNode().
org.eclipse.milo.opcua.stack.core.types.builtin.NodeId	readConnectionId()	Read the value of the ConnectionId Node from the server and update the local value if the operation succeeds.
CompletableFuture<? extends org.eclipse.milo.opcua.stack.core.types.builtin.NodeId>	readConnectionIdAsync()	An asynchronous implementation of PubSubStatusEventType.readConnectionId().
org.eclipse.milo.opcua.stack.core.types.builtin.NodeId	readGroupId()	Read the value of the GroupId Node from the server and update the local value if the operation succeeds.
CompletableFuture<? extends org.eclipse.milo.opcua.stack.core.types.builtin.NodeId>	readGroupIdAsync()	An asynchronous implementation of PubSubStatusEventType.readGroupId().
org.eclipse.milo.opcua.stack.core.types.enumerated.PubSubState	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.PubSubState>	readStateAsync()	An asynchronous implementation of PubSubStatusEventType.readState().
void	setConnectionId(org.eclipse.milo.opcua.stack.core.types.builtin.NodeId value)	Set the local value of the ConnectionId Node.
void	setGroupId(org.eclipse.milo.opcua.stack.core.types.builtin.NodeId value)	Set the local value of the GroupId Node.
void	setState(org.eclipse.milo.opcua.stack.core.types.enumerated.PubSubState value)	Set the local value of the State Node.
void	writeConnectionId(org.eclipse.milo.opcua.stack.core.types.builtin.NodeId value)	Write a new value for the ConnectionId Node to the server and update the local value if the operation succeeds.
CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode>	writeConnectionIdAsync(org.eclipse.milo.opcua.stack.core.types.builtin.NodeId connectionId)	An asynchronous implementation of PubSubStatusEventType.writeConnectionId(org.eclipse.milo.opcua.stack.core.types.builtin.NodeId).
void	writeGroupId(org.eclipse.milo.opcua.stack.core.types.builtin.NodeId value)	Write a new value for the GroupId Node to the server and update the local value if the operation succeeds.
CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode>	writeGroupIdAsync(org.eclipse.milo.opcua.stack.core.types.builtin.NodeId groupId)	An asynchronous implementation of PubSubStatusEventType.writeGroupId(org.eclipse.milo.opcua.stack.core.types.builtin.NodeId).
void	writeState(org.eclipse.milo.opcua.stack.core.types.enumerated.PubSubState value)	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.PubSubState state)	An asynchronous implementation of PubSubStatusEventType.writeState(org.eclipse.milo.opcua.stack.core.types.enumerated.PubSubState).

Methods inherited from class org.eclipse.milo.opcua.sdk.client.model.objects.BaseEventTypeNode

getConditionClassId, getConditionClassIdNode, getConditionClassIdNodeAsync, getConditionClassName, getConditionClassNameNode, getConditionClassNameNodeAsync, getConditionSubClassId, getConditionSubClassIdNode, getConditionSubClassIdNodeAsync, getConditionSubClassName, getConditionSubClassNameNode, getConditionSubClassNameNodeAsync, getEventId, getEventIdNode, getEventIdNodeAsync, getEventType, getEventTypeNode, getEventTypeNodeAsync, getLocalTime, getLocalTimeNode, getLocalTimeNodeAsync, getMessage, getMessageNode, getMessageNodeAsync, getReceiveTime, getReceiveTimeNode, getReceiveTimeNodeAsync, getSeverity, getSeverityNode, getSeverityNodeAsync, getSourceName, getSourceNameNode, getSourceNameNodeAsync, getSourceNode, getSourceNodeNode, getSourceNodeNodeAsync, getTime, getTimeNode, getTimeNodeAsync, readConditionClassId, readConditionClassIdAsync, readConditionClassName, readConditionClassNameAsync, readConditionSubClassId, readConditionSubClassIdAsync, readConditionSubClassName, readConditionSubClassNameAsync, readEventId, readEventIdAsync, readEventType, readEventTypeAsync, readLocalTime, readLocalTimeAsync, readMessage, readMessageAsync, readReceiveTime, readReceiveTimeAsync, readSeverity, readSeverityAsync, readSourceName, readSourceNameAsync, readSourceNode, readSourceNodeAsync, readTime, readTimeAsync, setConditionClassId, setConditionClassName, setConditionSubClassId, setConditionSubClassName, setEventId, setEventType, setLocalTime, setMessage, setReceiveTime, setSeverity, setSourceName, setSourceNode, setTime, writeConditionClassId, writeConditionClassIdAsync, writeConditionClassName, writeConditionClassNameAsync, writeConditionSubClassId, writeConditionSubClassIdAsync, writeConditionSubClassName, writeConditionSubClassNameAsync, writeEventId, writeEventIdAsync, writeEventType, writeEventTypeAsync, writeLocalTime, writeLocalTimeAsync, writeMessage, writeMessageAsync, writeReceiveTime, writeReceiveTimeAsync, writeSeverity, writeSeverityAsync, writeSourceName, writeSourceNameAsync, writeSourceNode, writeSourceNodeAsync, writeTime, writeTimeAsync

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

callMethod, callMethod, callMethodAsync, callMethodAsync, getAttributeValue, getEventNotifier, getIconAsync, getMethod, getMethod, getMethodAsync, getMethodAsync, getNamingRuleAsync, getNodeVersionAsync, getObjectComponent, getObjectComponent, getObjectComponent, getObjectComponentAsync, getObjectComponentAsync, getObjectComponentAsync, getTypeDefinition, getTypeDefinitionAsync, getVariableComponent, getVariableComponent, getVariableComponent, getVariableComponentAsync, getVariableComponentAsync, getVariableComponentAsync, readEventNotifier, setAttributeValue, setEventNotifier, setIconAsync, setNamingRuleAsync, setNodeVersionAsync, writeEventNotifier

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

browse, browse, browseAsync, browseAsync, browseNodes, browseNodes, browseNodesAsync, browseNodesAsync, canonicalize, cast, findMemberNodeId, getAccessRestrictions, getBrowseName, getComponentAsync, getDescription, getDisplayName, getMemberNodeAsync, getNodeClass, getNodeId, getProperty, getPropertyNodeAsync, getPropertyNodeAsync, getRolePermissions, getUserRolePermissions, getUserWriteMask, getWriteMask, invalidate, readAccessRestrictions, readAttribute, readAttributeAsync, readBrowseName, readDescription, readDisplayName, readNamespaceIndex, readNodeClass, readNodeId, readProperty, readRolePermissions, readUserRolePermissions, readUserWriteMask, readWriteMask, refresh, refreshAsync, setAccessRestrictions, setBrowseName, setDescription, setDisplayName, setNodeClass, setNodeId, setProperty, setRolePermissions, setUserRolePermissions, setUserWriteMask, setWriteMask, synchronize, synchronizeAsync, writeAccessRestrictions, writeAttribute, writeAttributeAsync, writeBrowseName, writeDescription, writeDisplayName, writeNodeClass, writeNodeId, writeProperty, writeRolePermissions, writeUserRolePermissions, 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.client.model.objects.BaseEventType

getConditionClassId, getConditionClassIdNode, getConditionClassIdNodeAsync, getConditionClassName, getConditionClassNameNode, getConditionClassNameNodeAsync, getConditionSubClassId, getConditionSubClassIdNode, getConditionSubClassIdNodeAsync, getConditionSubClassName, getConditionSubClassNameNode, getConditionSubClassNameNodeAsync, getEventId, getEventIdNode, getEventIdNodeAsync, getEventType, getEventTypeNode, getEventTypeNodeAsync, getLocalTime, getLocalTimeNode, getLocalTimeNodeAsync, getMessage, getMessageNode, getMessageNodeAsync, getReceiveTime, getReceiveTimeNode, getReceiveTimeNodeAsync, getSeverity, getSeverityNode, getSeverityNodeAsync, getSourceName, getSourceNameNode, getSourceNameNodeAsync, getSourceNode, getSourceNodeNode, getSourceNodeNodeAsync, getTime, getTimeNode, getTimeNodeAsync, readConditionClassId, readConditionClassIdAsync, readConditionClassName, readConditionClassNameAsync, readConditionSubClassId, readConditionSubClassIdAsync, readConditionSubClassName, readConditionSubClassNameAsync, readEventId, readEventIdAsync, readEventType, readEventTypeAsync, readLocalTime, readLocalTimeAsync, readMessage, readMessageAsync, readReceiveTime, readReceiveTimeAsync, readSeverity, readSeverityAsync, readSourceName, readSourceNameAsync, readSourceNode, readSourceNodeAsync, readTime, readTimeAsync, setConditionClassId, setConditionClassName, setConditionSubClassId, setConditionSubClassName, setEventId, setEventType, setLocalTime, setMessage, setReceiveTime, setSeverity, setSourceName, setSourceNode, setTime, writeConditionClassId, writeConditionClassIdAsync, writeConditionClassName, writeConditionClassNameAsync, writeConditionSubClassId, writeConditionSubClassIdAsync, writeConditionSubClassName, writeConditionSubClassNameAsync, writeEventId, writeEventIdAsync, writeEventType, writeEventTypeAsync, writeLocalTime, writeLocalTimeAsync, writeMessage, writeMessageAsync, writeReceiveTime, writeReceiveTimeAsync, writeSeverity, writeSeverityAsync, writeSourceName, writeSourceNameAsync, writeSourceNode, writeSourceNodeAsync, writeTime, writeTimeAsync

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

getAccessRestrictions, getBrowseName, getDescription, getDisplayName, getNodeClass, getNodeId, getRolePermissions, getUserRolePermissions, getUserWriteMask, getWriteMask, setAccessRestrictions, setBrowseName, setDescription, setDisplayName, setNodeClass, setNodeId, setRolePermissions, setUserRolePermissions, setUserWriteMask, setWriteMask

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

getEventNotifier, setEventNotifier

Constructor Details

PubSubStatusEventTypeNode

public PubSubStatusEventTypeNode(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.structured.RolePermissionType[] rolePermissions,
 org.eclipse.milo.opcua.stack.core.types.structured.RolePermissionType[] userRolePermissions,
 org.eclipse.milo.opcua.stack.core.types.structured.AccessRestrictionType accessRestrictions,
 org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UByte eventNotifier)

Method Details

getConnectionId

public org.eclipse.milo.opcua.stack.core.types.builtin.NodeId getConnectionId()
                                                                       throws org.eclipse.milo.opcua.stack.core.UaException

Description copied from interface: PubSubStatusEventType

Get the local value of the ConnectionId Node.

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

Specified by:

getConnectionId in interface PubSubStatusEventType

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

public void setConnectionId(org.eclipse.milo.opcua.stack.core.types.builtin.NodeId value)
                     throws org.eclipse.milo.opcua.stack.core.UaException

Description copied from interface: PubSubStatusEventType

Set the local value of the ConnectionId Node.

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

Specified by:

setConnectionId in interface PubSubStatusEventType

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

public org.eclipse.milo.opcua.stack.core.types.builtin.NodeId readConnectionId()
                                                                        throws org.eclipse.milo.opcua.stack.core.UaException

Description copied from interface: PubSubStatusEventType

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

Specified by:

readConnectionId in interface PubSubStatusEventType

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

public void writeConnectionId(org.eclipse.milo.opcua.stack.core.types.builtin.NodeId value)
                       throws org.eclipse.milo.opcua.stack.core.UaException

Description copied from interface: PubSubStatusEventType

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

Specified by:

writeConnectionId in interface PubSubStatusEventType

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

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

Description copied from interface: PubSubStatusEventType

An asynchronous implementation of PubSubStatusEventType.readConnectionId().

Specified by:

readConnectionIdAsync in interface PubSubStatusEventType

Returns:

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

writeConnectionIdAsync

public CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode> writeConnectionIdAsync(org.eclipse.milo.opcua.stack.core.types.builtin.NodeId connectionId)

Description copied from interface: PubSubStatusEventType

An asynchronous implementation of PubSubStatusEventType.writeConnectionId(org.eclipse.milo.opcua.stack.core.types.builtin.NodeId).

Specified by:

writeConnectionIdAsync in interface PubSubStatusEventType

Returns:

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

getConnectionIdNode

public PropertyTypeNode getConnectionIdNode()
                                     throws org.eclipse.milo.opcua.stack.core.UaException

Description copied from interface: PubSubStatusEventType

Get the ConnectionId PropertyType Node, or null if it does not exist.

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

Specified by:

getConnectionIdNode in interface PubSubStatusEventType

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

public CompletableFuture<? extends PropertyTypeNode> getConnectionIdNodeAsync()

Description copied from interface: PubSubStatusEventType

Asynchronous implementation of PubSubStatusEventType.getConnectionIdNode().

Specified by:

getConnectionIdNodeAsync in interface PubSubStatusEventType

Returns:

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

getGroupId

public org.eclipse.milo.opcua.stack.core.types.builtin.NodeId getGroupId()
                                                                  throws org.eclipse.milo.opcua.stack.core.UaException

Description copied from interface: PubSubStatusEventType

Get the local value of the GroupId Node.

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

Specified by:

getGroupId in interface PubSubStatusEventType

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

public void setGroupId(org.eclipse.milo.opcua.stack.core.types.builtin.NodeId value)
                throws org.eclipse.milo.opcua.stack.core.UaException

Description copied from interface: PubSubStatusEventType

Set the local value of the GroupId Node.

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

Specified by:

setGroupId in interface PubSubStatusEventType

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

public org.eclipse.milo.opcua.stack.core.types.builtin.NodeId readGroupId()
                                                                   throws org.eclipse.milo.opcua.stack.core.UaException

Description copied from interface: PubSubStatusEventType

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

Specified by:

readGroupId in interface PubSubStatusEventType

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

public void writeGroupId(org.eclipse.milo.opcua.stack.core.types.builtin.NodeId value)
                  throws org.eclipse.milo.opcua.stack.core.UaException

Description copied from interface: PubSubStatusEventType

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

Specified by:

writeGroupId in interface PubSubStatusEventType

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

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

Description copied from interface: PubSubStatusEventType

An asynchronous implementation of PubSubStatusEventType.readGroupId().

Specified by:

readGroupIdAsync in interface PubSubStatusEventType

Returns:

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

writeGroupIdAsync

public CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode> writeGroupIdAsync(org.eclipse.milo.opcua.stack.core.types.builtin.NodeId groupId)

Description copied from interface: PubSubStatusEventType

An asynchronous implementation of PubSubStatusEventType.writeGroupId(org.eclipse.milo.opcua.stack.core.types.builtin.NodeId).

Specified by:

writeGroupIdAsync in interface PubSubStatusEventType

Returns:

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

getGroupIdNode

public PropertyTypeNode getGroupIdNode()
                                throws org.eclipse.milo.opcua.stack.core.UaException

Description copied from interface: PubSubStatusEventType

Get the GroupId PropertyType Node, or null if it does not exist.

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

Specified by:

getGroupIdNode in interface PubSubStatusEventType

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

public CompletableFuture<? extends PropertyTypeNode> getGroupIdNodeAsync()

Description copied from interface: PubSubStatusEventType

Asynchronous implementation of PubSubStatusEventType.getGroupIdNode().

Specified by:

getGroupIdNodeAsync in interface PubSubStatusEventType

Returns:

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

getState

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

Description copied from interface: PubSubStatusEventType

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 PubSubStatusEventType

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.PubSubState value)
              throws org.eclipse.milo.opcua.stack.core.UaException

Description copied from interface: PubSubStatusEventType

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 PubSubStatusEventType

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

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

Description copied from interface: PubSubStatusEventType

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

Specified by:

readState in interface PubSubStatusEventType

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

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

Description copied from interface: PubSubStatusEventType

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 PubSubStatusEventType

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

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

Description copied from interface: PubSubStatusEventType

An asynchronous implementation of PubSubStatusEventType.readState().

Specified by:

readStateAsync in interface PubSubStatusEventType

Returns:

a CompletableFuture that completes successfully with the 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.PubSubState state)

Description copied from interface: PubSubStatusEventType

An asynchronous implementation of PubSubStatusEventType.writeState(org.eclipse.milo.opcua.stack.core.types.enumerated.PubSubState).

Specified by:

writeStateAsync in interface PubSubStatusEventType

Returns:

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

getStateNode

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

Description copied from interface: PubSubStatusEventType

Get the State PropertyType 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 PubSubStatusEventType

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

public CompletableFuture<? extends PropertyTypeNode> getStateNodeAsync()

Description copied from interface: PubSubStatusEventType

Asynchronous implementation of PubSubStatusEventType.getStateNode().

Specified by:

getStateNodeAsync in interface PubSubStatusEventType

Returns:

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