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

Class ManagedSubscription

java.lang.Object

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

public class ManagedSubscription
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	ManagedSubscription.ChangeListener A callback that receives data and event change notifications for ManagedDataItems and ManagedEventItems belonging to a ManagedSubscription.
static interface	ManagedSubscription.StatusListener A callback that receives status-related notifications for a ManagedSubscription.

Field Summary

Fields

Modifier and Type	Field and Description
static double	DEFAULT_PUBLISHING_INTERVAL
static org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger	DEFAULT_QUEUE_SIZE
static double	DEFAULT_SAMPLING_INTERVAL

Constructor Summary

Constructors

Constructor and Description
ManagedSubscription(OpcUaClient client, OpcUaSubscription subscription)

Method Summary

Modifier and Type	Method and Description
void	addChangeListener(ManagedSubscription.ChangeListener changeListener) Add a ManagedSubscription.ChangeListener to this ManagedSubscription.
ManagedSubscription.ChangeListener	addDataChangeListener(BiConsumer<List<ManagedDataItem>,List<org.eclipse.milo.opcua.stack.core.types.builtin.DataValue>> biConsumer) Add a data ManagedSubscription.ChangeListener to this ManagedSubscription.
ManagedSubscription.ChangeListener	addEventChangeListener(BiConsumer<List<ManagedEventItem>,List<org.eclipse.milo.opcua.stack.core.types.builtin.Variant[]>> biConsumer) Add an event ManagedSubscription.ChangeListener to this ManagedSubscription.
void	addStatusListener(ManagedSubscription.StatusListener statusListener) Add a ManagedSubscription.StatusListener to this ManagedSubscription.
static ManagedSubscription	create(OpcUaClient client) Create a ManagedSubscription with the default publishing interval.
static ManagedSubscription	create(OpcUaClient client, double publishingInterval) Create a ManagedSubscription with the publishing interval specified by publishingInterval.
static CompletableFuture<ManagedSubscription>	createAsync(OpcUaClient client, double publishingInterval) Create a ManagedSubscription with the publishing interval specified by publishingInterval.
ManagedDataItem	createDataItem(double samplingInterval, org.eclipse.milo.opcua.stack.core.types.structured.ReadValueId readValueId) Create a ManagedDataItem monitoring the Node and Attribute identified by readValueId.
ManagedDataItem	createDataItem(double samplingInterval, org.eclipse.milo.opcua.stack.core.types.structured.ReadValueId readValueId, Consumer<ManagedDataItem> consumer) Create a ManagedDataItem monitoring the Node and Attribute identified by readValueId.
ManagedDataItem	createDataItem(org.eclipse.milo.opcua.stack.core.types.builtin.NodeId nodeId) Create a ManagedDataItem monitoring the Value attribute of the Node identified by nodeId.
ManagedDataItem	createDataItem(org.eclipse.milo.opcua.stack.core.types.builtin.NodeId nodeId, Consumer<ManagedDataItem> consumer) Create a ManagedDataItem monitoring the Value attribute of the Node identified by nodeId.
List<ManagedDataItem>	createDataItems(double samplingInterval, List<org.eclipse.milo.opcua.stack.core.types.structured.ReadValueId> readValueIds) Create ManagedDataItems monitoring the Nodes and Attributes identified by readValueIds.
List<ManagedDataItem>	createDataItems(double samplingInterval, List<org.eclipse.milo.opcua.stack.core.types.structured.ReadValueId> readValueIds, Consumer<ManagedDataItem> consumer) Create ManagedDataItems monitoring the Nodes and Attributes identified by readValueIds.
List<ManagedDataItem>	createDataItems(List<org.eclipse.milo.opcua.stack.core.types.builtin.NodeId> nodeIds) Create ManagedDataItems monitoring the Value attribute of the Nodes identified by nodeIds.
List<ManagedDataItem>	createDataItems(List<org.eclipse.milo.opcua.stack.core.types.builtin.NodeId> nodeIds, Consumer<ManagedDataItem> consumer) Create ManagedDataItems monitoring the Value attribute of the Nodes identified by nodeIds.
CompletableFuture<List<ManagedDataItem>>	createDataItemsAsync(double samplingInterval, List<org.eclipse.milo.opcua.stack.core.types.structured.ReadValueId> readValueIds) Create ManagedDataItems monitoring the Nodes and Attributes identified by readValueIds.
CompletableFuture<List<ManagedDataItem>>	createDataItemsAsync(double samplingInterval, List<org.eclipse.milo.opcua.stack.core.types.structured.ReadValueId> readValueIds, Consumer<ManagedDataItem> consumer) Create ManagedDataItems monitoring the Nodes and Attributes identified by readValueIds.
ManagedEventItem	createEventItem(org.eclipse.milo.opcua.stack.core.types.builtin.NodeId nodeId, org.eclipse.milo.opcua.stack.core.types.structured.EventFilter eventFilter) Create a ManagedEventItem.
ManagedEventItem	createEventItem(org.eclipse.milo.opcua.stack.core.types.builtin.NodeId nodeId, org.eclipse.milo.opcua.stack.core.types.structured.EventFilter eventFilter, Consumer<ManagedEventItem> consumer) Create a ManagedEventItem.
List<ManagedEventItem>	createEventItems(List<org.eclipse.milo.opcua.stack.core.types.builtin.NodeId> nodeIds, List<org.eclipse.milo.opcua.stack.core.types.structured.EventFilter> eventFilters) Create one or more ManagedEventItems.
List<ManagedEventItem>	createEventItems(List<org.eclipse.milo.opcua.stack.core.types.builtin.NodeId> nodeIds, List<org.eclipse.milo.opcua.stack.core.types.structured.EventFilter> eventFilters, Consumer<ManagedEventItem> consumer) Create one or more ManagedEventItems.
CompletableFuture<List<ManagedEventItem>>	createEventItemsAsync(List<org.eclipse.milo.opcua.stack.core.types.builtin.NodeId> nodeIds, List<org.eclipse.milo.opcua.stack.core.types.structured.EventFilter> eventFilters) Create one or more ManagedEventItems.
CompletableFuture<List<ManagedEventItem>>	createEventItemsAsync(List<org.eclipse.milo.opcua.stack.core.types.builtin.NodeId> nodeIds, List<org.eclipse.milo.opcua.stack.core.types.structured.EventFilter> eventFilters, Consumer<ManagedEventItem> consumer) Create one or more ManagedEventItems.
void	delete() Delete this ManagedSubscription and its underlying OpcUaSubscription.
CompletableFuture<org.eclipse.milo.opcua.stack.core.util.Unit>	deleteAsync() Delete this ManagedSubscription and its underlying OpcUaSubscription.
void	deleteDataItem(ManagedDataItem dataItem) Delete a ManagedDataItem.
CompletableFuture<org.eclipse.milo.opcua.stack.core.util.Unit>	deleteDataItemAsync(ManagedDataItem dataItem) Delete a ManagedDataItem.
void	deleteDataItems(List<ManagedDataItem> dataItems) Delete one or more ManagedDataItems.
CompletableFuture<org.eclipse.milo.opcua.stack.core.util.Unit>	deleteDataItemsAsync(List<ManagedDataItem> dataItemsToDelete) Delete one or more ManagedDataItems.
void	deleteEventItem(ManagedEventItem eventItem) Delete a ManagedEventItem.
CompletableFuture<org.eclipse.milo.opcua.stack.core.util.Unit>	deleteEventItemAsync(ManagedEventItem eventItem) Delete a ManagedEventItem.
void	deleteEventItems(List<ManagedEventItem> eventItems) Delete one or more ManagedEventItems.
CompletableFuture<org.eclipse.milo.opcua.stack.core.util.Unit>	deleteEventItemsAsync(List<ManagedEventItem> eventItemsToDelete) Delete one or more ManagedEventItems.
OpcUaClient	getClient() Get the OpcUaClient that created this ManagedSubscription.
List<ManagedDataItem>	getDataItems() Get a copied List of the current ManagedDataItems.
@Nullable org.eclipse.milo.opcua.stack.core.types.builtin.ExtensionObject	getDefaultDataFilter() Get the encoded DataChangeFilter used when creating ManagedDataItems.
boolean	getDefaultDiscardOldest() Get the default discard policy used when creating ManagedDataItems and ManagedEventItems.
org.eclipse.milo.opcua.stack.core.types.enumerated.MonitoringMode	getDefaultMonitoringMode() Get the default MonitoringMode new items will be created in.
org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger	getDefaultQueueSize() Get the queue size used when creating ManagedDataItems.
double	getDefaultSamplingInterval() Get the sampling interval used in calls where it is not specified explicitly.
org.eclipse.milo.opcua.stack.core.types.enumerated.TimestampsToReturn	getDefaultTimestamps() Get the default TimestampsToReturn used when creating ManagedDataItems.
List<ManagedEventItem>	getEventItems() Get a copied List of the current ManagedEventItems.
double	getPublishingInterval() Get this Subscription's current publishing interval.
OpcUaSubscription	getSubscription() Get the underlying OpcUaSubscription.
boolean	isPublishingEnabled() Get this Subscription's current publishing mode.
boolean	removeChangeListener(ManagedSubscription.ChangeListener changeListener) Remove a ManagedSubscription.ChangeListener from this ManagedSubscription.
boolean	removeStatusListener(ManagedSubscription.StatusListener statusListener) Remove a ManagedSubscription.StatusListener from this ManagedSubscription.
void	setDefaultDataFilter(@Nullable org.eclipse.milo.opcua.stack.core.types.structured.DataChangeFilter defaultDataFilter) Set the DataChangeFilter used when creating ManagedDataItems.
void	setDefaultDiscardOldest(boolean defaultDiscardOldest) Set the default discard policy used when creating ManagedDataItems and ManagedEventItems.
void	setDefaultMonitoringMode(org.eclipse.milo.opcua.stack.core.types.enumerated.MonitoringMode defaultMonitoringMode) Set the new default MonitoringMode new items will be created in.
void	setDefaultQueueSize(org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger defaultQueueSize) Set the queue size used when creating ManagedDataItems.
void	setDefaultSamplingInterval(double defaultSamplingInterval) Set the sampling interval used in calls where it is not specified explicitly.
void	setDefaultTimestamps(org.eclipse.milo.opcua.stack.core.types.enumerated.TimestampsToReturn defaultTimestamps) Set the default TimestampsToReturn used when creating ManagedDataItems.
void	setPublishingEnabled(boolean enabled) Set this Subscription's publishing mode.
CompletableFuture<org.eclipse.milo.opcua.stack.core.util.Unit>	setPublishingEnabledAsync(boolean enabled) Set this Subscription's publishing mode.
double	setPublishingInterval(double publishingInterval) Request a new publishing interval for this Subscription.
CompletableFuture<Double>	setPublishingIntervalAsync(double publishingInterval) Request a new publishing interval for this Subscription.

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_PUBLISHING_INTERVAL

