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

Interface UaSubscriptionManager

All Known Implementing Classes:

OpcUaSubscriptionManager

public interface UaSubscriptionManager

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	UaSubscriptionManager.SubscriptionListener

Method Summary

Modifier and Type	Method and Description
void	addSubscriptionListener(UaSubscriptionManager.SubscriptionListener listener) Add a UaSubscriptionManager.SubscriptionListener.
CompletableFuture<UaSubscription>	createSubscription(double requestedPublishingInterval) Create a UaSubscription using default parameters.
CompletableFuture<UaSubscription>	createSubscription(double requestedPublishingInterval, BiFunction<Double,org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger,org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger> getLifetimeCount, Function<Double,org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger> getMaxKeepAliveCount, org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger maxNotificationsPerPublish, boolean publishingEnabled, org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UByte priority) Create a UaSubscription.
CompletableFuture<UaSubscription>	createSubscription(double requestedPublishingInterval, org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger requestedLifetimeCount, org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger requestedMaxKeepAliveCount, org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger maxNotificationsPerPublish, boolean publishingEnabled, org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UByte priority) Create a UaSubscription.
CompletableFuture<UaSubscription>	deleteSubscription(org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger subscriptionId) Delete a UaSubscription.
com.google.common.collect.ImmutableList<UaSubscription>	getSubscriptions()
CompletableFuture<UaSubscription>	modifySubscription(org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger subscriptionId, double requestedPublishingInterval) Request a new publishing interval for a UaSubscription.
CompletableFuture<UaSubscription>	modifySubscription(org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger subscriptionId, double requestedPublishingInterval, BiFunction<Double,org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger,org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger> getLifetimeCount, Function<Double,org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger> getMaxKeepAliveCount, org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger maxNotificationsPerPublish, org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UByte priority) Modify a UaSubscription.
CompletableFuture<UaSubscription>	modifySubscription(org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger subscriptionId, double requestedPublishingInterval, org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger requestedLifetimeCount, org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger requestedMaxKeepAliveCount, org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger maxNotificationsPerPublish, org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UByte priority) Modify a UaSubscription.
void	removeSubscriptionListener(UaSubscriptionManager.SubscriptionListener listener) Remove a UaSubscriptionManager.SubscriptionListener.

Method Detail

createSubscription

CompletableFuture<UaSubscription> createSubscription(double requestedPublishingInterval)

Create a UaSubscription using default parameters.

The requested max keep-alive count and lifetime count will be derived from the requested publishing interval.

Parameters:

requestedPublishingInterval - the requested publishing interval of the subscription.

Returns:

a CompletableFuture containing the UaSubscription.

createSubscription

CompletableFuture<UaSubscription> createSubscription(double requestedPublishingInterval,
                                                     org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger requestedLifetimeCount,
                                                     org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger requestedMaxKeepAliveCount,
                                                     org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger maxNotificationsPerPublish,
                                                     boolean publishingEnabled,
                                                     org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UByte priority)

Create a UaSubscription.

Parameters:

requestedPublishingInterval - the requested publishing interval.

requestedLifetimeCount - the requested lifetime count.

requestedMaxKeepAliveCount - the requested max keep-alive count.

maxNotificationsPerPublish - the maximum number of notifications allowed in a publish response.

publishingEnabled - true if publishing is enabled for the subscription.

priority - the relative priority to assign to the subscription.

Returns:

a CompletableFuture containing the UaSubscription.

createSubscription

CompletableFuture<UaSubscription> createSubscription(double requestedPublishingInterval,
                                                     BiFunction<Double,org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger,org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger> getLifetimeCount,
                                                     Function<Double,org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger> getMaxKeepAliveCount,
                                                     org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger maxNotificationsPerPublish,
                                                     boolean publishingEnabled,
                                                     org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UByte priority)

Create a UaSubscription.

