ethernet-channel.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_CHANNEL_HPP
27 #define NFD_DAEMON_FACE_ETHERNET_CHANNEL_HPP
28 
29 #include "channel.hpp"
30 #include "ethernet-protocol.hpp"
31 #include "pcap-helper.hpp"
32 #include <ndn-cxx/net/network-interface.hpp>
33 
34 namespace nfd {
35 namespace face {
36 
40 class EthernetChannel : public Channel
41 {
42 public:
46  class Error : public std::runtime_error
47  {
48  public:
49  explicit
50  Error(const std::string& what)
51  : std::runtime_error(what)
52  {
53  }
54  };
55 
62  EthernetChannel(shared_ptr<const ndn::net::NetworkInterface> localEndpoint,
63  time::nanoseconds idleTimeout);
64 
65  bool
66  isListening() const override
67  {
68  return m_isListening;
69  }
70 
71  size_t
72  size() const override
73  {
74  return m_channelFaces.size();
75  }
76 
80  void
81  connect(const ethernet::Address& remoteEndpoint,
82  const FaceParams& params,
83  const FaceCreatedCallback& onFaceCreated,
84  const FaceCreationFailedCallback& onConnectFailed);
85 
98  void
99  listen(const FaceCreatedCallback& onFaceCreated,
100  const FaceCreationFailedCallback& onFaceCreationFailed);
101 
102 private:
103  void
104  asyncRead(const FaceCreatedCallback& onFaceCreated,
105  const FaceCreationFailedCallback& onReceiveFailed);
106 
107  void
108  handleRead(const boost::system::error_code& error,
109  const FaceCreatedCallback& onFaceCreated,
110  const FaceCreationFailedCallback& onReceiveFailed);
111 
112  void
113  processIncomingPacket(const uint8_t* packet, size_t length,
114  const ethernet::Address& sender,
115  const FaceCreatedCallback& onFaceCreated,
116  const FaceCreationFailedCallback& onReceiveFailed);
117 
118  std::pair<bool, shared_ptr<Face>>
119  createFace(const ethernet::Address& remoteEndpoint,
120  const FaceParams& params);
121 
122  void
123  updateFilter();
124 
125 private:
126  shared_ptr<const ndn::net::NetworkInterface> m_localEndpoint;
127  bool m_isListening;
128  boost::asio::posix::stream_descriptor m_socket;
129  PcapHelper m_pcap;
130  std::map<ethernet::Address, shared_ptr<Face>> m_channelFaces;
131  const time::nanoseconds m_idleFaceTimeout;
132 
133 #ifdef _DEBUG
134  size_t m_nDropped;
136 #endif
137 };
138 
139 } // namespace face
140 } // namespace nfd
141 
142 #endif // NFD_DAEMON_FACE_ETHERNET_CHANNEL_HPP
void listen(const FaceCreatedCallback &onFaceCreated, const FaceCreationFailedCallback &onFaceCreationFailed)
Start listening.
STL namespace.
std::function< void(uint32_t status, const std::string &reason)> FaceCreationFailedCallback
Prototype for the callback that is invoked when a face fails to be created.
Definition: channel.hpp:78
size_t size() const override
Returns the number of faces in the channel.
Parameters used to set Transport properties or LinkService options on a newly created face...
Definition: face-common.hpp:78
EthernetChannel-related error.
Class implementing Ethernet-based channel to create faces.
Copyright (c) 2014-2015, Regents of the University of California, Arizona Board of Regents...
Definition: algorithm.hpp:32
EthernetChannel(shared_ptr< const ndn::net::NetworkInterface > localEndpoint, time::nanoseconds idleTimeout)
Create an Ethernet channel on the given localEndpoint (network interface)
Error(const std::string &what)
Represents a channel that listens on a local endpoint.
Definition: channel.hpp:41
void connect(const ethernet::Address &remoteEndpoint, const FaceParams &params, const FaceCreatedCallback &onFaceCreated, const FaceCreationFailedCallback &onConnectFailed)
Create a unicast Ethernet face toward remoteEndpoint.
std::function< void(const shared_ptr< Face > &)> FaceCreatedCallback
Prototype for the callback that is invoked when a face is created (in response to an incoming connect...
Definition: channel.hpp:74
bool isListening() const override
Returns whether the channel is listening.
Helper class for dealing with libpcap handles.
Definition: pcap-helper.hpp:45