public static final double DEFAULT_PUBLISHING_INTERVAL

See Also:

Constant Field Values

DEFAULT_SAMPLING_INTERVAL

public static final double DEFAULT_SAMPLING_INTERVAL

See Also:

Constant Field Values

DEFAULT_QUEUE_SIZE

public static final org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger DEFAULT_QUEUE_SIZE

Constructor Detail

ManagedSubscription

public ManagedSubscription(OpcUaClient client,
                           OpcUaSubscription subscription)

Method Detail

getClient

public OpcUaClient getClient()

Get the OpcUaClient that created this ManagedSubscription.

Returns:

the OpcUaClient that created this ManagedSubscription.

getSubscription

public OpcUaSubscription getSubscription()

Get the underlying OpcUaSubscription.

Returns:

the underlying OpcUaSubscription.

getDataItems

public List<ManagedDataItem> getDataItems()

Get a copied List of the current ManagedDataItems.

Returns:

a copied List of the current ManagedDataItems.

getEventItems

public List<ManagedEventItem> getEventItems()

Get a copied List of the current ManagedEventItems.

Returns:

a copied List of the current ManagedEventItems.

createDataItem

public ManagedDataItem createDataItem(org.eclipse.milo.opcua.stack.core.types.builtin.NodeId nodeId)
                               throws org.eclipse.milo.opcua.stack.core.UaException

