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

Class OpcUaSubscription

java.lang.Object

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

All Implemented Interfaces:

UaSubscription

public class OpcUaSubscription
extends Object
implements UaSubscription

Nested Class Summary

Nested classes/interfaces inherited from interface org.eclipse.milo.opcua.sdk.client.api.subscriptions.UaSubscription

UaSubscription.ItemCreationCallback, UaSubscription.NotificationListener

Constructor Summary

Constructors

Constructor and Description

OpcUaSubscription(OpcUaClient client, org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger subscriptionId, double revisedPublishingInterval, org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger revisedLifetimeCount, org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger revisedMaxKeepAliveCount, org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger maxNotificationsPerPublish, boolean publishingEnabled, org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UByte priority)

Method Summary

Modifier and Type	Method and Description
void	addNotificationListener(UaSubscription.NotificationListener listener) Add a UaSubscription.NotificationListener.
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.
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.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.eclipse.milo.opcua.sdk.client.api.subscriptions.UaSubscription

addTriggeringLinks, removeTriggeringLinks

Constructor Detail

OpcUaSubscription

public OpcUaSubscription(OpcUaClient client,
                         org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger subscriptionId,
                         double revisedPublishingInterval,
                         org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger revisedLifetimeCount,
                         org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger revisedMaxKeepAliveCount,
                         org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger maxNotificationsPerPublish,
                         boolean publishingEnabled,
                         org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UByte priority)

Method Detail

createMonitoredItems

public 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)

Description copied from interface: UaSubscription

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 UaSubscription.createMonitoredItems(TimestampsToReturn, List, ItemCreationCallback) to avoid this race condition.

Specified by:

createMonitoredItems in interface UaSubscription

Parameters:

timestampsToReturn - the TimestampsToReturn.

itemsToCreate - a list of MonitoredItemCreateRequests.

Returns:

a list of UaMonitoredItems.

createMonitoredItems

public 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)

Description copied from interface: UaSubscription

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.

Specified by:

createMonitoredItems in interface UaSubscription

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

public 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)

Description copied from interface: UaSubscription

Modify one or more UaMonitoredItems.

Specified by:

modifyMonitoredItems in interface UaSubscription

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

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

Description copied from interface: UaSubscription

Delete on or more UaMonitoredItems.

Specified by:

deleteMonitoredItems in interface UaSubscription

Parameters:

itemsToDelete - the items to delete.

Returns:

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

setMonitoringMode

public 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)

Description copied from interface: UaSubscription

Set the MonitoringMode for one or more UaMonitoredItems.

Specified by:

setMonitoringMode in interface UaSubscription

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

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

Description copied from interface: UaSubscription

Set the publishing mode for this subscription.

Specified by:

setPublishingMode in interface UaSubscription

Parameters:

publishingEnabled - true if publishing should be enabled.

Returns:

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

addTriggeringLinks

public 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)

Description copied from interface: UaSubscription

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

Specified by:

addTriggeringLinks in interface UaSubscription

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.

removeTriggeringLinks

public 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)

Description copied from interface: UaSubscription

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

Specified by:

removeTriggeringLinks in interface UaSubscription

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.

getSubscriptionId

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

Specified by:

getSubscriptionId in interface UaSubscription

Returns:

the server-assigned id for this UaSubscription.

getRequestedPublishingInterval

public double getRequestedPublishingInterval()

Specified by:

getRequestedPublishingInterval in interface UaSubscription

Returns:

the last requested publishing interval of this UaSubscription.

getRevisedPublishingInterval

public double getRevisedPublishingInterval()

Specified by:

getRevisedPublishingInterval in interface UaSubscription

Returns:

the actual/revised publishing interval of this UaSubscription.

getRequestedLifetimeCount

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

Specified by:

getRequestedLifetimeCount in interface UaSubscription

Returns:

the last requested lifetime count of this UaSubscription.

getRevisedLifetimeCount

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

Specified by:

getRevisedLifetimeCount in interface UaSubscription

Returns:

the actual/revised lifetime count of this UaSubscription.

getRequestedMaxKeepAliveCount

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

Specified by:

getRequestedMaxKeepAliveCount in interface UaSubscription

Returns:

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

getRevisedMaxKeepAliveCount

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

Specified by:

getRevisedMaxKeepAliveCount in interface UaSubscription

Returns:

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

getMaxNotificationsPerPublish

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

Specified by:

getMaxNotificationsPerPublish in interface UaSubscription

Returns:

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

isPublishingEnabled

public boolean isPublishingEnabled()

Specified by:

isPublishingEnabled in interface UaSubscription

Returns:

true if publishing is enabled.

getPriority

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

Specified by:

getPriority in interface UaSubscription

Returns:

the relative priority assigned to this UaSubscription.

getMonitoredItems

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

Specified by:

getMonitoredItems in interface UaSubscription

Returns:

an ImmutableList of this UaSubscription's UaMonitoredItems.

nextClientHandle

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

Specified by:

nextClientHandle in interface UaSubscription

Returns:

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

addNotificationListener

public void addNotificationListener(UaSubscription.NotificationListener listener)

Description copied from interface: UaSubscription

Add a UaSubscription.NotificationListener.

Specified by:

addNotificationListener in interface UaSubscription

Parameters:

listener - the UaSubscription.NotificationListener to add.

removeNotificationListener

public void removeNotificationListener(UaSubscription.NotificationListener listener)

Description copied from interface: UaSubscription

Remove a UaSubscription.NotificationListener.

Specified by:

removeNotificationListener in interface UaSubscription

Parameters:

listener - the UaSubscription.NotificationListener to remove.