NS-3 based Named Data Networking (NDN) simulator
ndnSIM 2.5: NDN, CCN, CCNx, content centric networks
API Documentation
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-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_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"
33 
34 namespace nfd {
35 namespace face {
36 
41 {
42 public:
43  class Error : public std::runtime_error
44  {
45  public:
46  explicit
47  Error(const std::string& what)
48  : std::runtime_error(what)
49  {
50  }
51  };
52 
59  void
60  receivePayload(const uint8_t* payload, size_t length,
61  const ethernet::Address& sender);
62 
63 protected:
64  EthernetTransport(const ndn::net::NetworkInterface& localEndpoint,
65  const ethernet::Address& remoteEndpoint);
66 
67  void
68  doClose() final;
69 
70  bool
72  {
73  return m_hasRecentlyReceived;
74  }
75 
76  void
78  {
79  m_hasRecentlyReceived = false;
80  }
81 
82 private:
83  void
84  handleNetifStateChange(ndn::net::InterfaceState netifState);
85 
86  void
87  doSend(Transport::Packet&& packet) final;
88 
92  void
93  sendPacket(const ndn::Block& block);
94 
95  void
96  asyncRead();
97 
98  void
99  handleRead(const boost::system::error_code& error);
100 
101  void
102  handleError(const std::string& errorMessage);
103 
104 protected:
105  boost::asio::posix::stream_descriptor m_socket;
109  std::string m_interfaceName;
110 
111 private:
112  signal::ScopedConnection m_netifStateConn;
113  bool m_hasRecentlyReceived;
114 #ifdef _DEBUG
115  size_t m_nDropped;
117 #endif
118 };
119 
120 } // namespace face
121 } // namespace nfd
122 
123 #endif // NFD_DAEMON_FACE_ETHERNET_TRANSPORT_HPP
Helper class for dealing with libpcap handles.
Definition: pcap-helper.hpp:45
stores a packet along with the remote endpoint
Definition: transport.hpp:122
EthernetTransport(const ndn::net::NetworkInterface &localEndpoint, const ethernet::Address &remoteEndpoint)
InterfaceState
Indicates the state of a network interface.
Represents a TLV element of NDN packet format.
Definition: block.hpp:42
void receivePayload(const uint8_t *payload, size_t length, const ethernet::Address &sender)
Processes the payload of an incoming frame.
void doClose() final
performs Transport specific operations to close the transport
Represents one network interface attached to the host.
Copyright (c) 2011-2015 Regents of the University of California.
Definition: ndn-common.hpp:40
Disconnects a Connection automatically upon destruction.
boost::asio::posix::stream_descriptor m_socket
represents an Ethernet hardware address
Definition: ethernet.hpp:52
Base class for Ethernet-based Transports.
the lower part of a Face
Definition: transport.hpp:113