Create a ManagedDataItem monitoring the Value attribute of the Node identified by nodeId.

The operation will fail of the Node is not a Variable or VariableType Node. To create an item that monitors a different attribute use createDataItem(double, ReadValueId).

The operation result should be checked before this item is used further. See ManagedItem.getStatusCode().

Parameters:

nodeId - the NodeId identifying a Variable or VariableType Node.

Returns:

a ManagedDataItem.

Throws:

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

createDataItem

public ManagedDataItem createDataItem(org.eclipse.milo.opcua.stack.core.types.builtin.NodeId nodeId,
                                      Consumer<ManagedDataItem> consumer)
                               throws org.eclipse.milo.opcua.stack.core.UaException

Create a ManagedDataItem monitoring the Value attribute of the Node identified by nodeId.

The operation will fail of the Node is not a Variable or VariableType Node. To create an item that monitors a different attribute use createDataItem(double, ReadValueId).

The operation result should be checked before this item is used further. See ManagedItem.getStatusCode().

Parameters:

nodeId - the NodeId identifying a Variable or VariableType Node.

consumer - a Consumer that will receive each item as it is created.

Returns:

a ManagedDataItem.

Throws:

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

createDataItems

public List<ManagedDataItem> createDataItems(List<org.eclipse.milo.opcua.stack.core.types.builtin.NodeId> nodeIds)
                                      throws org.eclipse.milo.opcua.stack.core.UaException

