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-2019, 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 
34 
35 namespace nfd {
36 namespace face {
37 
42 {
43 public:
44  class Error : public std::runtime_error
45  {
46  public:
47  using std::runtime_error::runtime_error;
48  };
49 
56  void
57  receivePayload(const uint8_t* payload, size_t length,
58  const ethernet::Address& sender);
59 
60 protected:
61  EthernetTransport(const ndn::net::NetworkInterface& localEndpoint,
62  const ethernet::Address& remoteEndpoint);
63 
64  void
65  doClose() final;
66 
67  bool
69  {
70  return m_hasRecentlyReceived;
71  }
72 
73  void
75  {
76  m_hasRecentlyReceived = false;
77  }
78 
79 private:
80  void
81  handleNetifStateChange(ndn::net::InterfaceState netifState);
82 
83  void
84  doSend(const Block& packet, const EndpointId& endpoint) final;
85 
89  void
90  sendPacket(const ndn::Block& block);
91 
92  void
93  asyncRead();
94 
95  void
96  handleRead(const boost::system::error_code& error);
97 
98  void
99  handleError(const std::string& errorMessage);
100 
101 protected:
102  boost::asio::posix::stream_descriptor m_socket;
106  std::string m_interfaceName;
107 
108 private:
109  signal::ScopedConnection m_netifStateConn;
110  bool m_hasRecentlyReceived;
111 #ifdef _DEBUG
112  size_t m_nDropped;
114 #endif
115 };
116 
117 } // namespace face
118 } // namespace nfd
119 
120 #endif // NFD_DAEMON_FACE_ETHERNET_TRANSPORT_HPP
nfd::face::EthernetTransport::receivePayload
void receivePayload(const uint8_t *payload, size_t length, const ethernet::Address &sender)
Processes the payload of an incoming frame.
Definition: ethernet-transport.cpp:197
nfd::face::EthernetTransport::m_socket
boost::asio::posix::stream_descriptor m_socket
Definition: ethernet-transport.hpp:102
ndn::util::signal::ScopedConnection
Disconnects a Connection automatically upon destruction.
Definition: scoped-connection.hpp:34
nfd::face::EthernetTransport::m_destAddress
ethernet::Address m_destAddress
Definition: ethernet-transport.hpp:105
ndn::net::NetworkInterface
Represents one network interface attached to the host.
Definition: network-interface.hpp:70
ndn::ethernet::Address
represents an Ethernet hardware address
Definition: ethernet.hpp:53
ethernet-protocol.hpp
nfd::face::EthernetTransport::m_pcap
PcapHelper m_pcap
Definition: ethernet-transport.hpp:103
nfd::face::EthernetTransport::m_srcAddress
ethernet::Address m_srcAddress
Definition: ethernet-transport.hpp:104
nfd::face::PcapHelper
Helper class for dealing with libpcap handles.
Definition: pcap-helper.hpp:46
nfd::face::EthernetTransport::EthernetTransport
EthernetTransport(const ndn::net::NetworkInterface &localEndpoint, const ethernet::Address &remoteEndpoint)
Definition: ethernet-transport.cpp:41
transport.hpp
nfd::face::EthernetTransport::hasRecentlyReceived
bool hasRecentlyReceived() const
Definition: ethernet-transport.hpp:68
nfd::face::EthernetTransport::resetRecentlyReceived
void resetRecentlyReceived()
Definition: ethernet-transport.hpp:74
nfd
Copyright (c) 2011-2015 Regents of the University of California.
Definition: ndn-common.hpp:40
nfd::face::EthernetTransport::Error
Definition: ethernet-transport.hpp:45
pcap-helper.hpp
ndn::net::InterfaceState
InterfaceState
Indicates the state of a network interface.
Definition: network-interface.hpp:50
nfd::face::EthernetTransport
Base class for Ethernet-based Transports.
Definition: ethernet-transport.hpp:42
ndn::Block
Represents a TLV element of NDN packet format.
Definition: block.hpp:43
nfd::face::EthernetTransport::m_interfaceName
std::string m_interfaceName
Definition: ethernet-transport.hpp:106
network-interface.hpp
nfd::face::EndpointId
uint64_t EndpointId
Identifies a remote endpoint on the link.
Definition: face-common.hpp:65
nfd::face::Transport
The lower half of a Face.
Definition: transport.hpp:109
nfd::face::EthernetTransport::doClose
void doClose() final
performs Transport specific operations to close the transport
Definition: ethernet-transport.cpp:70