ethernet-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_ETHERNET_TRANSPORT_HPP
27 #define NFD_DAEMON_FACE_ETHERNET_TRANSPORT_HPP
28 
29 #include "ethernet-protocol.hpp"
30 #include "pcap-helper.hpp"
31 #include "transport.hpp"
32 
33 #include <boost/asio/posix/stream_descriptor.hpp>
34 #include <ndn-cxx/net/network-interface.hpp>
35 
36 namespace nfd::face {
37 
42 {
43 public:
44  class Error : public std::runtime_error
45  {
46  public:
47  using std::runtime_error::runtime_error;
48  };
49 
55  void
56  receivePayload(span<const uint8_t> payload, const ethernet::Address& sender);
57 
58 protected:
59  EthernetTransport(const ndn::net::NetworkInterface& localEndpoint,
60  const ethernet::Address& remoteEndpoint);
61 
62  void
63  doClose() final;
64 
65  bool
67  {
68  return m_hasRecentlyReceived;
69  }
70 
71  void
73  {
74  m_hasRecentlyReceived = false;
75  }
76 
77 private:
78  void
79  handleNetifStateChange(ndn::net::InterfaceState netifState);
80 
81  void
82  doSend(const Block& packet) final;
83 
87  void
88  sendPacket(const ndn::Block& block);
89 
90  void
91  asyncRead();
92 
93  void
94  handleRead(const boost::system::error_code& error);
95 
96  void
97  handleError(const std::string& errorMessage);
98 
99 protected:
100  boost::asio::posix::stream_descriptor m_socket;
102  ethernet::Address m_srcAddress;
103  ethernet::Address m_destAddress;
104  std::string m_interfaceName;
105 
106 private:
107  signal::ScopedConnection m_netifStateChangedConn;
108  signal::ScopedConnection m_netifMtuChangedConn;
109  bool m_hasRecentlyReceived = false;
110 #ifndef NDEBUG
112  size_t m_nDropped = 0;
113 #endif
114 };
115 
116 } // namespace nfd::face
117 
118 #endif // NFD_DAEMON_FACE_ETHERNET_TRANSPORT_HPP
Base class for Ethernet-based Transports.
void receivePayload(span< const uint8_t > payload, const ethernet::Address &sender)
Processes the payload of an incoming frame.
void doClose() final
Performs Transport specific operations to close the transport.
boost::asio::posix::stream_descriptor m_socket
EthernetTransport(const ndn::net::NetworkInterface &localEndpoint, const ethernet::Address &remoteEndpoint)
Helper class for dealing with libpcap handles.
Definition: pcap-helper.hpp:45
The lower half of a Face.
Definition: transport.hpp:123