NS-3 based Named Data Networking (NDN) simulator
ndnSIM 2.5: NDN, CCN, CCNx, content centric networks
API Documentation
pcap-helper.hpp
Go to the documentation of this file.
1 /* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
2 /*
3  * Copyright (c) 2014-2022, 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_PCAP_HELPER_HPP
27 #define NFD_DAEMON_FACE_PCAP_HELPER_HPP
28 
29 #include "core/common.hpp"
30 
31 #ifndef NFD_HAVE_LIBPCAP
32 #error "Cannot include this file when libpcap is not available"
33 #endif
34 
35 // forward declarations
36 struct pcap;
37 typedef pcap pcap_t;
38 
39 namespace nfd {
40 namespace face {
41 
45 class PcapHelper : noncopyable
46 {
47 public:
48  class Error : public std::runtime_error
49  {
50  public:
51  explicit
52  Error(const std::string& what)
53  : std::runtime_error(what)
54  {
55  }
56  };
57 
63  explicit
64  PcapHelper(const std::string& interfaceName);
65 
66  ~PcapHelper();
67 
74  void
75  activate(int dlt);
76 
81  void
82  close() noexcept;
83 
91  int
92  getFd() const;
93 
100  std::string
101  getLastError() const noexcept;
102 
108  size_t
109  getNDropped() const;
110 
118  void
119  setPacketFilter(const char* filter) const;
120 
130  std::tuple<span<const uint8_t>, std::string>
131  readNextPacket() const noexcept;
132 
133  operator pcap_t*() const noexcept
134  {
135  return m_pcap;
136  }
137 
138 private:
139  pcap_t* m_pcap;
140 };
141 
142 } // namespace face
143 } // namespace nfd
144 
145 #endif // NFD_DAEMON_FACE_PCAP_HELPER_HPP
void activate(int dlt)
Start capturing packets.
Definition: pcap-helper.cpp:66
Helper class for dealing with libpcap handles.
Definition: pcap-helper.hpp:45
STL namespace.
void setPacketFilter(const char *filter) const
Install a BPF filter on the receiving socket.
Copyright (c) 2011-2015 Regents of the University of California.
Definition: ndn-common.hpp:39
void close() noexcept
Stop capturing and close the handle.
Definition: pcap-helper.cpp:82
std::string getLastError() const noexcept
Get last error message.
pcap pcap_t
Definition: pcap-helper.hpp:36
Error(const std::string &what)
Definition: pcap-helper.hpp:52
PcapHelper(const std::string &interfaceName)
Create a libpcap context for live packet capture on a network interface.
Definition: pcap-helper.cpp:41
int getFd() const
Obtain a file descriptor that can be used in calls such as select(2) and poll(2). ...
Definition: pcap-helper.cpp:91
size_t getNDropped() const
Get the number of packets dropped by the kernel, as reported by libpcap.
std::tuple< span< const uint8_t >, std::string > readNextPacket() const noexcept
Read the next packet captured on the interface.