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 
43 using ndn::util::scheduler::EventCallback;
44 
47 EventId
48 schedule(time::nanoseconds after, const EventCallback& event);
49 
52 void
53 cancel(const EventId& eventId);
54 
57 class ScopedEventId : noncopyable
58 {
59 public:
60  ScopedEventId();
61 
65  ScopedEventId(const EventId& event);
66 
70 
77  operator=(const EventId& event);
78 
82 
85  void
86  cancel();
87 
90  void
91  release();
92 
93 private:
94  EventId m_event;
95 };
96 
97 } // namespace scheduler
98 } // namespace nfd
99 
100 #endif // NFD_CORE_SCHEDULER_HPP
~ScopedEventId()
Cancels the event.
Definition: scheduler.cpp:89
void cancel(const EventId &eventId)
Cancel a scheduled event.
Definition: scheduler.cpp:53
Cancels an event automatically upon destruction.
Definition: scheduler.hpp:57
void release()
Releases the event so that it won&#39;t be cancelled when this ScopedEventId is destructed.
Definition: scheduler.cpp:101
Copyright (c) 2014-2015, Regents of the University of California, Arizona Board of Regents...
Definition: algorithm.hpp:32
ScopedEventId & operator=(const EventId &event)
Assigns an event.
Definition: scheduler.cpp:80
EventId schedule(time::nanoseconds after, const EventCallback &event)
Schedule an event.
Definition: scheduler.cpp:47
void cancel()
Cancels the event manually.
Definition: scheduler.cpp:95
Opaque handle for a scheduled event.