Create ManagedDataItems monitoring the Value attribute of the Nodes identified by nodeIds.

This operation will fail of the Node is not a Variable or VariableType Node. To create items that monitor different attributes use createDataItems(double, List).

The operation result should be checked before this item is used further. See ManagedItem.getStatusCode().

Parameters:

nodeIds - the NodeIds identifying a Variable or VariableType Nodes.

Returns:

a List of ManagedDataItem.

Throws:

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

createDataItems

public List<ManagedDataItem> createDataItems(List<org.eclipse.milo.opcua.stack.core.types.builtin.NodeId> nodeIds,
                                             Consumer<ManagedDataItem> consumer)
                                      throws org.eclipse.milo.opcua.stack.core.UaException

Create ManagedDataItems monitoring the Value attribute of the Nodes identified by nodeIds.

This operation will fail of the Node is not a Variable or VariableType Node. To create items that monitor different attributes use createDataItems(double, List).

The operation result should be checked before this item is used further. See ManagedItem.getStatusCode().

Parameters:

nodeIds - the NodeIds identifying a Variable or VariableType Nodes.

consumer - a Consumer that will receive each item as it is created.

Returns:

a List of ManagedDataItem.

Throws:

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

createDataItem

public ManagedDataItem createDataItem(double samplingInterval,
                                      org.eclipse.milo.opcua.stack.core.types.structured.ReadValueId readValueId)
                               throws org.eclipse.milo.opcua.stack.core.UaException

Create a ManagedDataItem monitoring the Node and Attribute identified by readValueId.

The operation result should be checked before this item is used further. See ManagedItem.getStatusCode().

Parameters:

samplingInterval - the sampling interval to request.

readValueId - the ReadValueId identifying the Node and Attribute.

Returns:

a ManagedDataItem.

Throws:

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

createDataItem

public ManagedDataItem createDataItem(double samplingInterval,
                                      org.eclipse.milo.opcua.stack.core.types.structured.ReadValueId readValueId,
                                      Consumer<ManagedDataItem> consumer)
                               throws org.eclipse.milo.opcua.stack.core.UaException

Create a ManagedDataItem monitoring the Node and Attribute identified by readValueId.

consumer will receive each item as it is created to provide an opportunity to add a ManagedDataItem.DataValueListener before the first value change has arrived.

The operation result should be checked before this item is used further. See ManagedItem.getStatusCode().

Parameters:

samplingInterval - the sampling interval to request.

readValueId - the ReadValueId identifying the Node and Attribute.

consumer - a Consumer that will receive each item as it is created.

Returns:

a ManagedDataItem.

Throws:

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

createDataItems

public List<ManagedDataItem> createDataItems(double samplingInterval,
                                             List<org.eclipse.milo.opcua.stack.core.types.structured.ReadValueId> readValueIds)
                                      throws org.eclipse.milo.opcua.stack.core.UaException

Create ManagedDataItems monitoring the Nodes and Attributes identified by readValueIds.

The operation results should be checked before each item is used further. See ManagedItem.getStatusCode().

Parameters:

samplingInterval - the sampling interval to request.

readValueIds - the ReadValueIds identifying the Nodes and Attributes.

Returns:

a List of ManagedDataItem.

Throws:

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

createDataItems

public List<ManagedDataItem> createDataItems(double samplingInterval,
                                             List<org.eclipse.milo.opcua.stack.core.types.structured.ReadValueId> readValueIds,
                                             Consumer<ManagedDataItem> consumer)
                                      throws org.eclipse.milo.opcua.stack.core.UaException

Create ManagedDataItems monitoring the Nodes and Attributes identified by readValueIds.

consumer will receive each item as it is created to provide an opportunity to add a ManagedDataItem.DataValueListener before the first value change has arrived.

The operation results should be checked before each item is used further. See ManagedItem.getStatusCode().

Parameters:

samplingInterval - the sampling interval to request.

readValueIds - the ReadValueIds identifying the Nodes and Attributes.

consumer - a Consumer that will receive each item as it is created.

Returns:

a List of ManagedDataItem.

Throws:

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

createDataItemsAsync

public CompletableFuture<List<ManagedDataItem>> createDataItemsAsync(double samplingInterval,
                                                                     List<org.eclipse.milo.opcua.stack.core.types.structured.ReadValueId> readValueIds)

Create ManagedDataItems monitoring the Nodes and Attributes identified by readValueIds.

The operation results should be checked before each item is used further. See ManagedItem.getStatusCode().

This call completes asynchronously.

Parameters:

samplingInterval - the sampling interval to request.

readValueIds - the ReadValueIds identifying the Nodes and Attributes.

Returns:

