scheduler-scoped-event-id.cpp
Go to the documentation of this file.
1 /* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
2 /*
3  * Copyright (c) 2013-2018 Regents of the University of California.
4  *
5  * This file is part of ndn-cxx library (NDN C++ library with eXperimental eXtensions).
6  *
7  * ndn-cxx library is free software: you can redistribute it and/or modify it under the
8  * terms of the GNU Lesser General Public License as published by the Free Software
9  * Foundation, either version 3 of the License, or (at your option) any later version.
10  *
11  * ndn-cxx library is distributed in the hope that it will be useful, but WITHOUT ANY
12  * WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A
13  * PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details.
14  *
15  * You should have received copies of the GNU General Public License and GNU Lesser
16  * General Public License along with ndn-cxx, e.g., in COPYING.md file. If not, see
17  * <http://www.gnu.org/licenses/>.
18  *
19  * See AUTHORS.md for complete list of ndn-cxx authors and contributors.
20  */
21 
23 
24 namespace ndn {
25 namespace util {
26 namespace scheduler {
27 
29  : m_scheduler(&scheduler)
30 {
31 }
32 
35 {
36  if (m_event != event) {
37  cancel();
38  m_event = std::move(event);
39  }
40  return *this;
41 }
42 
44 {
45  cancel();
46 }
47 
48 void
50 {
51  m_scheduler->cancelEvent(m_event);
52 }
53 
54 void
56 {
57  m_event.reset();
58 }
59 
60 } // namespace scheduler
61 } // namespace util
62 } // namespace ndn
void reset() noexcept
clear this EventId
Definition: scheduler.hpp:90
Copyright (c) 2013-2017 Regents of the University of California.
Definition: common.hpp:65
void cancelEvent(const EventId &eventId)
Cancel a scheduled event.
Definition: scheduler.cpp:104
~ScopedEventId()
Destructor, automatically cancels the event.
void release() noexcept
Release the event so that it won&#39;t be canceled when this ScopedEventId is destructed.
ScopedEventId & operator=(const ScopedEventId &)=delete
Event that is automatically cancelled upon destruction.
void cancel()
Manually cancel the event.
Identifies a scheduled event.
Definition: scheduler.hpp:53
ScopedEventId(Scheduler &scheduler) noexcept
Construct ScopedEventId tied to the specified scheduler.