Public Member Functions | Friends | List of all members
ndn::util::scheduler::EventId Class Reference

Identifies a scheduled event. More...

#include <scheduler.hpp>

Public Member Functions

constexpr EventId (std::nullptr_t=nullptr) noexcept
 Constructs an empty EventId. More...
 
 operator bool () const noexcept
 
bool operator!= (const EventId &other) const noexcept
 
bool operator== (const EventId &other) const noexcept
 
void reset () noexcept
 clear this EventId More...
 

Friends

std::ostream & operator<< (std::ostream &os, const EventId &eventId)
 
class Scheduler
 

Detailed Description

Identifies a scheduled event.

Definition at line 53 of file scheduler.hpp.

Constructor & Destructor Documentation

constexpr ndn::util::scheduler::EventId::EventId ( std::nullptr_t  = nullptr)
inlinenoexcept

Constructs an empty EventId.

Note
EventId is implicitly convertible from nullptr.

Definition at line 61 of file scheduler.hpp.

Member Function Documentation

ndn::util::scheduler::EventId::operator bool ( ) const
explicitnoexcept
Return values
trueThe event is valid.
falseThis EventId is empty, or the event is expired or cancelled.

Definition at line 54 of file scheduler.cpp.

bool ndn::util::scheduler::EventId::operator!= ( const EventId &  other) const
inlinenoexcept

Definition at line 79 of file scheduler.hpp.

bool ndn::util::scheduler::EventId::operator== ( const EventId &  other) const
noexcept
Returns
whether this and other refer to the same event, or are both empty/expired/cancelled

Definition at line 61 of file scheduler.cpp.

void ndn::util::scheduler::EventId::reset ( )
inlinenoexcept

clear this EventId

Note
This does not cancel the event.
Postcondition
!(*this)

Definition at line 90 of file scheduler.hpp.

Friends And Related Function Documentation

std::ostream& operator<< ( std::ostream &  os,
const EventId &  eventId 
)
friend

Definition at line 68 of file scheduler.cpp.

friend class Scheduler
friend

Definition at line 105 of file scheduler.hpp.