NS-3 based Named Data Networking (NDN) simulator
ndnSIM 2.5: NDN, CCN, CCNx, content centric networks
API Documentation
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-2021, 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_CHANNEL_HPP
27 #define NFD_DAEMON_FACE_CHANNEL_HPP
28 
29 #include "channel-log.hpp"
30 #include "face-common.hpp"
31 
32 namespace nfd {
33 namespace face {
34 
41 class Channel : public std::enable_shared_from_this<Channel>, noncopyable
42 {
43 public:
44  virtual
45  ~Channel();
46 
47  const FaceUri&
48  getUri() const
49  {
50  return m_uri;
51  }
52 
55  size_t
56  getDefaultMtu() const
57  {
58  return m_defaultMtu;
59  }
60 
63  virtual bool
64  isListening() const = 0;
65 
68  virtual size_t
69  size() const = 0;
70 
71 protected:
72  void
73  setUri(const FaceUri& uri);
74 
75  void
76  setDefaultMtu(size_t mtu);
77 
78 private:
79  FaceUri m_uri;
80  size_t m_defaultMtu = ndn::MAX_NDN_PACKET_SIZE;
81 };
82 
86 using FaceCreatedCallback = std::function<void(const shared_ptr<Face>&)>;
87 
90 using FaceCreationFailedCallback = std::function<void(uint32_t status, const std::string& reason)>;
91 
99 void
100 connectFaceClosedSignal(Face& face, std::function<void()> f);
101 
102 } // namespace face
103 } // namespace nfd
104 
105 #endif // NFD_DAEMON_FACE_CHANNEL_HPP
void setUri(const FaceUri &uri)
Definition: channel.cpp:35
Represents a channel that listens on a local endpoint.
Definition: channel.hpp:41
virtual size_t size() const =0
Returns the number of faces in the channel.
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:90
size_t getDefaultMtu() const
Returns the default MTU for all faces created by this channel.
Definition: channel.hpp:56
virtual bool isListening() const =0
Returns whether the channel is listening.
void connectFaceClosedSignal(Face &face, std::function< void()> f)
Invokes a callback when a face is closed.
Definition: channel.cpp:47
ndn Face
Definition: face-impl.hpp:42
Copyright (c) 2011-2015 Regents of the University of California.
Definition: ndn-common.hpp:39
const FaceUri & getUri() const
Definition: channel.hpp:48
represents the underlying protocol and address used by a Face
Definition: face-uri.hpp:44
void setDefaultMtu(size_t mtu)
Definition: channel.cpp:41
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:86
const size_t MAX_NDN_PACKET_SIZE
Practical size limit of a network-layer packet.
Definition: tlv.hpp:41