ndn::util::NotificationSubscriberBase Class Reference

#include <ndn-cxx/util/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
ndn::signal::Signal< NotificationSubscriberBase, Data >	onDecodeError
	Fires when a Data packet in the notification stream cannot be decoded as a Notification. More...
ndn::signal::Signal< NotificationSubscriberBase, lp::Nack >	onNack
	Fires when a Nack is received. More...
ndn::signal::Signal< NotificationSubscriberBase >	onTimeout
	Fires when no Notification is received within getInterestLifetime() period. More...

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

Detailed Description

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

Constructor & Destructor Documentation

~NotificationSubscriberBase()

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

virtualdefault

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

Member Function Documentation

getInterestLifetime()

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

isRunning()

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

inline

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

start()

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

stop()

void ndn::util::NotificationSubscriberBase::stop

(

)

Stop receiving notifications.

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

Member Data Documentation

onDecodeError

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

Fires when a Data packet in the notification stream cannot be decoded as a Notification.

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

onNack

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

Fires when a Nack is received.

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

onTimeout

ndn::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.