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

Interface AuditCancelEventType

All Superinterfaces:

AuditEventType, AuditSecurityEventType, AuditSessionEventType, BaseEventType, BaseObjectType, Node, ObjectNode

All Known Implementing Classes:

AuditCancelEventTypeNode

public interface AuditCancelEventType
extends AuditSessionEventType

Field Summary

Fields

Modifier and Type	Field and Description
static QualifiedProperty<org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger>	REQUEST_HANDLE

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

SESSION_ID

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

ACTION_TIME_STAMP, CLIENT_AUDIT_ENTRY_ID, CLIENT_USER_ID, SERVER_ID, STATUS

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

EVENT_ID, EVENT_TYPE, LOCAL_TIME, MESSAGE, RECEIVE_TIME, SEVERITY, SOURCE_NAME, SOURCE_NODE, TIME

Method Summary

Modifier and Type	Method and Description
org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger	getRequestHandle() Get the local value of the RequestHandle Node.
PropertyType	getRequestHandleNode() Get the RequestHandle PropertyType Node, or null if it does not exist.
CompletableFuture<? extends PropertyType>	getRequestHandleNodeAsync() Asynchronous implementation of getRequestHandleNode().
org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger	readRequestHandle() Read the value of the RequestHandle 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>	readRequestHandleAsync() An asynchronous implementation of readRequestHandle().
void	setRequestHandle(org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger requestHandle) Set the local value of the RequestHandle Node.
void	writeRequestHandle(org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger requestHandle) Write a new value for the RequestHandle Node to the server and update the local value if the operation succeeds.
CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode>	writeRequestHandleAsync(org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger requestHandle) An asynchronous implementation of writeRequestHandle(UInteger).

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

getSessionId, getSessionIdNode, getSessionIdNodeAsync, readSessionId, readSessionIdAsync, setSessionId, writeSessionId, writeSessionIdAsync

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

getActionTimeStamp, getActionTimeStampNode, getActionTimeStampNodeAsync, getClientAuditEntryId, getClientAuditEntryIdNode, getClientAuditEntryIdNodeAsync, getClientUserId, getClientUserIdNode, getClientUserIdNodeAsync, getServerId, getServerIdNode, getServerIdNodeAsync, getStatus, getStatusNode, getStatusNodeAsync, readActionTimeStamp, readActionTimeStampAsync, readClientAuditEntryId, readClientAuditEntryIdAsync, readClientUserId, readClientUserIdAsync, readServerId, readServerIdAsync, readStatus, readStatusAsync, setActionTimeStamp, setClientAuditEntryId, setClientUserId, setServerId, setStatus, writeActionTimeStamp, writeActionTimeStampAsync, writeClientAuditEntryId, writeClientAuditEntryIdAsync, writeClientUserId, writeClientUserIdAsync, writeServerId, writeServerIdAsync, writeStatus, writeStatusAsync

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

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, readEventId, readEventIdAsync, readEventType, readEventTypeAsync, readLocalTime, readLocalTimeAsync, readMessage, readMessageAsync, readReceiveTime, readReceiveTimeAsync, readSeverity, readSeverityAsync, readSourceName, readSourceNameAsync, readSourceNode, readSourceNodeAsync, readTime, readTimeAsync, setEventId, setEventType, setLocalTime, setMessage, setReceiveTime, setSeverity, setSourceName, setSourceNode, setTime, 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.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

REQUEST_HANDLE

static final QualifiedProperty<org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger> REQUEST_HANDLE

Method Detail

getRequestHandle

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

Get the local value of the RequestHandle Node.

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

Returns:

the local value of the RequestHandle Node.

Throws:

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

setRequestHandle

void setRequestHandle(org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger requestHandle)
               throws org.eclipse.milo.opcua.stack.core.UaException

Set the local value of the RequestHandle Node.

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

Parameters:

requestHandle - the local value to set for the RequestHandle Node.

Throws:

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

readRequestHandle

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

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

Returns:

the UInteger value read from the server.

Throws:

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

writeRequestHandle

void writeRequestHandle(org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger requestHandle)
                 throws org.eclipse.milo.opcua.stack.core.UaException

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

Parameters:

requestHandle - the UInteger value to write to the server.

Throws:

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

readRequestHandleAsync

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

An asynchronous implementation of readRequestHandle().

Returns:

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

writeRequestHandleAsync

CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode> writeRequestHandleAsync(org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger requestHandle)

An asynchronous implementation of writeRequestHandle(UInteger).

Returns:

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

getRequestHandleNode

PropertyType getRequestHandleNode()
                           throws org.eclipse.milo.opcua.stack.core.UaException

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

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

Returns:

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

getRequestHandleNodeAsync

CompletableFuture<? extends PropertyType> getRequestHandleNodeAsync()

Asynchronous implementation of getRequestHandleNode().

Returns:

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