org.eclipse.milo.opcua.sdk.server.subscriptions

Class Subscription

java.lang.Object

org.eclipse.milo.opcua.sdk.server.subscriptions.Subscription

public class Subscription
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Subscription.State
static interface	Subscription.StateListener

Constructor Summary

Constructors

Constructor and Description
Subscription(SubscriptionManager subscriptionManager, UInteger subscriptionId, double publishingInterval, long maxKeepAliveCount, long lifetimeCount, long maxNotificationsPerPublish, boolean publishingEnabled, int priority)

Method Summary

Modifier and Type	Method and Description
StatusCode	acknowledge(UInteger sequenceNumber)
void	addMonitoredItems(List<BaseMonitoredItem<?>> createdItems)
List<BaseMonitoredItem<?>>	deleteSubscription()
UInteger[]	getAvailableSequenceNumbers()
UInteger	getDisabledMonitoredItemCount()
UInteger	getId()
long	getKeepAliveCounter() Get the current value of the keep alive counter.
long	getLifetimeCount()
long	getLifetimeCounter() Get the current value of the lifetime counter.
long	getMaxKeepAliveCount()
int	getMaxNotificationsPerPublish()
UInteger	getMonitoredItemCount()
Map<UInteger,BaseMonitoredItem<?>>	getMonitoredItems()
UInteger	getNextSequenceNumber() Get the sequence number of the next notification message.
int	getPriority()
double	getPublishingInterval()
Session	getSession()
SubscriptionDiagnostics	getSubscriptionDiagnostics()
SubscriptionManager	getSubscriptionManager()
UInteger	getUnacknowledgeMessageCount()
boolean	isPublishingEnabled()
void	modifySubscription(ModifySubscriptionRequest request)
long	nextItemId()
void	removeMonitoredItems(List<BaseMonitoredItem<?>> deletedItems)
NotificationMessage	republish(UInteger sequenceNumber)
void	setPublishingMode(SetPublishingModeRequest request)
void	setStateListener(Subscription.StateListener listener)
void	setSubscriptionManager(SubscriptionManager subscriptionManager)

Methods inherited from class java.lang.Object

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

Constructor Detail

Subscription

public Subscription(SubscriptionManager subscriptionManager,
                    UInteger subscriptionId,
                    double publishingInterval,
                    long maxKeepAliveCount,
                    long lifetimeCount,
                    long maxNotificationsPerPublish,
                    boolean publishingEnabled,
                    int priority)

Method Detail

modifySubscription

public void modifySubscription(ModifySubscriptionRequest request)

deleteSubscription

public List<BaseMonitoredItem<?>> deleteSubscription()

setPublishingMode

public void setPublishingMode(SetPublishingModeRequest request)

addMonitoredItems

public void addMonitoredItems(List<BaseMonitoredItem<?>> createdItems)

removeMonitoredItems

public void removeMonitoredItems(List<BaseMonitoredItem<?>> deletedItems)

getMonitoredItems

public Map<UInteger,BaseMonitoredItem<?>> getMonitoredItems()

getId

public UInteger getId()

getPublishingInterval

public double getPublishingInterval()

getMaxKeepAliveCount

public long getMaxKeepAliveCount()

getLifetimeCount

public long getLifetimeCount()

getMaxNotificationsPerPublish

public int getMaxNotificationsPerPublish()

isPublishingEnabled

public boolean isPublishingEnabled()

getPriority

public int getPriority()

getKeepAliveCounter

public long getKeepAliveCounter()

Get the current value of the keep alive counter.

Returns:

the current value of the keep alive counter.

getLifetimeCounter

public long getLifetimeCounter()

Get the current value of the lifetime counter.

Returns:

the current value of the lifetime counter.

getMonitoredItemCount

public UInteger getMonitoredItemCount()

getDisabledMonitoredItemCount

public UInteger getDisabledMonitoredItemCount()

getNextSequenceNumber

public UInteger getNextSequenceNumber()

Get the sequence number of the next notification message.

Returns:

the sequence number of the next notification message.

getAvailableSequenceNumbers

public UInteger[] getAvailableSequenceNumbers()

getUnacknowledgeMessageCount

public UInteger getUnacknowledgeMessageCount()

getSubscriptionManager

public SubscriptionManager getSubscriptionManager()

setSubscriptionManager

public void setSubscriptionManager(SubscriptionManager subscriptionManager)

getSession

public Session getSession()

nextItemId

public long nextItemId()

setStateListener

public void setStateListener(Subscription.StateListener listener)

acknowledge

public StatusCode acknowledge(UInteger sequenceNumber)

republish

public NotificationMessage republish(UInteger sequenceNumber)

getSubscriptionDiagnostics

public SubscriptionDiagnostics getSubscriptionDiagnostics()