Event that is automatically cancelled upon destruction. More...

Inheritance diagram for ndn::util::scheduler::ScopedEventId:

Collaboration diagram for ndn::util::scheduler::ScopedEventId:

Public Member Functions
	ScopedEventId (Scheduler &scheduler)
	Construct ScopedEventId tied to the specified scheduler. More...

	ScopedEventId (ScopedEventId &&other) noexcept
	move constructor More...

	~ScopedEventId () noexcept
	cancels the event More...

void	cancel ()
	cancels the event manually More...

ScopedEventId &	operator= (const EventId &event)
	assigns an event More...

void	release () noexcept
	releases the event so that it won't be canceled when this ScopedEventId is destructed More...

Detailed Description

Event that is automatically cancelled upon destruction.

Constructor & Destructor Documentation

ndn::util::scheduler::ScopedEventId::ScopedEventId ( Scheduler & scheduler )

explicit

Construct ScopedEventId tied to the specified scheduler.

Parameters

scheduler Scheduler to which the event is tied. Behavior is undefined if scheduler is destructed before an uncanceled ScopedEventId.

ndn::util::scheduler::ScopedEventId::ScopedEventId ( ScopedEventId && other )

noexcept

move constructor

ndn::util::scheduler::ScopedEventId::~ScopedEventId ( )

noexcept

cancels the event

void ndn::util::scheduler::ScopedEventId::cancel ( )

cancels the event manually

ScopedEventId & ndn::util::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.

Note: The caller should ensure that ScopedEventId is tied to a correct scheduler. Behavior is undefined when assigning event scheduled in another scheduler instance.

void ndn::util::scheduler::ScopedEventId::release ( )

noexcept

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