NS-3 based Named Data Networking (NDN) simulator
ndnSIM 2.3: NDN, CCN, CCNx, content centric networks 		API Documentation
Public Member Functions | List of all members
nfd::scheduler::ScopedEventId Class Reference

cancels an event automatically upon destruction More...

#include <scheduler.hpp>

Inheritance diagram for nfd::scheduler::ScopedEventId:
Inheritance graph
[legend]
Collaboration diagram for nfd::scheduler::ScopedEventId:
Collaboration graph
[legend]

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 disconnected when this ScopedEventId is destructed More...
 

Detailed Description

cancels an event automatically upon destruction

Definition at line 59 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.

References nfd::scheduler::cancel().

Member Function Documentation

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.

References nfd::scheduler::cancel().

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

cancels the event manually

Definition at line 95 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(), nfd::face::TcpTransport::handleError(), nfd::rib::PropagatedEntry::initialize(), and nfd::face::LpReliability::piggyback().

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

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

Definition at line 101 of file scheduler.cpp.

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