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

Interface UaSubscription

All Known Implementing Classes:

OpcUaSubscription

public interface UaSubscription

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	UaSubscription.ItemCreationCallback
static interface	UaSubscription.NotificationListener

Method Summary

Modifier and Type	Method and Description
void	addNotificationListener(UaSubscription.NotificationListener listener) Add a UaSubscription.NotificationListener.
default CompletableFuture<List<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode>>	addTriggeringLinks(UaMonitoredItem triggeringItem, List<UaMonitoredItem> linksToAdd) Add triggering links between the triggeringItem and the items in linksToAdd.
CompletableFuture<List<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode>>	addTriggeringLinks(org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger triggeringItemId, List<org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger> linksToAdd) Add triggering links between the item identified by triggerItemId and the items identified by linksToAdd.
CompletableFuture<List<UaMonitoredItem>>	createMonitoredItems(org.eclipse.milo.opcua.stack.core.types.enumerated.TimestampsToReturn timestampsToReturn, List<org.eclipse.milo.opcua.stack.core.types.structured.MonitoredItemCreateRequest> itemsToCreate) Create one or more UaMonitoredItems.
CompletableFuture<List<UaMonitoredItem>>	createMonitoredItems(org.eclipse.milo.opcua.stack.core.types.enumerated.TimestampsToReturn timestampsToReturn, List<org.eclipse.milo.opcua.stack.core.types.structured.MonitoredItemCreateRequest> itemsToCreate, UaSubscription.ItemCreationCallback itemCreationCallback) Create one or more UaMonitoredItems.
CompletableFuture<List<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode>>	deleteMonitoredItems(List<UaMonitoredItem> itemsToDelete) Delete on or more UaMonitoredItems.
org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger	getMaxNotificationsPerPublish()
com.google.common.collect.ImmutableList<UaMonitoredItem>	getMonitoredItems()
org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UByte	getPriority()
org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger	getRequestedLifetimeCount()
org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger	getRequestedMaxKeepAliveCount()
double	getRequestedPublishingInterval()
org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger	getRevisedLifetimeCount()
org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger	getRevisedMaxKeepAliveCount()
double	getRevisedPublishingInterval()
org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger	getSubscriptionId()
boolean	isPublishingEnabled()
CompletableFuture<List<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode>>	modifyMonitoredItems(org.eclipse.milo.opcua.stack.core.types.enumerated.TimestampsToReturn timestampsToReturn, List<org.eclipse.milo.opcua.stack.core.types.structured.MonitoredItemModifyRequest> itemsToModify) Modify one or more UaMonitoredItems.
org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger	nextClientHandle()
void	removeNotificationListener(UaSubscription.NotificationListener listener) Remove a UaSubscription.NotificationListener.
default CompletableFuture<List<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode>>	removeTriggeringLinks(UaMonitoredItem triggeringItem, List<UaMonitoredItem> linksToRemove) Remove triggering links between triggeringItem and the items in linksToRemove.
CompletableFuture<List<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode>>	removeTriggeringLinks(org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger triggeringItemId, List<org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger> linksToRemove) Remove triggering links between the item identified by triggeringItemId and the items identified by linksToRemove.
CompletableFuture<List<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode>>	setMonitoringMode(org.eclipse.milo.opcua.stack.core.types.enumerated.MonitoringMode monitoringMode, List<UaMonitoredItem> items) Set the MonitoringMode for one or more UaMonitoredItems.
CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode>	setPublishingMode(boolean publishingEnabled) Set the publishing mode for this subscription.

Method Detail

getSubscriptionId

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

Returns:

the server-assigned id for this UaSubscription.

getRequestedPublishingInterval

double getRequestedPublishingInterval()

Returns:

the last requested publishing interval of this UaSubscription.

getRevisedPublishingInterval

double getRevisedPublishingInterval()

Returns:

the actual/revised publishing interval of this UaSubscription.

getRequestedLifetimeCount

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

Returns:

the last requested lifetime count of this UaSubscription.

getRevisedLifetimeCount

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

Returns:

the actual/revised lifetime count of this UaSubscription.

getRequestedMaxKeepAliveCount

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

Returns:

the last requested max keep-alive count of this UaSubscription.

getRevisedMaxKeepAliveCount

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

Returns:

the actual/revised max keep-alive count of this UaSubscription.

getMaxNotificationsPerPublish

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

Returns:

the maximum number of notifications that will be returned in any publish response.

isPublishingEnabled

boolean isPublishingEnabled()

Returns:

true if publishing is enabled.

getPriority

org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UByte getPriority()

Returns:

the relative priority assigned to this UaSubscription.

getMonitoredItems

com.google.common.collect.ImmutableList<UaMonitoredItem> getMonitoredItems()

Returns:

an ImmutableList of this UaSubscription's UaMonitoredItems.

nextClientHandle

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

Returns:

the next available client handle, unique within the context of this UaSubscription.

createMonitoredItems

CompletableFuture<List<UaMonitoredItem>> createMonitoredItems(org.eclipse.milo.opcua.stack.core.types.enumerated.TimestampsToReturn timestampsToReturn,
                                                              List<org.eclipse.milo.opcua.stack.core.types.structured.MonitoredItemCreateRequest> itemsToCreate)

Create one or more UaMonitoredItems.

Callers must check the quality of each of the returned UaMonitoredItems; it is not to be assumed that all items were created successfully. Any item with a bad quality will not be updated nor will it be part of the subscription's bookkeeping.