a CompletableFuture that completes successfully with a List of ManagedDataItem or completes exceptionally if a service-level error occurs.

createDataItemsAsync

public CompletableFuture<List<ManagedDataItem>> createDataItemsAsync(double samplingInterval,
                                                                     List<org.eclipse.milo.opcua.stack.core.types.structured.ReadValueId> readValueIds,
                                                                     Consumer<ManagedDataItem> consumer)

Create ManagedDataItems monitoring the Nodes and Attributes identified by readValueIds.

consumer will receive each item as it is created to provide an opportunity to add a ManagedDataItem.DataValueListener before the first value change has arrived.

The operation results should be checked before each item is used further. See ManagedItem.getStatusCode().

This call completes asynchronously.

Parameters:

samplingInterval - the sampling interval to request.

readValueIds - the ReadValueIds identifying the Nodes and Attributes.

consumer - a Consumer that will receive each item as it is created.

Returns:

a CompletableFuture that completes successfully with a List of ManagedDataItem or completes exceptionally if a service-level error occurs.

deleteDataItem

public void deleteDataItem(ManagedDataItem dataItem)
                    throws org.eclipse.milo.opcua.stack.core.UaException

Delete a ManagedDataItem.

The result of the delete operation can be obtained via ManagedItem.getStatusCode().

Parameters:

dataItem - the ManagedDataItem to delete.

Throws:

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

deleteDataItems

public void deleteDataItems(List<ManagedDataItem> dataItems)
                     throws org.eclipse.milo.opcua.stack.core.UaException

Delete one or more ManagedDataItems.

The result of the delete operations can be obtained via ManagedItem.getStatusCode().

Parameters:

dataItems - the ManagedDataItems to delete.

Throws:

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

deleteDataItemAsync

public CompletableFuture<org.eclipse.milo.opcua.stack.core.util.Unit> deleteDataItemAsync(ManagedDataItem dataItem)

Delete a ManagedDataItem.

The result of the delete operation can be obtained via ManagedItem.getStatusCode().

This call completes asynchronously.

Parameters:

dataItem - the ManagedDataItem to delete.

Returns:

a CompletableFuture that completes successfully if the service completed successfully or completes exceptionally if a service-level error occurs.

deleteDataItemsAsync

public CompletableFuture<org.eclipse.milo.opcua.stack.core.util.Unit> deleteDataItemsAsync(List<ManagedDataItem> dataItemsToDelete)

Delete one or more ManagedDataItems.

The result of the delete operations can be obtained via ManagedItem.getStatusCode().

This call completes asynchronously.

Parameters:

dataItemsToDelete - the ManagedDataItems to delete.

Returns:

a CompletableFuture that completes successfully if the service completed successfully or completes exceptionally if a service-level error occurs.

createEventItem

public ManagedEventItem createEventItem(org.eclipse.milo.opcua.stack.core.types.builtin.NodeId nodeId,
                                        org.eclipse.milo.opcua.stack.core.types.structured.EventFilter eventFilter)
                                 throws org.eclipse.milo.opcua.stack.core.UaException

Create a ManagedEventItem.

This operation will fail of the Node identified by nodeId is not an Object Node.

The operation result should be checked before this item is used further. See ManagedItem.getStatusCode().

Parameters:

nodeId - the NodeId identifying an Object Node.

eventFilter - the EventFilter to use.

Returns:

a ManagedEventItem.

Throws:

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

See Also:

EventFilterBuilder

createEventItem

public ManagedEventItem createEventItem(org.eclipse.milo.opcua.stack.core.types.builtin.NodeId nodeId,
                                        org.eclipse.milo.opcua.stack.core.types.structured.EventFilter eventFilter,
                                        Consumer<ManagedEventItem> consumer)
                                 throws org.eclipse.milo.opcua.stack.core.UaException

Create a ManagedEventItem.

This operation will fail of the Node identified by nodeId is not an Object Node.

The operation result should be checked before this item is used further. See ManagedItem.getStatusCode().

Parameters:

nodeId - the NodeId identifying an Object Node.

eventFilter - the EventFilter to use.

consumer - a Consumer that will receive each item as it is created.

Returns:

a ManagedEventItem.

Throws:

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

See Also:

EventFilterBuilder

createEventItems

public List<ManagedEventItem> createEventItems(List<org.eclipse.milo.opcua.stack.core.types.builtin.NodeId> nodeIds,
                                               List<org.eclipse.milo.opcua.stack.core.types.structured.EventFilter> eventFilters)
                                        throws org.eclipse.milo.opcua.stack.core.UaException

Create one or more ManagedEventItems.

This operation will fail of the Node identified by nodeId is not an Object Node.

