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...
ScopedEventId &	operator= (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 cancelled when this ScopedEventId is destructed. More...

Detailed Description

Cancels an event automatically upon destruction.

Definition at line 60 of file scheduler.hpp.

Constructor & Destructor Documentation

ScopedEventId() [1/3]

nfd::scheduler::ScopedEventId::ScopedEventId

(

)

Definition at line 65 of file scheduler.cpp.

ScopedEventId() [2/3]

nfd::scheduler::ScopedEventId::ScopedEventId

(

const EventId &

event

)

Implicit constructor from EventId.

Parameters

event

the event to be cancelled upon destruction

Definition at line 69 of file scheduler.cpp.

ScopedEventId() [3/3]

nfd::scheduler::ScopedEventId::ScopedEventId

(

ScopedEventId &&

other

)

Move constructor.

Definition at line 74 of file scheduler.cpp.

~ScopedEventId()

nfd::scheduler::ScopedEventId::~ScopedEventId

(

)

Cancels the event.

Definition at line 90 of file scheduler.cpp.

References nfd::scheduler::cancel().

Member Function Documentation

operator=()

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

References nfd::scheduler::cancel().

cancel()

void nfd::scheduler::ScopedEventId::cancel

(

)

Cancels the event manually.

Definition at line 96 of file scheduler.cpp.

References nfd::scheduler::cancel().

Referenced by nfd::face::UnicastUdpTransport::afterChangePersistency(), nfd::face::UnicastEthernetTransport::afterChangePersistency(), nfd::face::TcpTransport::doClose(), nfd::face::WebSocketTransport::doClose(), and nfd::rib::PropagatedEntry::initialize().

release()

void nfd::scheduler::ScopedEventId::release

(

)

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

Definition at line 102 of file scheduler.cpp.

---

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

• ndnSIM/NFD/core/scheduler.hpp
• ndnSIM/NFD/core/scheduler.cpp