unicast-udp-transport.hpp
Go to the documentation of this file.
1 /* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
2 /*
3  * Copyright (c) 2014-2024, 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_DAEMON_FACE_UNICAST_UDP_TRANSPORT_HPP
27 #define NFD_DAEMON_FACE_UNICAST_UDP_TRANSPORT_HPP
28 
29 #include "datagram-transport.hpp"
30 
31 #include <ndn-cxx/util/scheduler.hpp>
32 
33 #include <boost/asio/ip/udp.hpp>
34 
35 namespace nfd::face {
36 
37 NFD_LOG_MEMBER_DECL_SPECIALIZED((DatagramTransport<boost::asio::ip::udp, Unicast>));
38 
42 class UnicastUdpTransport final : public DatagramTransport<boost::asio::ip::udp, Unicast>
43 {
44 public:
45  UnicastUdpTransport(boost::asio::ip::udp::socket&& socket,
46  ndn::nfd::FacePersistency persistency,
47  time::nanoseconds idleTimeout);
48 
49 protected:
50  bool
51  canChangePersistencyToImpl(ndn::nfd::FacePersistency newPersistency) const final;
52 
53  void
54  afterChangePersistency(ndn::nfd::FacePersistency oldPersistency) final;
55 
56 private:
57  void
58  scheduleClosureWhenIdle();
59 
60 private:
61  const time::nanoseconds m_idleTimeout;
62  ndn::scheduler::ScopedEventId m_closeIfIdleEvent;
63 };
64 
65 } // namespace nfd::face
66 
67 #endif // NFD_DAEMON_FACE_UNICAST_UDP_TRANSPORT_HPP
Implements a Transport for datagram-based protocols.
A Transport that communicates on a unicast UDP socket.
UnicastUdpTransport(boost::asio::ip::udp::socket &&socket, ndn::nfd::FacePersistency persistency, time::nanoseconds idleTimeout)
void afterChangePersistency(ndn::nfd::FacePersistency oldPersistency) final
Invoked after the persistency has been changed.
bool canChangePersistencyToImpl(ndn::nfd::FacePersistency newPersistency) const final
Invoked by canChangePersistencyTo to perform the check.
#define NFD_LOG_MEMBER_DECL_SPECIALIZED(cls)
Definition: logger.hpp:33