WARNING: items must be created in MonitoringMode.Sampling and then later set to MonitoringMode.Reporting after consumers have been set in order to avoid a race condition where the initial values arrive before the consumers are set. Alternatively, you can use createMonitoredItems(TimestampsToReturn, List, ItemCreationCallback) to avoid this race condition.

Parameters:

timestampsToReturn - the TimestampsToReturn.

itemsToCreate - a list of MonitoredItemCreateRequests.

Returns:

a list of UaMonitoredItems.

createMonitoredItems

CompletableFuture<List<UaMonitoredItem>> createMonitoredItems(org.eclipse.milo.opcua.stack.core.types.enumerated.TimestampsToReturn timestampsToReturn,
                                                              List<org.eclipse.milo.opcua.stack.core.types.structured.MonitoredItemCreateRequest> itemsToCreate,
                                                              UaSubscription.ItemCreationCallback itemCreationCallback)

Create one or more UaMonitoredItems.

Callers must check the quality of each of the returned UaMonitoredItems; it is not to be assumed that all items were created successfully. Any item with a bad quality will not be updated nor will it be part of the subscription's bookkeeping.

itemCreationCallback will be invoked for each successfully created UaMonitoredItem. Callers should use this opportunity to register any value or event consumers on the item, as this is the only time in which it is guaranteed no values or events will be delivered to the item yet.

Parameters:

timestampsToReturn - the TimestampsToReturn.

itemsToCreate - a list of MonitoredItemCreateRequests.

itemCreationCallback - callback to be invoked for each successfully created UaMonitoredItem.

Returns:

a list of UaMonitoredItems.

modifyMonitoredItems

CompletableFuture<List<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode>> modifyMonitoredItems(org.eclipse.milo.opcua.stack.core.types.enumerated.TimestampsToReturn timestampsToReturn,
                                                                                                         List<org.eclipse.milo.opcua.stack.core.types.structured.MonitoredItemModifyRequest> itemsToModify)

Modify one or more UaMonitoredItems.

Parameters:

timestampsToReturn - the TimestampsToReturn to set for each item.

itemsToModify - a list of MonitoredItemModifyRequests.

Returns:

a CompletableFuture containing a list of StatusCodes, the size and order matching that of itemsToModify.

deleteMonitoredItems

CompletableFuture<List<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode>> deleteMonitoredItems(List<UaMonitoredItem> itemsToDelete)

Delete on or more UaMonitoredItems.

Parameters:

itemsToDelete - the items to delete.

Returns:

a CompletableFuture containing a list of StatusCodes, the size and order matching that of itemsToDelete.

setMonitoringMode

CompletableFuture<List<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode>> setMonitoringMode(org.eclipse.milo.opcua.stack.core.types.enumerated.MonitoringMode monitoringMode,
                                                                                                      List<UaMonitoredItem> items)

Set the MonitoringMode for one or more UaMonitoredItems.

Parameters:

monitoringMode - the MonitoringMode to set.

items - the UaMonitoredItems to set the mode on.

Returns:

a CompletableFuture containing a list of StatusCodes, the size and order matching that of items.

setPublishingMode

CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode> setPublishingMode(boolean publishingEnabled)

Set the publishing mode for this subscription.

Parameters:

publishingEnabled - true if publishing should be enabled.

Returns:

a CompletableFuture containing a StatusCode representing the result of this operation.

addTriggeringLinks

CompletableFuture<List<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode>> addTriggeringLinks(org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger triggeringItemId,
                                                                                                       List<org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger> linksToAdd)

Add triggering links between the item identified by triggerItemId and the items identified by linksToAdd.

Parameters:

triggeringItemId - the id of the triggering item.

linksToAdd - the ids of the triggered items.

Returns:

a list of StatusCodes corresponding to the items in linksToAdd.

addTriggeringLinks

default CompletableFuture<List<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode>> addTriggeringLinks(UaMonitoredItem triggeringItem,
                                                                                                               List<UaMonitoredItem> linksToAdd)

Add triggering links between the triggeringItem and the items in linksToAdd.

Parameters:

triggeringItem - the triggering item.

linksToAdd - the triggered items.

Returns:

a list of StatusCodes corresponding to the items in linksToAdd.

removeTriggeringLinks

CompletableFuture<List<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode>> removeTriggeringLinks(org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger triggeringItemId,
                                                                                                          List<org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger> linksToRemove)

Remove triggering links between the item identified by triggeringItemId and the items identified by linksToRemove.

Parameters:

triggeringItemId - the id of the triggering item.

linksToRemove - the ids of the triggered items.

Returns:

a list of StatusCodes corresponding to the items in linksToRemove.

removeTriggeringLinks

default CompletableFuture<List<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode>> removeTriggeringLinks(UaMonitoredItem triggeringItem,
                                                                                                                  List<UaMonitoredItem> linksToRemove)

Remove triggering links between triggeringItem and the items in linksToRemove.

Parameters:

triggeringItem - the triggering item.

linksToRemove - the triggered items.

Returns:

a list of StatusCodes corresponding to the items in linksToRemove.

addNotificationListener

void addNotificationListener(UaSubscription.NotificationListener listener)

Add a UaSubscription.NotificationListener.

Parameters:

listener - the UaSubscription.NotificationListener to add.

removeNotificationListener

void removeNotificationListener(UaSubscription.NotificationListener listener)

Remove a UaSubscription.NotificationListener.

Parameters:

listener - the UaSubscription.NotificationListener to remove.