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-2022, 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:
51  class Error : public std::runtime_error
52  {
53  public:
54  using std::runtime_error::runtime_error;
55  };
56 
63  UnixStreamChannel(const unix_stream::Endpoint& endpoint, bool wantCongestionMarking);
64 
65  ~UnixStreamChannel() final;
66 
67  bool
68  isListening() const final
69  {
70  return m_acceptor.is_open();
71  }
72 
73  size_t
74  size() const final
75  {
76  return m_size;
77  }
78 
94  void
95  listen(const FaceCreatedCallback& onFaceCreated,
96  const FaceCreationFailedCallback& onAcceptFailed,
97  int backlog = boost::asio::local::stream_protocol::acceptor::max_connections);
98 
99 private:
100  void
101  accept(const FaceCreatedCallback& onFaceCreated,
102  const FaceCreationFailedCallback& onAcceptFailed);
103 
104  void
105  handleAccept(const boost::system::error_code& error,
106  const FaceCreatedCallback& onFaceCreated,
107  const FaceCreationFailedCallback& onAcceptFailed);
108 
109 private:
110  const unix_stream::Endpoint m_endpoint;
111  boost::asio::local::stream_protocol::acceptor m_acceptor;
112  boost::asio::local::stream_protocol::socket m_socket;
113  size_t m_size;
114  bool m_wantCongestionMarking;
115 };
116 
117 } // namespace nfd::face
118 
119 #endif // NFD_DAEMON_FACE_UNIX_STREAM_CHANNEL_HPP
Represents a channel that listens on a local endpoint.
Definition: channel.hpp:41
UnixStreamChannel-related error.
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 UnixStream channel for the specified endpoint.
void listen(const FaceCreatedCallback &onFaceCreated, const FaceCreationFailedCallback &onAcceptFailed, int backlog=boost::asio::local::stream_protocol::acceptor::max_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:92
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:88
boost::asio::local::stream_protocol::endpoint Endpoint