unix-stream-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_UNIX_STREAM_CHANNEL_HPP
27 #define NFD_DAEMON_FACE_UNIX_STREAM_CHANNEL_HPP
28 
29 #include "channel.hpp"
30 
31 #include <boost/asio/local/stream_protocol.hpp>
32 
33 namespace nfd::unix_stream {
34 using Endpoint = boost::asio::local::stream_protocol::endpoint;
35 } // namespace nfd::unix_stream
36 
37 namespace nfd::face {
38 
45 class UnixStreamChannel final : public Channel
46 {
47 public:
54  UnixStreamChannel(const unix_stream::Endpoint& endpoint, bool wantCongestionMarking);
55 
56  ~UnixStreamChannel() final;
57 
58  bool
59  isListening() const final
60  {
61  return m_isListening;
62  }
63 
64  size_t
65  size() const final
66  {
67  return m_size;
68  }
69 
85  void
86  listen(const FaceCreatedCallback& onFaceCreated,
87  const FaceCreationFailedCallback& onAcceptFailed,
88  int backlog = boost::asio::socket_base::max_listen_connections);
89 
90 private:
91  void
92  accept(const FaceCreatedCallback& onFaceCreated,
93  const FaceCreationFailedCallback& onAcceptFailed);
94 
95 private:
96  const unix_stream::Endpoint m_endpoint;
97  const bool m_wantCongestionMarking;
98  bool m_isListening = false;
99  boost::asio::local::stream_protocol::acceptor m_acceptor;
100  size_t m_size = 0;
101 };
102 
103 } // namespace nfd::face
104 
105 #endif // NFD_DAEMON_FACE_UNIX_STREAM_CHANNEL_HPP
Represents a channel that listens on a local endpoint.
Definition: channel.hpp:43
Class implementing a local channel to create faces.
size_t size() const final
Returns the number of faces in the channel.
bool isListening() const final
Returns whether the channel is listening.
UnixStreamChannel(const unix_stream::Endpoint &endpoint, bool wantCongestionMarking)
Create a UnixStream channel for the specified endpoint.
void listen(const FaceCreatedCallback &onFaceCreated, const FaceCreationFailedCallback &onAcceptFailed, int backlog=boost::asio::socket_base::max_listen_connections)
Start listening.
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
boost::asio::local::stream_protocol::endpoint Endpoint