null-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-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_NULL_TRANSPORT_HPP
27 #define NFD_DAEMON_FACE_NULL_TRANSPORT_HPP
28 
29 #include "transport.hpp"
30 
31 namespace nfd::face {
32 
36 {
37 public:
38  explicit
39  NullTransport(const FaceUri& localUri = FaceUri("null://"),
40  const FaceUri& remoteUri = FaceUri("null://"),
41  ndn::nfd::FaceScope scope = ndn::nfd::FACE_SCOPE_NON_LOCAL,
42  ndn::nfd::FacePersistency persistency = ndn::nfd::FACE_PERSISTENCY_PERMANENT);
43 
44 protected:
45  void
47  {
49  }
50 
51 private:
52  void
53  doSend(const Block&) NFD_OVERRIDE_WITH_TESTS_ELSE_FINAL
54  {
55  }
56 };
57 
58 } // namespace nfd::face
59 
60 #endif // NFD_DAEMON_FACE_NULL_TRANSPORT_HPP
A Transport that drops every packet.
void doClose() final
Performs Transport specific operations to close the transport.
NullTransport(const FaceUri &localUri=FaceUri("null://"), const FaceUri &remoteUri=FaceUri("null://"), ndn::nfd::FaceScope scope=ndn::nfd::FACE_SCOPE_NON_LOCAL, ndn::nfd::FacePersistency persistency=ndn::nfd::FACE_PERSISTENCY_PERMANENT)
The lower half of a Face.
Definition: transport.hpp:123
void setState(TransportState newState)
Set transport state.
Definition: transport.cpp:175
#define NFD_OVERRIDE_WITH_TESTS_ELSE_FINAL
Definition: common.hpp:43
#define NFD_FINAL_UNLESS_WITH_TESTS
Definition: common.hpp:44
@ CLOSED
the transport is closed, and can be safely deallocated