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

Class OpcUaSubscriptionManager

java.lang.Object

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

All Implemented Interfaces:

UaSubscriptionManager

public class OpcUaSubscriptionManager
extends Object
implements UaSubscriptionManager

Nested Class Summary

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

UaSubscriptionManager.SubscriptionListener

Field Summary

Fields

Modifier and Type	Field and Description
static org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger	DEFAULT_MAX_NOTIFICATIONS_PER_PUBLISH

Constructor Summary

Constructors

Constructor and Description
OpcUaSubscriptionManager(OpcUaClient client)

Method Summary

Modifier and Type	Method and Description
void	addSubscriptionListener(UaSubscriptionManager.SubscriptionListener listener) Add a UaSubscriptionManager.SubscriptionListener.
void	clearSubscriptions()
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	pauseDelivery()
void	removeSubscriptionListener(UaSubscriptionManager.SubscriptionListener listener) Remove a UaSubscriptionManager.SubscriptionListener.
void	resumeDelivery()
void	startPublishing()
void	transferFailed(org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger subscriptionId, org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode statusCode)

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_MAX_NOTIFICATIONS_PER_PUBLISH

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

Constructor Detail

OpcUaSubscriptionManager

public OpcUaSubscriptionManager(OpcUaClient client)

Method Detail

createSubscription

public CompletableFuture<UaSubscription> createSubscription(double requestedPublishingInterval)

Description copied from interface: UaSubscriptionManager

Create a UaSubscription using default parameters.

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

Specified by:

createSubscription in interface UaSubscriptionManager

Parameters:

requestedPublishingInterval - the requested publishing interval of the subscription.

Returns:

a CompletableFuture containing the UaSubscription.

createSubscription

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

Description copied from interface: UaSubscriptionManager

Create a UaSubscription.

Specified by:

createSubscription in interface UaSubscriptionManager

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

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

Description copied from interface: UaSubscriptionManager

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.

Specified by:

createSubscription in interface UaSubscriptionManager

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

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

Description copied from interface: UaSubscriptionManager

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.

Specified by:

modifySubscription in interface UaSubscriptionManager

Parameters:

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

requestedPublishingInterval - the requested publishing interval.

Returns:

a CompletableFuture containing the UaSubscription.

modifySubscription

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

Description copied from interface: UaSubscriptionManager

Modify a UaSubscription.

Specified by:

modifySubscription in interface UaSubscriptionManager

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

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

Description copied from interface: UaSubscriptionManager

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.

Specified by:

modifySubscription in interface UaSubscriptionManager

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

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

Description copied from interface: UaSubscriptionManager

Delete a UaSubscription.

Specified by:

deleteSubscription in interface UaSubscriptionManager

Parameters:

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

Returns:

a CompletableFuture containing the deleted UaSubscription.

transferFailed

public void transferFailed(org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger subscriptionId,
                           org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode statusCode)

getSubscriptions

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

Specified by:

getSubscriptions in interface UaSubscriptionManager

Returns:

an ImmutableList of UaSubscriptions managed by this UaSubscriptionManager.

addSubscriptionListener

public void addSubscriptionListener(UaSubscriptionManager.SubscriptionListener listener)

Description copied from interface: UaSubscriptionManager

Add a UaSubscriptionManager.SubscriptionListener.

Specified by:

addSubscriptionListener in interface UaSubscriptionManager

Parameters:

listener - the UaSubscriptionManager.SubscriptionListener to add.

removeSubscriptionListener

public void removeSubscriptionListener(UaSubscriptionManager.SubscriptionListener listener)

Description copied from interface: UaSubscriptionManager

Remove a UaSubscriptionManager.SubscriptionListener.

Specified by:

removeSubscriptionListener in interface UaSubscriptionManager

Parameters:

listener - the UaSubscriptionManager.SubscriptionListener to remove.

startPublishing

public void startPublishing()

clearSubscriptions

public void clearSubscriptions()

pauseDelivery

public void pauseDelivery()

resumeDelivery

public void resumeDelivery()