NS-3 based Named Data Networking (NDN) simulator
ndnSIM 2.5: NDN, CCN, CCNx, content centric networks
API Documentation
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-2018, 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 namespace nfd {
32 
33 namespace unix_stream {
34 typedef boost::asio::local::stream_protocol::endpoint Endpoint;
35 } // namespace unix_stream
36 
37 namespace face {
38 
45 class UnixStreamChannel : public Channel
46 {
47 public:
51  class Error : public std::runtime_error
52  {
53  public:
54  explicit
55  Error(const std::string& what)
56  : std::runtime_error(what)
57  {
58  }
59  };
60 
67  UnixStreamChannel(const unix_stream::Endpoint& endpoint, bool wantCongestionMarking);
68 
69  ~UnixStreamChannel() override;
70 
71  bool
72  isListening() const override
73  {
74  return m_acceptor.is_open();
75  }
76 
77  size_t
78  size() const override
79  {
80  return m_size;
81  }
82 
98  void
99  listen(const FaceCreatedCallback& onFaceCreated,
100  const FaceCreationFailedCallback& onAcceptFailed,
101  int backlog = boost::asio::local::stream_protocol::acceptor::max_connections);
102 
103 private:
104  void
105  accept(const FaceCreatedCallback& onFaceCreated,
106  const FaceCreationFailedCallback& onAcceptFailed);
107 
108  void
109  handleAccept(const boost::system::error_code& error,
110  const FaceCreatedCallback& onFaceCreated,
111  const FaceCreationFailedCallback& onAcceptFailed);
112 
113 private:
114  const unix_stream::Endpoint m_endpoint;
115  boost::asio::local::stream_protocol::acceptor m_acceptor;
116  boost::asio::local::stream_protocol::socket m_socket;
117  size_t m_size;
118  bool m_wantCongestionMarking;
119 };
120 
121 } // namespace face
122 } // namespace nfd
123 
124 #endif // NFD_DAEMON_FACE_UNIX_STREAM_CHANNEL_HPP
represent a channel that communicates on a local endpoint
Definition: channel.hpp:52
size_t size() const override
Returns the number of faces in the channel.
function< void(const shared_ptr< Face > &face)> FaceCreatedCallback
Prototype for the callback that is invoked when a face is created (in response to an incoming connect...
Definition: channel.hpp:40
STL namespace.
UnixStreamChannel-related error.
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:44
Copyright (c) 2011-2015 Regents of the University of California.
Definition: ndn-common.hpp:40
Class implementing a local channel to create faces.
bool isListening() const override
Returns whether the channel is listening.
void listen(const FaceCreatedCallback &onFaceCreated, const FaceCreationFailedCallback &onAcceptFailed, int backlog=boost::asio::local::stream_protocol::acceptor::max_connections)
Start listening.
UnixStreamChannel(const unix_stream::Endpoint &endpoint, bool wantCongestionMarking)
Create UnixStream channel for the specified endpoint.
boost::asio::local::stream_protocol::endpoint Endpoint