The operation result should be checked before this item is used further. See ManagedItem.getStatusCode().

Parameters:

nodeIds - the NodeIds identifying Object Nodes.

eventFilters - the corresponding EventFilter to create each item with.

Returns:

a List of ManagedEventItems.

Throws:

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

createEventItems

public List<ManagedEventItem> createEventItems(List<org.eclipse.milo.opcua.stack.core.types.builtin.NodeId> nodeIds,
                                               List<org.eclipse.milo.opcua.stack.core.types.structured.EventFilter> eventFilters,
                                               Consumer<ManagedEventItem> consumer)
                                        throws org.eclipse.milo.opcua.stack.core.UaException

Create one or more ManagedEventItems.

This operation will fail of the Node identified by nodeId is not an Object Node.

The operation result should be checked before this item is used further. See ManagedItem.getStatusCode().

Parameters:

nodeIds - the NodeIds identifying Object Nodes.

eventFilters - the corresponding EventFilter to create each item with.

consumer - a Consumer that will receive each item as it is created.

Returns:

a List of ManagedEventItems.

Throws:

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

createEventItemsAsync

public CompletableFuture<List<ManagedEventItem>> createEventItemsAsync(List<org.eclipse.milo.opcua.stack.core.types.builtin.NodeId> nodeIds,
                                                                       List<org.eclipse.milo.opcua.stack.core.types.structured.EventFilter> eventFilters)

Create one or more ManagedEventItems.

This operation will fail of the Node identified by nodeId is not an Object Node.

The operation result should be checked before this item is used further. See ManagedItem.getStatusCode().

This operation completes asynchronously.

Parameters:

nodeIds - the NodeIds identifying Object Nodes.

eventFilters - the corresponding EventFilter to create each item with.

Returns:

a CompletableFuture that completes successfully with the List of ManagedEventItems or completes exceptionally if a service-level error occurs.

createEventItemsAsync

public CompletableFuture<List<ManagedEventItem>> createEventItemsAsync(List<org.eclipse.milo.opcua.stack.core.types.builtin.NodeId> nodeIds,
                                                                       List<org.eclipse.milo.opcua.stack.core.types.structured.EventFilter> eventFilters,
                                                                       Consumer<ManagedEventItem> consumer)

Create one or more ManagedEventItems.

This operation will fail of the Node identified by nodeId is not an Object Node.

The operation result should be checked before this item is used further. See ManagedItem.getStatusCode().

This operation completes asynchronously.

Parameters:

nodeIds - the NodeIds identifying Object Nodes.

eventFilters - the corresponding EventFilter to create each item with.

consumer - a Consumer that will receive each item as it is created.

Returns:

a CompletableFuture that completes successfully with the List of ManagedEventItems or completes exceptionally if a service-level error occurs.

deleteEventItem

public void deleteEventItem(ManagedEventItem eventItem)
                     throws org.eclipse.milo.opcua.stack.core.UaException

Delete a ManagedEventItem.

The result of the delete operation can be obtained via ManagedItem.getStatusCode().

Parameters:

eventItem - the ManagedEventItem to delete.

Throws:

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

deleteEventItems

public void deleteEventItems(List<ManagedEventItem> eventItems)
                      throws org.eclipse.milo.opcua.stack.core.UaException

Delete one or more ManagedEventItems.

The result of the delete operations can be obtained via ManagedItem.getStatusCode().

Parameters:

eventItems - the ManagedEventItems to delete.

Throws:

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

deleteEventItemAsync

public CompletableFuture<org.eclipse.milo.opcua.stack.core.util.Unit> deleteEventItemAsync(ManagedEventItem eventItem)

Delete a ManagedEventItem.

The result of the delete operation can be obtained via ManagedItem.getStatusCode().

This call completes asynchronously.

Parameters:

eventItem - the ManagedEventItem to delete.

Returns:

a CompletableFuture that completes successfully if the service completed successfully or completes exceptionally if a service-level error occurs.

deleteEventItemsAsync

public CompletableFuture<org.eclipse.milo.opcua.stack.core.util.Unit> deleteEventItemsAsync(List<ManagedEventItem> eventItemsToDelete)

Delete one or more ManagedEventItems.

The result of the delete operations can be obtained via ManagedItem.getStatusCode().

This call completes asynchronously.

Parameters:

eventItemsToDelete - the ManagedEventItems to delete.

Returns:

a CompletableFuture that completes successfully if the service completed successfully or completes exceptionally if a service-level error occurs.

getPublishingInterval

public double getPublishingInterval()

Get this Subscription's current publishing interval.

Returns:

this Subscription's current publishing interval.

setPublishingInterval

