Loading...
Searching...
No Matches
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
36struct pcap;
37typedef pcap pcap_t;
38
39namespace nfd::face {
40
44class PcapHelper : noncopyable
45{
46public:
47 class Error : public std::runtime_error
48 {
49 public:
50 using std::runtime_error::runtime_error;
51 };
52
58 explicit
59 PcapHelper(const std::string& interfaceName);
60
61 ~PcapHelper() noexcept;
62
69 void
70 activate(int dlt);
71
76 void
77 close() noexcept;
78
86 int
87 getFd() const;
88
95 std::string
96 getLastError() const noexcept;
97
103 size_t
104 getNDropped() const;
105
113 void
114 setPacketFilter(const char* filter) const;
115
125 std::tuple<span<const uint8_t>, std::string>
126 readNextPacket() const noexcept;
127
128 operator pcap_t*() const noexcept
129 {
130 return m_pcap;
131 }
132
133private:
134 pcap_t* m_pcap = nullptr;
135};
136
137} // namespace nfd::face
138
139#endif // NFD_DAEMON_FACE_PCAP_HELPER_HPP
Helper class for dealing with libpcap handles.
int getFd() const
Obtain a file descriptor that can be used in calls such as select(2) and poll(2).
std::string getLastError() const noexcept
Get last error message.
void activate(int dlt)
Start capturing packets.
size_t getNDropped() const
Get the number of packets dropped by the kernel, as reported by libpcap.
void setPacketFilter(const char *filter) const
Install a BPF filter on the receiving socket.
std::tuple< span< const uint8_t >, std::string > readNextPacket() const noexcept
Read the next packet captured on the interface.
void close() noexcept
Stop capturing and close the handle.
pcap pcap_t