org.eclipse.milo.opcua.sdk.client.subscriptions

Class ManagedEventItem

java.lang.Object

org.eclipse.milo.opcua.sdk.client.subscriptions.ManagedItem

org.eclipse.milo.opcua.sdk.client.subscriptions.ManagedEventItem

public class ManagedEventItem
extends ManagedItem

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	ManagedEventItem.EventValueListener A callback that receives notification of new events for a ManagedEventItem.

Field Summary

Fields inherited from class org.eclipse.milo.opcua.sdk.client.subscriptions.ManagedItem

client, monitoredItem, subscription

Constructor Summary

Constructors

Constructor and Description
ManagedEventItem(OpcUaClient client, ManagedSubscription subscription, OpcUaMonitoredItem monitoredItem)

Method Summary

Modifier and Type	Method and Description
ManagedEventItem.EventValueListener	addEventValueListener(Consumer<org.eclipse.milo.opcua.stack.core.types.builtin.Variant[]> consumer) Add an event field value Consumer to this ManagedDataItem.
void	addEventValueListener(ManagedEventItem.EventValueListener eventValueListener) Add an ManagedEventItem.EventValueListener to this ManagedEventItem.
CompletableFuture<org.eclipse.milo.opcua.stack.core.util.Unit>	deleteAsync() Delete this ManagedDataItem.
boolean	removeEventValueListener(ManagedEventItem.EventValueListener eventValueListener) Remove an ManagedEventItem.EventValueListener from this ManagedEventItem.

Methods inherited from class org.eclipse.milo.opcua.sdk.client.subscriptions.ManagedItem

delete, getClient, getDiscardOldest, getMonitoredItem, getMonitoringMode, getNodeId, getQueueSize, getReadValueId, getStatusCode, getSubscription, getTimestampsToReturn, setDiscardOldest, setDiscardOldestAsync, setDiscardOldestAsync, setMonitoringMode, setMonitoringModeAsync, setMonitoringModeAsync, setQueueSize, setQueueSizeAsync, setQueueSizeAsync, setTimestampsToReturn, setTimestampsToReturnAsync, setTimestampsToReturnAsync

Methods inherited from class java.lang.Object

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

Constructor Detail

ManagedEventItem

public ManagedEventItem(OpcUaClient client,
                        ManagedSubscription subscription,
                        OpcUaMonitoredItem monitoredItem)

Method Detail

deleteAsync

public CompletableFuture<org.eclipse.milo.opcua.stack.core.util.Unit> deleteAsync()

Description copied from class: ManagedItem

Delete this ManagedDataItem.

This call completes asynchronously.

Specified by:

deleteAsync in class ManagedItem

Returns:

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

addEventValueListener

public ManagedEventItem.EventValueListener addEventValueListener(Consumer<org.eclipse.milo.opcua.stack.core.types.builtin.Variant[]> consumer)

Add an event field value Consumer to this ManagedDataItem.

consumer will be invoked any time new event field values arrive for this item.

The Consumer is transformed into the returned ManagedEventItem.EventValueListener that can later be removed.

Listeners should be added in the callback that happens during item creation in the ManagedSubscription.createEventItems(List, List, Consumer) and ManagedSubscription.createEventItemsAsync(List, List, Consumer) to avoid a possible race condition between the initial value arriving and the listener being registered.

Parameters:

consumer - an event field value Consumer.

Returns:

an ManagedEventItem.EventValueListener that can later be removed.

addEventValueListener

public void addEventValueListener(ManagedEventItem.EventValueListener eventValueListener)

Add an ManagedEventItem.EventValueListener to this ManagedEventItem.

{code eventValueListener} will be invoked any time new event field values arrive for this item.

Listeners should be added in the callback that happens during item creation in the ManagedSubscription.createEventItems(List, List, Consumer) and ManagedSubscription.createEventItemsAsync(List, List, Consumer) to avoid a possible race condition between the initial value arriving and the listener being registered.

Parameters:

eventValueListener - the ManagedEventItem.EventValueListener to add.

removeEventValueListener

public boolean removeEventValueListener(ManagedEventItem.EventValueListener eventValueListener)

Remove an ManagedEventItem.EventValueListener from this ManagedEventItem.

Parameters:

eventValueListener - the ManagedEventItem.EventValueListener to remove.

Returns:

true if the listener was removed.