Public Member Functions | Public Attributes | List of all members
ndn::util::NotificationSubscriber< Notification > Class Template Reference

provides a subscriber of Notification Stream More...

#include <ndn-cxx/util/notification-subscriber.hpp>

+ Inheritance diagram for ndn::util::NotificationSubscriber< Notification >:
+ Collaboration diagram for ndn::util::NotificationSubscriber< Notification >:

Public Member Functions

 NotificationSubscriber (Face &face, const Name &prefix, time::milliseconds interestLifetime=1_min)
 construct a NotificationSubscriber More...
 
time::milliseconds getInterestLifetime () const
 
bool isRunning () const
 
void start ()
 start or resume receiving notifications More...
 
void stop ()
 stop receiving notifications More...
 

Public Attributes

signal::Signal< NotificationSubscriberBase, Data > onDecodeError
 fires when a Data packet in the Notification Stream cannot be decoded as Notification More...
 
signal::Signal< NotificationSubscriberBase, lp::Nack > onNack
 fires when a NACK is received More...
 
signal::Signal< NotificationSubscriber, Notification > onNotification
 fires when a Notification is received More...
 
signal::Signal< NotificationSubscriberBase > onTimeout
 fires when no Notification is received within .getInterestLifetime period More...
 

Detailed Description

template<typename Notification>
class ndn::util::NotificationSubscriber< Notification >

provides a subscriber of Notification Stream

See also
https://redmine.named-data.net/projects/nfd/wiki/Notification
Template Parameters
Notificationtype of Notification item, appears in payload of Data packets

Definition at line 151 of file notification-subscriber.hpp.

Constructor & Destructor Documentation

◆ NotificationSubscriber()

template<typename Notification>
ndn::util::NotificationSubscriber< Notification >::NotificationSubscriber ( Face &  face,
const Name &  prefix,
time::milliseconds  interestLifetime = 1_min 
)
inline

construct a NotificationSubscriber

Note
The subscriber is not started after construction. User should add one or more handlers to onNotification, and invoke .start().

Definition at line 161 of file notification-subscriber.hpp.

Member Function Documentation

◆ getInterestLifetime()

time::milliseconds ndn::util::NotificationSubscriberBase::getInterestLifetime ( ) const
inlineinherited
Returns
InterestLifetime of Interests to retrieve notifications

This must be greater than FreshnessPeriod of Notification Data packets, to ensure correct operation of this subscriber implementation.

Definition at line 52 of file notification-subscriber.hpp.

◆ isRunning()

bool ndn::util::NotificationSubscriberBase::isRunning ( ) const
inlineinherited

Definition at line 58 of file notification-subscriber.hpp.

◆ start()

void ndn::util::NotificationSubscriberBase::start ( )
inherited

start or resume receiving notifications

Note
onNotification must have at least one listener, otherwise this operation has no effect.

Definition at line 52 of file notification-subscriber.cpp.

◆ stop()

void ndn::util::NotificationSubscriberBase::stop ( )
inherited

stop receiving notifications

Definition at line 62 of file notification-subscriber.cpp.

Member Data Documentation

◆ onDecodeError

signal::Signal<NotificationSubscriberBase, Data> ndn::util::NotificationSubscriberBase::onDecodeError
inherited

fires when a Data packet in the Notification Stream cannot be decoded as Notification

Definition at line 131 of file notification-subscriber.hpp.

◆ onNack

signal::Signal<NotificationSubscriberBase, lp::Nack> ndn::util::NotificationSubscriberBase::onNack
inherited

fires when a NACK is received

Definition at line 123 of file notification-subscriber.hpp.

◆ onNotification

template<typename Notification>
signal::Signal<NotificationSubscriber, Notification> ndn::util::NotificationSubscriber< Notification >::onNotification

fires when a Notification is received

Note
Removing all handlers will cause the subscriber to stop.

Definition at line 171 of file notification-subscriber.hpp.

◆ onTimeout

signal::Signal<NotificationSubscriberBase> ndn::util::NotificationSubscriberBase::onTimeout
inherited

fires when no Notification is received within .getInterestLifetime period

Definition at line 127 of file notification-subscriber.hpp.