NS-3 based Named Data Networking (NDN) simulator
ndnSIM 2.3: NDN, CCN, CCNx, content centric networks 		API Documentation
Classes | Public Types | Public Member Functions | List of all members
ndn::util::scheduler::Scheduler Class Reference

Generic scheduler. More...

#include <scheduler.hpp>

Inheritance diagram for ndn::util::scheduler::Scheduler:
Inheritance graph
[legend]
Collaboration diagram for ndn::util::scheduler::Scheduler:
Collaboration graph
[legend]

Public Types

typedef EventCallback Event
 

Public Member Functions

 Scheduler (boost::asio::io_service &ioService)
 
 ~Scheduler ()
 
EventId scheduleEvent (const time::nanoseconds &after, const Event &event)
 Schedule a one-time event after the specified delay. More...
 
void cancelEvent (const EventId &eventId)
 Cancel a scheduled event. More...
 
void cancelAllEvents ()
 Cancel all scheduled events. More...
 

Detailed Description

Generic scheduler.

Definition at line 53 of file scheduler.hpp.

Member Typedef Documentation

typedef EventCallback ndn::util::scheduler::Scheduler::Event
Deprecated:
use EventCallback

Definition at line 59 of file scheduler.hpp.

Constructor & Destructor Documentation

ndn::util::scheduler::Scheduler::Scheduler ( boost::asio::io_service &  ioService)
explicit

Definition at line 49 of file scheduler.cpp.

ndn::util::scheduler::Scheduler::~Scheduler ( )

Definition at line 54 of file scheduler.cpp.

References cancelAllEvents().

Member Function Documentation

EventId ndn::util::scheduler::Scheduler::scheduleEvent ( const time::nanoseconds &  after,
const Event &  event 
)

Schedule a one-time event after the specified delay.

Returns
EventId that can be used to cancel the scheduled event

Definition at line 60 of file scheduler.cpp.

Referenced by ndn::dns::Resolver::asyncResolve(), ndn::util::SegmentFetcher::fetch(), and ndn::util::NotificationSubscriberBase::stop().

void ndn::util::scheduler::Scheduler::cancelEvent ( const EventId &  eventId)

Cancel a scheduled event.

Definition at line 81 of file scheduler.cpp.

Referenced by ndn::util::scheduler::ScopedEventId::cancel(), ndn::util::scheduler::ScopedEventId::operator=(), ndn::dns::Resolver::syncResolve(), and ndn::util::scheduler::ScopedEventId::~ScopedEventId().

void ndn::util::scheduler::Scheduler::cancelAllEvents ( )

Cancel all scheduled events.

Definition at line 91 of file scheduler.cpp.

Referenced by ~Scheduler().

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