This overload uses provided functions to calculate keep-alive and lifetime counts. They may be called more than once, with revised values, in order to modify the subscription if the server revises the requested publishing interval.

Parameters:

requestedPublishingInterval - the requested publishing interval.

getLifetimeCount - function returning lifetime count given publishing interval and keep-alive count.

getMaxKeepAliveCount - function returning max keep-alive count given publishing interval.

maxNotificationsPerPublish - the maximum number of notifications allowed in a publish response.

publishingEnabled - true if publishing is enabled for the subscription.

priority - the relative priority to assign to the subscription.

Returns:

a CompletableFuture containing the UaSubscription.

modifySubscription

CompletableFuture<UaSubscription> modifySubscription(org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger subscriptionId,
                                                     double requestedPublishingInterval)

Request a new publishing interval for a UaSubscription.

The requested max keep-alive count and lifetime count will be derived from the requested publishing interval.

Parameters:

subscriptionId - the server-assigned id of the UaSubscription to modify.

requestedPublishingInterval - the requested publishing interval.

Returns:

a CompletableFuture containing the UaSubscription.

modifySubscription

CompletableFuture<UaSubscription> modifySubscription(org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger subscriptionId,
                                                     double requestedPublishingInterval,
                                                     org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger requestedLifetimeCount,
                                                     org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger requestedMaxKeepAliveCount,
                                                     org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger maxNotificationsPerPublish,
                                                     org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UByte priority)

Modify a UaSubscription.

Parameters:

subscriptionId - the server-assigned id of the UaSubscription to modify.

requestedPublishingInterval - the requested publishing interval.

requestedLifetimeCount - the requested lifetime count.

requestedMaxKeepAliveCount - the requested max keep-alive count.

maxNotificationsPerPublish - the maximum number of notifications allowed in a publish response.

priority - the relative priority to assign to the subscription.

Returns:

a CompletableFuture containing the UaSubscription.

modifySubscription

CompletableFuture<UaSubscription> modifySubscription(org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger subscriptionId,
                                                     double requestedPublishingInterval,
                                                     BiFunction<Double,org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger,org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger> getLifetimeCount,
                                                     Function<Double,org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger> getMaxKeepAliveCount,
                                                     org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger maxNotificationsPerPublish,
                                                     org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UByte priority)

Modify a UaSubscription.

This overload uses provided functions to calculate keep-alive and lifetime counts. They may be called more than once, with revised values, in order to modify the subscription if the server revises the requested publishing interval.

Parameters:

subscriptionId - the server-assigned id of the UaSubscription to modify.

requestedPublishingInterval - the requested publishing interval.

getLifetimeCount - function returning lifetime count given publishing interval and keep-alive count.

getMaxKeepAliveCount - function returning max keep-alive count given publishing interval.

maxNotificationsPerPublish - the maximum number of notifications allowed in a publish response.

priority - the relative priority to assign to the subscription.

Returns:

a CompletableFuture containing the UaSubscription.

deleteSubscription

CompletableFuture<UaSubscription> deleteSubscription(org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger subscriptionId)

Delete a UaSubscription.

Parameters:

subscriptionId - the server-assigned id of the UaSubscription to delete.

Returns:

a CompletableFuture containing the deleted UaSubscription.

getSubscriptions

com.google.common.collect.ImmutableList<UaSubscription> getSubscriptions()

Returns:

an ImmutableList of UaSubscriptions managed by this UaSubscriptionManager.

addSubscriptionListener

void addSubscriptionListener(UaSubscriptionManager.SubscriptionListener listener)

Add a UaSubscriptionManager.SubscriptionListener.

Parameters:

listener - the UaSubscriptionManager.SubscriptionListener to add.

removeSubscriptionListener

void removeSubscriptionListener(UaSubscriptionManager.SubscriptionListener listener)

Remove a UaSubscriptionManager.SubscriptionListener.

Parameters:

listener - the UaSubscriptionManager.SubscriptionListener to remove.