NS-3 based Named Data Networking (NDN) simulator
ndnSIM 2.0: NDN, CCN, CCNx, content centric networks
API Documentation
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
nfd::scheduler::ScopedEventId Class Reference

cancels an event automatically upon destruction More...

#include <scheduler.hpp>

Inheritance diagram for nfd::scheduler::ScopedEventId:
Collaboration diagram for nfd::scheduler::ScopedEventId:

Public Member Functions

 ScopedEventId ()
 
 ScopedEventId (const EventId &event)
 implicit constructor from EventId More...
 
 ScopedEventId (ScopedEventId &&other)
 move constructor More...
 
ScopedEventIdoperator= (const EventId &event)
 assigns an event More...
 
 ~ScopedEventId ()
 cancels the event More...
 
void cancel ()
 cancels the event manually More...
 
void release ()
 releases the event so that it won't be disconnected when this ScopedEventId is destructed More...
 

Detailed Description

cancels an event automatically upon destruction

Definition at line 53 of file scheduler.hpp.

Constructor & Destructor Documentation

nfd::scheduler::ScopedEventId::ScopedEventId ( )

Definition at line 66 of file scheduler.cpp.

nfd::scheduler::ScopedEventId::ScopedEventId ( const EventId event)

implicit constructor from EventId

Parameters
eventthe event to be cancelled upon destruction

Definition at line 70 of file scheduler.cpp.

nfd::scheduler::ScopedEventId::ScopedEventId ( ScopedEventId &&  other)

move constructor

Definition at line 75 of file scheduler.cpp.

nfd::scheduler::ScopedEventId::~ScopedEventId ( )

cancels the event

Definition at line 91 of file scheduler.cpp.

References nfd::scheduler::cancel().

Member Function Documentation

void nfd::scheduler::ScopedEventId::cancel ( )

cancels the event manually

Definition at line 97 of file scheduler.cpp.

References nfd::scheduler::cancel().

ScopedEventId & nfd::scheduler::ScopedEventId::operator= ( const EventId event)

assigns an event

If a different event has been assigned to this instance previously, that event will be cancelled immediately.

Definition at line 82 of file scheduler.cpp.

References nfd::scheduler::cancel().

void nfd::scheduler::ScopedEventId::release ( )

releases the event so that it won't be disconnected when this ScopedEventId is destructed

Definition at line 103 of file scheduler.cpp.


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