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

Class BatchModifyMonitoredItems

java.lang.Object

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

public class BatchModifyMonitoredItems
extends Object

Manages the batch execution of one or more 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	BatchModifyMonitoredItems.BatchModifyParametersBuilder
static class	BatchModifyMonitoredItems.ModifyMonitoredItemResult Holds the operation- and service-level results of an operation that is part of a BatchModifyMonitoredItems execution.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
CompletableFuture<BatchModifyMonitoredItems.ModifyMonitoredItemResult>	add(OpcUaMonitoredItem monitoredItem, Consumer<BatchModifyMonitoredItems.BatchModifyParametersBuilder> builderConsumer) Add an OpcUaMonitoredItem to be modified as part of a batch.
List<BatchModifyMonitoredItems.ModifyMonitoredItemResult>	execute() Execute this batch operation and return a List of BatchModifyMonitoredItems.ModifyMonitoredItemResults the same size and order as calls to add(OpcUaMonitoredItem, Consumer) were made.
CompletableFuture<List<BatchModifyMonitoredItems.ModifyMonitoredItemResult>>	executeAsync() Execute this batch operation and return a CompletableFuture with a List of BatchModifyMonitoredItems.ModifyMonitoredItemResults the same size and order as calls to add(OpcUaMonitoredItem, Consumer) 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

BatchModifyMonitoredItems

public BatchModifyMonitoredItems(ManagedSubscription subscription)

BatchModifyMonitoredItems

public BatchModifyMonitoredItems(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<BatchModifyMonitoredItems.ModifyMonitoredItemResult> add(OpcUaMonitoredItem monitoredItem,
                                                                                  Consumer<BatchModifyMonitoredItems.BatchModifyParametersBuilder> builderConsumer)

Add an OpcUaMonitoredItem to be modified as part of a batch.

Parameters:

monitoredItem - the OpcUaMonitoredItem to modify.

builderConsumer - a consumer that will set changes on a BatchModifyMonitoredItems.BatchModifyParametersBuilder.

Returns:

a CompletableFuture that always completes successfully with a BatchModifyMonitoredItems.ModifyMonitoredItemResult.

execute

public List<BatchModifyMonitoredItems.ModifyMonitoredItemResult> execute()
                                                                  throws InterruptedException

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

Returns:

a List of BatchModifyMonitoredItems.ModifyMonitoredItemResults the same size and order as calls to add(OpcUaMonitoredItem, Consumer) were made.

Throws:

InterruptedException

executeAsync

public CompletableFuture<List<BatchModifyMonitoredItems.ModifyMonitoredItemResult>> executeAsync()

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

The returned CompletableFuture always completes successfully.

Returns:

a CompletableFuture with a List of BatchModifyMonitoredItems.ModifyMonitoredItemResults the same size and order as calls to add(OpcUaMonitoredItem, Consumer) were made.