ndn::nfd::FaceMonitor Class Reference

A subscriber for Face status change notification stream. More...

#include <ndn-cxx/mgmt/nfd/face-monitor.hpp>

+ Inheritance diagram for ndn::nfd::FaceMonitor:
+ Collaboration diagram for ndn::nfd::FaceMonitor:

Public Member Functions

 FaceMonitor (Face &face)
 
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, DataonDecodeError
 fires when a Data packet in the Notification Stream cannot be decoded as Notification More...
 
signal::Signal< NotificationSubscriberBase, lp::NackonNack
 fires when a NACK is received More...
 
signal::Signal< NotificationSubscriber, FaceEventNotificationonNotification
 fires when a Notification is received More...
 
signal::Signal< NotificationSubscriberBaseonTimeout
 fires when no Notification is received within .getInterestLifetime period More...
 

Detailed Description

A subscriber for Face status change notification stream.

See also
https://redmine.named-data.net/projects/nfd/wiki/FaceMgmt#Face-Status-Change-Notification

Definition at line 40 of file face-monitor.hpp.

Constructor & Destructor Documentation

ndn::nfd::FaceMonitor::FaceMonitor ( Face face)
explicit

Definition at line 33 of file face-monitor.cpp.

Member Function Documentation

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.

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

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

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.

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

stop receiving notifications

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

Member Data Documentation

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.

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.

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.

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.