ndn::util::NotificationSubscriberBase Class Reference

#include <notification-subscriber.hpp>

Inheritance diagram for ndn::util::NotificationSubscriberBase:

Collaboration diagram for ndn::util::NotificationSubscriberBase:

Public Member Functions
virtual	~NotificationSubscriberBase ()
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, lp::Nack >	onNack
	fires when a NACK is received More...
signal::Signal< NotificationSubscriberBase >	onTimeout
	fires when no Notification is received within .getInterestLifetime period More...
signal::Signal< NotificationSubscriberBase, Data >	onDecodeError
	fires when a Data packet in the Notification Stream cannot be decoded as Notification More...

Protected Member Functions
	NotificationSubscriberBase (Face &face, const Name &prefix, time::milliseconds interestLifetime)
	construct a NotificationSubscriber More...

Detailed Description

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

Constructor & Destructor Documentation

ndn::util::NotificationSubscriberBase::~NotificationSubscriberBase ( )

virtualdefault

Referenced by NotificationSubscriberBase().

ndn::util::NotificationSubscriberBase::NotificationSubscriberBase ( Face &  face, const Name &  prefix, time::milliseconds  interestLifetime  )

protected

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 34 of file notification-subscriber.cpp.

References ~NotificationSubscriberBase().

Referenced by isRunning().

Member Function Documentation

time::milliseconds ndn::util::NotificationSubscriberBase::getInterestLifetime ( ) const

inline

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 53 of file notification-subscriber.hpp.

Referenced by stop().

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

inline

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

References websocketpp::lib::asio::milliseconds(), NotificationSubscriberBase(), start(), and stop().

void ndn::util::NotificationSubscriberBase::start

(

)

start or resume receiving notifications

Note

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

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

Referenced by isRunning(), and nfd::rib::RibManager::registerWithNfd().

void ndn::util::NotificationSubscriberBase::stop

(

)

stop receiving notifications

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

References ndn::Name::appendSequenceNumber(), delay(), ndn::Face::expressInterest(), ndn::random::generateWord32(), ndn::Name::get(), ndn::lp::Nack::getInterest(), getInterestLifetime(), ndn::Data::getName(), ndn::Interest::getName(), websocketpp::lib::asio::milliseconds(), onDecodeError, onNack, onTimeout, ndn::Face::removePendingInterest(), ndn::util::scheduler::Scheduler::scheduleEvent(), and ndn::name::Component::toSequenceNumber().

Referenced by isRunning().

Member Data Documentation

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

fires when a NACK is received

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

Referenced by stop().

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

fires when no Notification is received within .getInterestLifetime period

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

Referenced by stop().

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

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

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

Referenced by stop().

---

The documentation for this class was generated from the following files:

• ndnSIM/ndn-cxx/src/util/notification-subscriber.hpp
• ndnSIM/ndn-cxx/src/util/notification-subscriber.cpp