NS-3 based Named Data Networking (NDN) simulator
ndnSIM 2.5: NDN, CCN, CCNx, content centric networks
API Documentation
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-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_NULL_TRANSPORT_HPP
27 #define NFD_DAEMON_FACE_NULL_TRANSPORT_HPP
28 
29 #include "transport.hpp"
30 
31 namespace nfd {
32 namespace face {
33 
37 {
38 public:
39  explicit
40  NullTransport(const FaceUri& localUri = FaceUri("null://"),
41  const FaceUri& remoteUri = FaceUri("null://"),
44 
45 protected:
46  void
48  {
50  }
51 
52 private:
53  void
54  doSend(const Block&, const EndpointId&) OVERRIDE_WITH_TESTS_ELSE_FINAL
55  {
56  }
57 };
58 
59 } // namespace face
60 } // namespace nfd
61 
62 #endif // NFD_DAEMON_FACE_NULL_TRANSPORT_HPP
nfd::face::TransportState::CLOSED
@ CLOSED
the transport is closed, and can be safely deallocated
ndn::nfd::FACE_SCOPE_NON_LOCAL
@ FACE_SCOPE_NON_LOCAL
face is non-local
Definition: nfd-constants.hpp:36
ndn::FaceUri
represents the underlying protocol and address used by a Face
Definition: face-uri.hpp:45
ndn::nfd::FACE_PERSISTENCY_PERMANENT
@ FACE_PERSISTENCY_PERMANENT
face is permanent
Definition: nfd-constants.hpp:49
nfd::face::NullTransport
A Transport that drops every packet.
Definition: null-transport.hpp:37
nfd::face::Transport::setState
void setState(TransportState newState)
set transport state
Definition: transport.cpp:173
transport.hpp
ndn::nfd::FacePersistency
FacePersistency
Definition: nfd-constants.hpp:45
nfd::face::NullTransport::NullTransport
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)
Definition: null-transport.cpp:33
nfd
Copyright (c) 2011-2015 Regents of the University of California.
Definition: ndn-common.hpp:40
OVERRIDE_WITH_TESTS_ELSE_FINAL
#define OVERRIDE_WITH_TESTS_ELSE_FINAL
Definition: common.hpp:43
ndn::Block
Represents a TLV element of NDN packet format.
Definition: block.hpp:43
nfd::face::EndpointId
uint64_t EndpointId
Identifies a remote endpoint on the link.
Definition: face-common.hpp:65
ndn::nfd::FaceScope
FaceScope
Definition: nfd-constants.hpp:34
nfd::face::Transport
The lower half of a Face.
Definition: transport.hpp:109
nfd::face::NullTransport::doClose
void doClose() OVERRIDE_WITH_TESTS_ELSE_FINAL
performs Transport specific operations to close the transport
Definition: null-transport.hpp:47
FINAL_UNLESS_WITH_TESTS
#define FINAL_UNLESS_WITH_TESTS
Definition: common.hpp:44