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

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

Class PubSubCommunicationFailureEventTypeNode

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

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

All Implemented Interfaces:

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

public class PubSubCommunicationFailureEventTypeNode
extends PubSubStatusEventTypeNode
implements PubSubCommunicationFailureEventType

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

ERROR

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

CONNECTION_ID, GROUP_ID, STATE

Constructor Summary

Constructors

Constructor

Description

PubSubCommunicationFailureEventTypeNode(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.StatusCode	getError()	Get the local value of the Error Node.
PropertyTypeNode	getErrorNode()	Get the Error PropertyType Node, or null if it does not exist.
CompletableFuture<? extends PropertyTypeNode>	getErrorNodeAsync()	Asynchronous implementation of PubSubCommunicationFailureEventType.getErrorNode().
org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode	readError()	Read the value of the Error Node from the server and update the local value if the operation succeeds.
CompletableFuture<? extends org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode>	readErrorAsync()	An asynchronous implementation of PubSubCommunicationFailureEventType.readError().
void	setError(org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode value)	Set the local value of the Error Node.
void	writeError(org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode value)	Write a new value for the Error Node to the server and update the local value if the operation succeeds.
CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode>	writeErrorAsync(org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode error)	An asynchronous implementation of PubSubCommunicationFailureEventType.writeError(org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode).

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

getConnectionId, getConnectionIdNode, getConnectionIdNodeAsync, getGroupId, getGroupIdNode, getGroupIdNodeAsync, getState, getStateNode, getStateNodeAsync, readConnectionId, readConnectionIdAsync, readGroupId, readGroupIdAsync, readState, readStateAsync, setConnectionId, setGroupId, setState, writeConnectionId, writeConnectionIdAsync, writeGroupId, writeGroupIdAsync, writeState, writeStateAsync

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

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

getConnectionId, getConnectionIdNode, getConnectionIdNodeAsync, getGroupId, getGroupIdNode, getGroupIdNodeAsync, getState, getStateNode, getStateNodeAsync, readConnectionId, readConnectionIdAsync, readGroupId, readGroupIdAsync, readState, readStateAsync, setConnectionId, setGroupId, setState, writeConnectionId, writeConnectionIdAsync, writeGroupId, writeGroupIdAsync, writeState, writeStateAsync

Constructor Details

PubSubCommunicationFailureEventTypeNode

public PubSubCommunicationFailureEventTypeNode(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

getError

public org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode getError()
                                                                    throws org.eclipse.milo.opcua.stack.core.UaException

Description copied from interface: PubSubCommunicationFailureEventType

Get the local value of the Error Node.

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

Specified by:

getError in interface PubSubCommunicationFailureEventType

Returns:

the local value of the Error Node.

Throws:

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

setError

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

Description copied from interface: PubSubCommunicationFailureEventType

Set the local value of the Error Node.

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

Specified by:

setError in interface PubSubCommunicationFailureEventType

Parameters:

value - the local value to set for the Error Node.

Throws:

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

readError

public org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode readError()
                                                                     throws org.eclipse.milo.opcua.stack.core.UaException

Description copied from interface: PubSubCommunicationFailureEventType

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

Specified by:

readError in interface PubSubCommunicationFailureEventType

Returns:

the StatusCode value read from the server.

Throws:

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

writeError

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

Description copied from interface: PubSubCommunicationFailureEventType

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

Specified by:

writeError in interface PubSubCommunicationFailureEventType

Parameters:

value - the StatusCode value to write to the server.

Throws:

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

readErrorAsync

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

Description copied from interface: PubSubCommunicationFailureEventType

An asynchronous implementation of PubSubCommunicationFailureEventType.readError().

Specified by:

readErrorAsync in interface PubSubCommunicationFailureEventType

Returns:

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

writeErrorAsync

public CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode> writeErrorAsync(org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode error)

Description copied from interface: PubSubCommunicationFailureEventType

An asynchronous implementation of PubSubCommunicationFailureEventType.writeError(org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode).

Specified by:

writeErrorAsync in interface PubSubCommunicationFailureEventType

Returns:

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

getErrorNode

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

Description copied from interface: PubSubCommunicationFailureEventType

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

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

Specified by:

getErrorNode in interface PubSubCommunicationFailureEventType

Returns:

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

getErrorNodeAsync

public CompletableFuture<? extends PropertyTypeNode> getErrorNodeAsync()

Description copied from interface: PubSubCommunicationFailureEventType

Asynchronous implementation of PubSubCommunicationFailureEventType.getErrorNode().

Specified by:

getErrorNodeAsync in interface PubSubCommunicationFailureEventType

Returns:

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