public double setPublishingInterval(double publishingInterval)
                             throws org.eclipse.milo.opcua.stack.core.UaException

Request a new publishing interval for this Subscription.

Parameters:

publishingInterval - the requested publishing interval.

Returns:

the new publishing interval, possibly revised by the server.

Throws:

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

setPublishingIntervalAsync

public CompletableFuture<Double> setPublishingIntervalAsync(double publishingInterval)

Request a new publishing interval for this Subscription.

This call completes asynchronously.

Parameters:

publishingInterval - the requested publishing interval.

Returns:

a CompletableFuture that completes successfully with the new publishing interval or completes exceptionally if a service-level error occurs.

isPublishingEnabled

public boolean isPublishingEnabled()

Get this Subscription's current publishing mode.

Returns:

true if publishing is enabled, false if publishing is disabled.

setPublishingEnabled

public void setPublishingEnabled(boolean enabled)
                          throws org.eclipse.milo.opcua.stack.core.UaException

Set this Subscription's publishing mode.

Parameters:

enabled - true to enable publishing, false to disable publishing.

Throws:

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

setPublishingEnabledAsync

public CompletableFuture<org.eclipse.milo.opcua.stack.core.util.Unit> setPublishingEnabledAsync(boolean enabled)

Set this Subscription's publishing mode.

Parameters:

enabled - true to enable publishing, false to disable publishing.

Returns:

a CompletableFuture that completes successfully if the publishing mode was set or completes exceptionally if a service-level error occurs.

getDefaultMonitoringMode

public org.eclipse.milo.opcua.stack.core.types.enumerated.MonitoringMode getDefaultMonitoringMode()

Get the default MonitoringMode new items will be created in.

Returns:

the default MonitoringMode new items will be created in.

setDefaultMonitoringMode

public void setDefaultMonitoringMode(org.eclipse.milo.opcua.stack.core.types.enumerated.MonitoringMode defaultMonitoringMode)

Set the new default MonitoringMode new items will be created in.

Parameters:

defaultMonitoringMode - the new default MonitoringMode new items will be created in.

getDefaultSamplingInterval

public double getDefaultSamplingInterval()

Get the sampling interval used in calls where it is not specified explicitly.

Returns:

the sampling interval used in calls where it is not specified explicitly.

setDefaultSamplingInterval

public void setDefaultSamplingInterval(double defaultSamplingInterval)

Set the sampling interval used in calls where it is not specified explicitly.

Parameters:

defaultSamplingInterval - the sampling interval used in calls where it is not specified explicitly.

getDefaultQueueSize

public org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger getDefaultQueueSize()

Get the queue size used when creating ManagedDataItems.

Returns:

the queue size used when creating ManagedDataItems.

setDefaultQueueSize

public void setDefaultQueueSize(org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger defaultQueueSize)

Set the queue size used when creating ManagedDataItems.

Parameters:

defaultQueueSize - the queue size used when creating ManagedDataItems.

getDefaultDataFilter

@Nullable
public @Nullable org.eclipse.milo.opcua.stack.core.types.builtin.ExtensionObject getDefaultDataFilter()

Get the encoded DataChangeFilter used when creating ManagedDataItems.

Returns:

the encoded DataChangeFilter used when creating ManagedDataItems.

setDefaultDataFilter

public void setDefaultDataFilter(@Nullable
                                 @Nullable org.eclipse.milo.opcua.stack.core.types.structured.DataChangeFilter defaultDataFilter)

Set the DataChangeFilter used when creating ManagedDataItems.

The default value is null, which is interpreted by servers as a filter triggered by changes in Status or Value with no deadband applied.

Parameters:

defaultDataFilter - the DataChangeFilter to use when creating ManagedDataItems.

getDefaultTimestamps

public org.eclipse.milo.opcua.stack.core.types.enumerated.TimestampsToReturn getDefaultTimestamps()

Get the default TimestampsToReturn used when creating ManagedDataItems.

Returns:

the default TimestampsToReturn used when creating ManagedDataItems.

setDefaultTimestamps

public void setDefaultTimestamps(org.eclipse.milo.opcua.stack.core.types.enumerated.TimestampsToReturn defaultTimestamps)

Set the default TimestampsToReturn used when creating ManagedDataItems.

Parameters:

defaultTimestamps - the default TimestampsToReturn used when creating ManagedDataItems.

getDefaultDiscardOldest

public boolean getDefaultDiscardOldest()

Get the default discard policy used when creating ManagedDataItems and ManagedEventItems.

Returns:

the default discard policy used when creating ManagedDataItems and ManagedEventItems.

setDefaultDiscardOldest

public void setDefaultDiscardOldest(boolean defaultDiscardOldest)

