com.inductiveautomation.opcua.subscriptions

Interface Subscription

All Superinterfaces:

PublishRequestConsumer, SubscriptionServiceProvider, SubscriptionStatsProvider

public interface Subscription
extends SubscriptionServiceProvider, SubscriptionStatsProvider

Nested Class Summary

Nested classes/interfaces inherited from interface com.inductiveautomation.opcua.subscriptions.SubscriptionServiceProvider

SubscriptionServiceProvider.SetTriggeringResult

Method Summary

Modifier and Type	Method and Description
void	addMonitoredItems(java.util.List<IMonitoredItem> itemsToAdd)
long	getMaxKeepAliveCount() Gets this Subscription's max keep-alive count.
long	getMaxLifetimeCount() Gets this Subscription's max lifetime count.
long	getMaxNotificationsPerPublish() The maximum number of notifications that the client wishes to receive in a single PublishResponse.
byte	getPriority() Gets the priority byte for this Subscription.
double	getPublishingInterval() Gets the publishing interval for this Subscription.
java.util.Set<UInt32>	getRetransmissionSequenceNumbers()
UInt32	getSubscriptionId() Gets the id of this Subscription.
boolean	isLate()
boolean	isNotificationAvailable()
boolean	isPublishingEnabled() Checks if publishing is enabled or disabled for this Subscription.
java.util.List<java.lang.Boolean>	removeMonitoredItems(java.util.List<IMonitoredItem> itemsToRemove)
void	resetLifetimeCounter()
void	setSession(Session session)
void	start() Starts this Subscription.
void	stop() Stops this Subscription.

Methods inherited from interface com.inductiveautomation.opcua.subscriptions.SubscriptionServiceProvider

modify, modifyMonitoringMode, republish, setPublishingEnabled, setTriggering

Methods inherited from interface com.inductiveautomation.opcua.subscriptions.PublishRequestConsumer

acknowledge, consume

Methods inherited from interface com.inductiveautomation.opcua.subscriptions.SubscriptionStatsProvider

getSubscriptionStats

Method Detail

start

void start()
    throws java.lang.Exception

Starts this Subscription. Registers its publishing timer with the ExecutionManager, resets the keep-alive counter, and begins operations.

Throws:

java.lang.Exception - Thrown if there is an error registering with the ExecutionManager.

stop

void stop()

Stops this Subscription. Its publishing timer is unregistered and the state is set to closed.

getMaxKeepAliveCount

long getMaxKeepAliveCount()

Gets this Subscription's max keep-alive count.

Returns:

getMaxLifetimeCount

long getMaxLifetimeCount()

Gets this Subscription's max lifetime count.

Returns:

getMaxNotificationsPerPublish

long getMaxNotificationsPerPublish()

The maximum number of notifications that the client wishes to receive in a single PublishResponse. Zero indicates no limit.

Returns:

The maximum number of notifications that the client wishes to receive in a single PublishResponse.

getPublishingInterval

double getPublishingInterval()

Gets the publishing interval for this Subscription.

Returns:

getSubscriptionId

UInt32 getSubscriptionId()

Gets the id of this Subscription.

Returns:

The UInt32 identifying this Subscription.

isPublishingEnabled

boolean isPublishingEnabled()

Checks if publishing is enabled or disabled for this Subscription.

Returns:

true if enabled, false if not.

getPriority

byte getPriority()

Gets the priority byte for this Subscription.

Returns:

a byte representing this Subscription's priority compared to others.

isLate

boolean isLate()

isNotificationAvailable

boolean isNotificationAvailable()

getRetransmissionSequenceNumbers

java.util.Set<UInt32> getRetransmissionSequenceNumbers()

setSession

void setSession(Session session)

addMonitoredItems

void addMonitoredItems(java.util.List<IMonitoredItem> itemsToAdd)

removeMonitoredItems

java.util.List<java.lang.Boolean> removeMonitoredItems(java.util.List<IMonitoredItem> itemsToRemove)

resetLifetimeCounter

void resetLifetimeCounter()