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

Interface UaSubscriptionManager.SubscriptionListener

Enclosing interface:

UaSubscriptionManager

public static interface UaSubscriptionManager.SubscriptionListener

Method Summary

Modifier and Type	Method and Description
default void	onKeepAlive(UaSubscription subscription, org.eclipse.milo.opcua.stack.core.types.builtin.DateTime publishTime) A keep-alive message was received.
default void	onNotificationDataLost(UaSubscription subscription) Attempts to recover missed notification data have failed.
default void	onPublishFailure(org.eclipse.milo.opcua.stack.core.UaException exception) A publish failure has occurred.
default void	onStatusChanged(UaSubscription subscription, org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode status) A status change notification was received.
default void	onSubscriptionTransferFailed(UaSubscription subscription, org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode statusCode) A new UaSession was established, and upon attempting to transfer an existing subscription to this new session, a failure occurred.
default void	onSubscriptionWatchdogTimerElapsed(UaSubscription subscription) The subscription watchdog timer has elapsed.

Method Detail

onKeepAlive

default void onKeepAlive(UaSubscription subscription,
                         org.eclipse.milo.opcua.stack.core.types.builtin.DateTime publishTime)

A keep-alive message was received.

Parameters:

subscription - the UaSubscription that received the keep-alive.

publishTime - the time the server published the keep-alive.

onStatusChanged

default void onStatusChanged(UaSubscription subscription,
                             org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode status)

A status change notification was received.

Parameters:

subscription - the UaSubscription that received the status change.

status - the new subscription status.

onPublishFailure

default void onPublishFailure(org.eclipse.milo.opcua.stack.core.UaException exception)

A publish failure has occurred.

No additional action is required.

Parameters:

exception - the cause of the failure.

onNotificationDataLost

default void onNotificationDataLost(UaSubscription subscription)

Attempts to recover missed notification data have failed.

When a notification is missed a series of Republish requests are initiated to recover the missing data. If republishing fails, or any of the notifications are no longer available, this callback will be invoked.

Parameters:

subscription - the subscription that missed notification data.

onSubscriptionTransferFailed

default void onSubscriptionTransferFailed(UaSubscription subscription,
                                          org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode statusCode)

A new UaSession was established, and upon attempting to transfer an existing subscription to this new session, a failure occurred.

This subscription will be removed from UaSubscriptionManager's bookkeeping. It must be re-created.

Parameters:

subscription - the UaSubscription that could not be transferred.

statusCode - the StatusCode for the transfer failure.

onSubscriptionWatchdogTimerElapsed

default void onSubscriptionWatchdogTimerElapsed(UaSubscription subscription)

The subscription watchdog timer has elapsed. The receiver of this callback should consider deleting and re-creating this subscription or taking other appropriate action.

The timer elapses when 125% of the expected keep-alive interval has passed since receipt of the last PublishResponse. The watchdog timer will not be restarted unless a new PublishResponse for this subscription is received.

The expected keep-alive interval is publishingInterval * keepAliveCount milliseconds.

Parameters:

subscription - the UaSubscription that has not received a response.