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

Interface UaSubscription.NotificationListener

Enclosing interface:

UaSubscription

public static interface UaSubscription.NotificationListener

Method Summary

Modifier and Type	Method and Description
default void	onDataChangeNotification(UaSubscription subscription, List<UaMonitoredItem> monitoredItems, List<org.eclipse.milo.opcua.stack.core.types.builtin.DataValue> dataValues, org.eclipse.milo.opcua.stack.core.types.builtin.DateTime publishTime) A notification containing data value changes for this UaSubscription has arrived.
default void	onEventNotification(UaSubscription subscription, List<UaMonitoredItem> monitoredItems, List<org.eclipse.milo.opcua.stack.core.types.builtin.Variant[]> eventFields, org.eclipse.milo.opcua.stack.core.types.builtin.DateTime publishTime) A notification containing events for this UaSubscription has arrived.
default void	onKeepAliveNotification(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	onStatusChangedNotification(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.

Method Detail

onDataChangeNotification

default void onDataChangeNotification(UaSubscription subscription,
                                      List<UaMonitoredItem> monitoredItems,
                                      List<org.eclipse.milo.opcua.stack.core.types.builtin.DataValue> dataValues,
                                      org.eclipse.milo.opcua.stack.core.types.builtin.DateTime publishTime)

A notification containing data value changes for this UaSubscription has arrived.

This callback is invoked after all individual item callbacks and is offered as an alternative to defining callbacks on a per-item basis. Its use is not required.

Parameters:

subscription - the UaSubscription that received the notification.

monitoredItems - the UaMonitoredItems that received a data value change.

dataValues - the corresponding DataValue change for each item in monitoredItems.

publishTime - the time on the server at which this notification was published.

onEventNotification

default void onEventNotification(UaSubscription subscription,
                                 List<UaMonitoredItem> monitoredItems,
                                 List<org.eclipse.milo.opcua.stack.core.types.builtin.Variant[]> eventFields,
                                 org.eclipse.milo.opcua.stack.core.types.builtin.DateTime publishTime)

A notification containing events for this UaSubscription has arrived.

This callback is invoked after all individual item callbacks and is offered as an alternative to defining callbacks on a per-item basis. Its use is not required.

Parameters:

subscription - the UaSubscription that received the notification.

monitoredItems - the UaMonitoredItems that received an event notification.

eventFields - the corresponding event field values for each item in monitoredItems.

publishTime - the time on the server at which this notification was published.

onKeepAliveNotification

default void onKeepAliveNotification(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.

onStatusChangedNotification

default void onStatusChangedNotification(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.

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.