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-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_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 : noncopyable
42 {
43 public:
44  virtual
45  ~Channel();
46 
47  const FaceUri&
48  getUri() const
49  {
50  return m_uri;
51  }
52 
55  virtual bool
56  isListening() const = 0;
57 
60  virtual size_t
61  size() const = 0;
62 
63 protected:
64  void
65  setUri(const FaceUri& uri);
66 
67 private:
68  FaceUri m_uri;
69 };
70 
74 using FaceCreatedCallback = std::function<void(const shared_ptr<Face>&)>;
75 
78 using FaceCreationFailedCallback = std::function<void(uint32_t status, const std::string& reason)>;
79 
87 void
88 connectFaceClosedSignal(Face& face, std::function<void()> f);
89 
90 } // namespace face
91 } // namespace nfd
92 
93 #endif // NFD_DAEMON_FACE_CHANNEL_HPP
const FaceUri & getUri() const
Definition: channel.hpp:48
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:78
void connectFaceClosedSignal(Face &face, std::function< void()> f)
Invokes a callback when a face is closed.
Definition: channel.cpp:41
Copyright (c) 2014-2015, Regents of the University of California, Arizona Board of Regents...
Definition: algorithm.hpp:32
generalization of a network interface
Definition: face.hpp:52
virtual bool isListening() const =0
Returns whether the channel is listening.
void setUri(const FaceUri &uri)
Definition: channel.cpp:35
Represents a channel that listens on a local endpoint.
Definition: channel.hpp: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:74
virtual size_t size() const =0
Returns the number of faces in the channel.