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

Class BatchSetMonitoringMode

java.lang.Object

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

public class BatchSetMonitoringMode
extends Object

Manages the batch execution of one or more MonitoringMode modifications to one or more MonitoredItems.

Handles splitting the execution into multiple service calls as needed based on the requested modifications and the operation limits reported by the server.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	BatchSetMonitoringMode.SetMonitoringModeResult Holds the operation- and service-level results of an operation that is part of a BatchSetMonitoringMode execution.

Constructor Summary

Constructors

Constructor and Description
BatchSetMonitoringMode(ManagedSubscription subscription)
BatchSetMonitoringMode(OpcUaClient client, OpcUaSubscription subscription)

Method Summary

Modifier and Type	Method and Description
CompletableFuture<BatchSetMonitoringMode.SetMonitoringModeResult>	add(OpcUaMonitoredItem monitoredItem, org.eclipse.milo.opcua.stack.core.types.enumerated.MonitoringMode monitoringMode) Add an OpcUaMonitoredItem to set a new MonitoringMode on as part of a batch.
List<BatchSetMonitoringMode.SetMonitoringModeResult>	execute() Execute this batch operation and return a List of BatchSetMonitoringMode.SetMonitoringModeResults the same size and order as calls to add(OpcUaMonitoredItem, MonitoringMode) were made.
CompletableFuture<List<BatchSetMonitoringMode.SetMonitoringModeResult>>	executeAsync() Execute this batch operation and return a CompletableFuture with a List of BatchSetMonitoringMode.SetMonitoringModeResults the same size and order as calls to add(OpcUaMonitoredItem, MonitoringMode) were made.
int	getServiceInvocationCount() Get the number of service invocations that were needed to execute this batch.

Methods inherited from class java.lang.Object

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

Constructor Detail

BatchSetMonitoringMode

public BatchSetMonitoringMode(ManagedSubscription subscription)

BatchSetMonitoringMode

public BatchSetMonitoringMode(OpcUaClient client,
                              OpcUaSubscription subscription)

Method Detail

getServiceInvocationCount

public int getServiceInvocationCount()

Get the number of service invocations that were needed to execute this batch.

Returns:

the number of service invocations that were needed to execute this batch.

add

public CompletableFuture<BatchSetMonitoringMode.SetMonitoringModeResult> add(OpcUaMonitoredItem monitoredItem,
                                                                             org.eclipse.milo.opcua.stack.core.types.enumerated.MonitoringMode monitoringMode)

Add an OpcUaMonitoredItem to set a new MonitoringMode on as part of a batch.

Parameters:

monitoredItem - the OpcUaMonitoredItem to modify.

monitoringMode - the new MonitoringMode.

Returns:

a CompletableFuture that always completes successfully with a BatchSetMonitoringMode.SetMonitoringModeResult.

execute

public List<BatchSetMonitoringMode.SetMonitoringModeResult> execute()
                                                             throws InterruptedException

Execute this batch operation and return a List of BatchSetMonitoringMode.SetMonitoringModeResults the same size and order as calls to add(OpcUaMonitoredItem, MonitoringMode) were made.

Returns:

a List of BatchSetMonitoringMode.SetMonitoringModeResults the same size and order as calls to add(OpcUaMonitoredItem, MonitoringMode) were made.

Throws:

InterruptedException

executeAsync

public CompletableFuture<List<BatchSetMonitoringMode.SetMonitoringModeResult>> executeAsync()

Execute this batch operation and return a CompletableFuture with a List of BatchSetMonitoringMode.SetMonitoringModeResults the same size and order as calls to add(OpcUaMonitoredItem, MonitoringMode) were made.

The returned CompletableFuture always completes successfully.

Returns:

a CompletableFuture with a List of BatchSetMonitoringMode.SetMonitoringModeResults the same size and order as calls to add(OpcUaMonitoredItem, MonitoringMode) were made.