NS-3 based Named Data Networking (NDN) simulator
ndnSIM 2.5: NDN, CCN, CCNx, content centric networks
API Documentation
scheduler.hpp
Go to the documentation of this file.
1 /* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
2 /*
3  * Copyright (c) 2014-2018, Regents of the University of California,
4  * Arizona Board of Regents,
5  * Colorado State University,
6  * University Pierre & Marie Curie, Sorbonne University,
7  * Washington University in St. Louis,
8  * Beijing Institute of Technology,
9  * The University of Memphis.
10  *
11  * This file is part of NFD (Named Data Networking Forwarding Daemon).
12  * See AUTHORS.md for complete list of NFD authors and contributors.
13  *
14  * NFD is free software: you can redistribute it and/or modify it under the terms
15  * of the GNU General Public License as published by the Free Software Foundation,
16  * either version 3 of the License, or (at your option) any later version.
17  *
18  * NFD is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY;
19  * without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
20  * PURPOSE. See the GNU General Public License for more details.
21  *
22  * You should have received a copy of the GNU General Public License along with
23  * NFD, e.g., in COPYING.md file. If not, see <http://www.gnu.org/licenses/>.
24  */
25 
26 #ifndef NFD_CORE_SCHEDULER_HPP
27 #define NFD_CORE_SCHEDULER_HPP
28 
29 #include "common.hpp"
30 
31 #include <ndn-cxx/util/scheduler.hpp>
32 
33 namespace nfd {
34 namespace scheduler {
35 
36 using ndn::Scheduler;
37 
41 using ndn::EventId;
42 
44 
47 EventId
48 schedule(time::nanoseconds after, const EventCallback& event);
49 
52 void
53 cancel(const EventId& eventId);
54 
55 Scheduler&
57 
60 class ScopedEventId : noncopyable
61 {
62 public:
63  ScopedEventId();
64 
68  ScopedEventId(const EventId& event);
69 
73 
80  operator=(const EventId& event);
81 
85 
88  void
89  cancel();
90 
93  void
94  release();
95 
96 private:
97  EventId m_event;
98 };
99 
100 } // namespace scheduler
101 } // namespace nfd
102 
103 #endif // NFD_CORE_SCHEDULER_HPP
function< void()> EventCallback
Definition: scheduler.hpp:46
Opaque handle for a scheduled event.
void cancel()
Cancels the event manually.
Definition: scheduler.cpp:96
ScopedEventId & operator=(const EventId &event)
Assigns an event.
Definition: scheduler.cpp:81
void cancel(const EventId &eventId)
Cancel a scheduled event.
Definition: scheduler.cpp:54
~ScopedEventId()
Cancels the event.
Definition: scheduler.cpp:90
std::shared_ptr< ns3::EventId > EventId
Definition: scheduler.hpp:51
void release()
Releases the event so that it won&#39;t be cancelled when this ScopedEventId is destructed.
Definition: scheduler.cpp:102
Copyright (c) 2011-2015 Regents of the University of California.
Definition: ndn-common.hpp:40
Cancels an event automatically upon destruction.
Definition: scheduler.hpp:60
EventId schedule(time::nanoseconds after, const EventCallback &event)
Schedule an event.
Definition: scheduler.cpp:48
Scheduler & getGlobalScheduler()
Definition: scheduler.cpp:37