NS-3 based Named Data Networking (NDN) simulator
ndnSIM 2.5: NDN, CCN, CCNx, content centric networks
API Documentation
tcp-factory.hpp
Go to the documentation of this file.
1 /* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
2 /*
3  * Copyright (c) 2014-2021, 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_TCP_FACTORY_HPP
27 #define NFD_DAEMON_FACE_TCP_FACTORY_HPP
28 
29 #include "protocol-factory.hpp"
30 #include "tcp-channel.hpp"
31 
32 namespace nfd {
33 namespace face {
34 
37 class TcpFactory final : public ProtocolFactory
38 {
39 public:
40  static const std::string&
41  getId() noexcept;
42 
44 
56  shared_ptr<TcpChannel>
57  createChannel(const tcp::Endpoint& localEndpoint);
58 
59 private:
62  void
63  doProcessConfig(OptionalConfigSection configSection,
64  FaceSystem::ConfigContext& context) final;
65 
66  void
67  doCreateFace(const CreateFaceRequest& req,
68  const FaceCreatedCallback& onCreated,
69  const FaceCreationFailedCallback& onFailure) final;
70 
71  std::vector<shared_ptr<const Channel>>
72  doGetChannels() const final;
73 
75  determineFaceScopeFromAddresses(const boost::asio::ip::address& local,
76  const boost::asio::ip::address& remote) const;
77 
78 private:
79  bool m_wantCongestionMarking = false;
80  std::map<tcp::Endpoint, shared_ptr<TcpChannel>> m_channels;
81 
83  IpAddressPredicate m_local;
84 };
85 
86 } // namespace face
87 } // namespace nfd
88 
89 #endif // NFD_DAEMON_FACE_TCP_FACTORY_HPP
ProtocolFactory(const CtorParams &params)
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:90
boost::optional< const ConfigSection & > OptionalConfigSection
an optional config file section
Definition: config-file.hpp:41
Provides support for an underlying protocol.
Protocol factory for TCP over IPv4 and IPv6.
Definition: tcp-factory.hpp:37
Copyright (c) 2011-2015 Regents of the University of California.
Definition: ndn-common.hpp:39
#define NFD_PUBLIC_WITH_TESTS_ELSE_PRIVATE
Definition: common.hpp:41
boost::asio::ip::tcp::endpoint Endpoint
Definition: tcp-channel.hpp:34
context for processing a config section in ProtocolFactory
Definition: face-system.hpp:96
Represents a predicate to accept or reject an IP address.
Encapsulates a face creation request and all its parameters.
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:86
shared_ptr< TcpChannel > createChannel(const tcp::Endpoint &localEndpoint)
Create TCP-based channel using tcp::Endpoint.
static const std::string & getId() noexcept
Definition: tcp-factory.cpp:37