blob: 1a5ed908c8c84f35a447ad57a02ad155c806081d [file] [log] [blame]
Junxiao Shi61e3cc52014-03-03 20:40:28 -07001/* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
Davide Pesavento15b55052018-01-27 19:09:28 -05002/*
3 * Copyright (c) 2014-2018, Regents of the University of California,
Davide Pesavento47ab0292015-11-02 18:45:39 +01004 * 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.
Alexander Afanasyev9bcbc7c2014-04-06 19:37:37 -070010 *
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/>.
Davide Pesavento47ab0292015-11-02 18:45:39 +010024 */
Junxiao Shi61e3cc52014-03-03 20:40:28 -070025
Alexander Afanasyev613e2a92014-04-15 13:36:58 -070026#ifndef NFD_DAEMON_FACE_CHANNEL_HPP
27#define NFD_DAEMON_FACE_CHANNEL_HPP
Junxiao Shi61e3cc52014-03-03 20:40:28 -070028
Davide Pesavento77911cc2017-04-08 22:12:30 -040029#include "channel-log.hpp"
Junxiao Shicde37ad2015-12-24 01:02:05 -070030#include "face.hpp"
Junxiao Shi61e3cc52014-03-03 20:40:28 -070031
32namespace nfd {
Davide Pesavento8fd15e62017-04-06 19:58:54 -040033namespace face {
Junxiao Shi61e3cc52014-03-03 20:40:28 -070034
Davide Pesaventoc19408d2017-04-08 00:42:55 -040035/** \brief Prototype for the callback that is invoked when a face is created
36 * (in response to an incoming connection or after a connection is established)
Davide Pesavento47ab0292015-11-02 18:45:39 +010037 */
Davide Pesavento15b55052018-01-27 19:09:28 -050038using FaceCreatedCallback = function<void(const shared_ptr<Face>& face)>;
Davide Pesavento47ab0292015-11-02 18:45:39 +010039
Davide Pesaventoc19408d2017-04-08 00:42:55 -040040/** \brief Prototype for the callback that is invoked when a face fails to be created
Davide Pesavento47ab0292015-11-02 18:45:39 +010041 */
Davide Pesavento15b55052018-01-27 19:09:28 -050042using FaceCreationFailedCallback = function<void(uint32_t status, const std::string& reason)>;
Davide Pesavento47ab0292015-11-02 18:45:39 +010043
Junxiao Shi38b24c72017-01-05 02:59:31 +000044/** \brief represent a channel that communicates on a local endpoint
45 * \sa FaceSystem
46 *
47 * A channel can listen on a local endpoint and initiate outgoing connection from a local endpoint.
48 * A channel creates Face objects and retains shared ownership of them.
49 */
Junxiao Shi61e3cc52014-03-03 20:40:28 -070050class Channel : noncopyable
51{
52public:
Junxiao Shi61e3cc52014-03-03 20:40:28 -070053 virtual
54 ~Channel();
55
56 const FaceUri&
Davide Pesaventoc19408d2017-04-08 00:42:55 -040057 getUri() const
58 {
59 return m_uri;
60 }
61
62 /** \brief Returns whether the channel is listening
63 */
64 virtual bool
65 isListening() const = 0;
66
67 /** \brief Returns the number of faces in the channel
68 */
69 virtual size_t
70 size() const = 0;
Junxiao Shi61e3cc52014-03-03 20:40:28 -070071
72protected:
73 void
74 setUri(const FaceUri& uri);
75
76private:
77 FaceUri m_uri;
78};
79
Davide Pesavento15b55052018-01-27 19:09:28 -050080/** \brief Parameters used to set Transport properties or LinkService options on a newly created face
81 *
82 * Parameters are passed as a struct rather than individually, so that a future change in the list
83 * of parameters does not require an update to the method signature in all subclasses.
84 */
85class FaceParams
86{
87public:
88 // get rid of this constructor and use aggregate init + NSDMIs when we switch to C++14
89 FaceParams() noexcept
90 : persistency(ndn::nfd::FACE_PERSISTENCY_PERSISTENT)
91 , wantLocalFields(false)
92 , wantLpReliability(false)
93 {
94 }
95
96public:
97 ndn::nfd::FacePersistency persistency;
98 bool wantLocalFields;
99 bool wantLpReliability;
100};
101
Junxiao Shicde37ad2015-12-24 01:02:05 -0700102/** \brief invokes a callback when the face is closed
103 * \param face the face
104 * \param f the callback to be invoked when the face enters CLOSED state
105 *
106 * This function connects a callback to the afterStateChange signal on the \p face,
107 * and invokes \p f when the state becomes CLOSED.
108 */
109void
110connectFaceClosedSignal(Face& face, const std::function<void()>& f);
111
Davide Pesavento8fd15e62017-04-06 19:58:54 -0400112} // namespace face
Junxiao Shi61e3cc52014-03-03 20:40:28 -0700113} // namespace nfd
114
Alexander Afanasyev613e2a92014-04-15 13:36:58 -0700115#endif // NFD_DAEMON_FACE_CHANNEL_HPP