Set the default discard policy used when creating ManagedDataItems and ManagedEventItems.

Parameters:

defaultDiscardOldest - the default discard policy used when creating ManagedDataItems and ManagedEventItems.

addChangeListener

public void addChangeListener(ManagedSubscription.ChangeListener changeListener)

Add a ManagedSubscription.ChangeListener to this ManagedSubscription.

Parameters:

changeListener - the ManagedSubscription.ChangeListener to add.

removeChangeListener

public boolean removeChangeListener(ManagedSubscription.ChangeListener changeListener)

Remove a ManagedSubscription.ChangeListener from this ManagedSubscription.

Parameters:

changeListener - the ManagedSubscription.ChangeListener to remove.

Returns:

true if the listener was removed.

addStatusListener

public void addStatusListener(ManagedSubscription.StatusListener statusListener)

Add a ManagedSubscription.StatusListener to this ManagedSubscription.

Parameters:

statusListener - the ManagedSubscription.StatusListener to add.

removeStatusListener

public boolean removeStatusListener(ManagedSubscription.StatusListener statusListener)

Remove a ManagedSubscription.StatusListener from this ManagedSubscription.

Parameters:

statusListener - the ManagedSubscription.StatusListener to remove.

Returns:

true if the listener was removed.

addDataChangeListener

public ManagedSubscription.ChangeListener addDataChangeListener(BiConsumer<List<ManagedDataItem>,List<org.eclipse.milo.opcua.stack.core.types.builtin.DataValue>> biConsumer)

Add a data ManagedSubscription.ChangeListener to this ManagedSubscription.

biConsumer will be invoked when new values for ManagedDataItems have arrived via ManagedSubscription.ChangeListener.onDataReceived(List, List).

The listener is transformed into the returned ManagedSubscription.ChangeListener that can later be removed.

Parameters:

biConsumer - a BiConsumer that will be invoked when new values for ManagedDataItems have arrived.

Returns:

a ManagedSubscription.ChangeListener that can later be removed.

addEventChangeListener

public ManagedSubscription.ChangeListener addEventChangeListener(BiConsumer<List<ManagedEventItem>,List<org.eclipse.milo.opcua.stack.core.types.builtin.Variant[]>> biConsumer)

Add an event ManagedSubscription.ChangeListener to this ManagedSubscription.

biConsumer will be invoked when new events for ManagedEventItems have arrived via ManagedSubscription.ChangeListener.onEventReceived(List, List).

The listener is transformed into the returned ManagedSubscription.ChangeListener that can later be removed.

Parameters:

biConsumer - a BiConsumer that will be invoked when new events for ManagedEventItems have arrived.

Returns:

a ManagedSubscription.ChangeListener that can later be removed.

delete

public void delete()
            throws org.eclipse.milo.opcua.stack.core.UaException

Delete this ManagedSubscription and its underlying OpcUaSubscription.

Throws:

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

deleteAsync

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

Delete this ManagedSubscription and its underlying OpcUaSubscription.

This call completes asynchronously.

Returns:

a CompletableFuture that completes successfully if the service completed successfully or completes exceptionally if a service-level error occurs.

create

public static ManagedSubscription create(OpcUaClient client)
                                  throws org.eclipse.milo.opcua.stack.core.UaException

Create a ManagedSubscription with the default publishing interval.

Parameters:

client - the OpcUaClient instance to create the subscription with.

Returns:

a ManagedSubscription.

Throws:

org.eclipse.milo.opcua.stack.core.UaException - if a service-level error occurs preventing the subscription from being created.

See Also:

DEFAULT_PUBLISHING_INTERVAL

create

public static ManagedSubscription create(OpcUaClient client,
                                         double publishingInterval)
                                  throws org.eclipse.milo.opcua.stack.core.UaException

Create a ManagedSubscription with the publishing interval specified by publishingInterval.

Parameters:

client - the OpcUaClient instance to create the subscription with.

publishingInterval - the publishing interval to request when creating the subscription.

Returns:

a ManagedSubscription.

Throws:

org.eclipse.milo.opcua.stack.core.UaException - if a service-level error occurs preventing the subscription from being created.

createAsync

public static CompletableFuture<ManagedSubscription> createAsync(OpcUaClient client,
                                                                 double publishingInterval)

Create a ManagedSubscription with the publishing interval specified by publishingInterval.

This call completes asynchronously.

Parameters:

client - the OpcUaClient instance to create the subscription with.

publishingInterval - the publishing interval to request when creating the subscription.

Returns:

a CompletableFuture that completes successfully with the new subscription or completes exceptionally if a service-level error occurs preventing the subscription from being created.