nfd::scheduler::ScopedEventId Class Reference

Cancels an event automatically upon destruction. More...

#include <core/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...
 
 ~ScopedEventId ()
 Cancels the event. More...
 
void cancel ()
 Cancels the event manually. More...
 
ScopedEventIdoperator= (const EventId &event)
 Assigns an event. More...
 
void release ()
 Releases the event so that it won't be cancelled when this ScopedEventId is destructed. More...
 

Detailed Description

Cancels an event automatically upon destruction.

Definition at line 57 of file scheduler.hpp.

Constructor & Destructor Documentation

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

Definition at line 64 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 68 of file scheduler.cpp.

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

Move constructor.

Definition at line 73 of file scheduler.cpp.

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

Cancels the event.

Definition at line 89 of file scheduler.cpp.

Member Function Documentation

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

Cancels the event manually.

Definition at line 95 of file scheduler.cpp.

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 80 of file scheduler.cpp.

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

Releases the event so that it won't be cancelled when this ScopedEventId is destructed.

Definition at line 101 of file scheduler.cpp.