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-2024, 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 #include <functional>
33 
34 namespace nfd::face {
35 
42 class Channel : public std::enable_shared_from_this<Channel>, noncopyable
43 {
44 public:
45  virtual
47 
48  const FaceUri&
49  getUri() const noexcept
50  {
51  return m_uri;
52  }
53 
57  size_t
58  getDefaultMtu() const noexcept
59  {
60  return m_defaultMtu;
61  }
62 
66  virtual bool
67  isListening() const = 0;
68 
72  virtual size_t
73  size() const = 0;
74 
75 protected:
76  void
77  setUri(const FaceUri& uri) noexcept;
78 
79  void
80  setDefaultMtu(size_t mtu) noexcept;
81 
82 private:
83  FaceUri m_uri;
84  size_t m_defaultMtu = ndn::MAX_NDN_PACKET_SIZE;
85 };
86 
90 using FaceCreatedCallback = std::function<void(const shared_ptr<Face>&)>;
91 
94 using FaceCreationFailedCallback = std::function<void(uint32_t status, const std::string& reason)>;
95 
103 void
104 connectFaceClosedSignal(Face& face, std::function<void()> f);
105 
106 } // namespace nfd::face
107 
108 #endif // NFD_DAEMON_FACE_CHANNEL_HPP
Represents a channel that listens on a local endpoint.
Definition: channel.hpp:43
void setUri(const FaceUri &uri) noexcept
Definition: channel.cpp:34
size_t getDefaultMtu() const noexcept
Returns the default MTU for all faces created by this channel.
Definition: channel.hpp:58
virtual bool isListening() const =0
Returns whether the channel is listening.
virtual size_t size() const =0
Returns the number of faces in the channel.
const FaceUri & getUri() const noexcept
Definition: channel.hpp:49
void setDefaultMtu(size_t mtu) noexcept
Definition: channel.cpp:40
Generalization of a network interface.
Definition: face.hpp:118
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:94
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:90
void connectFaceClosedSignal(Face &face, std::function< void()> f)
Invokes a callback when a face is closed.
Definition: channel.cpp:46