blob: da2b14b625573a3c70292a3c1a54ab4a1e155d14 [file] [log] [blame]
Giulio Grassi624f6c62014-02-18 19:42:14 +01001/* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
2/**
Junxiao Shi5dd26c32014-07-20 23:15:14 -07003 * Copyright (c) 2014, 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
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/>.
Junxiao Shi5dd26c32014-07-20 23:15:14 -070024 */
Giulio Grassi624f6c62014-02-18 19:42:14 +010025
Alexander Afanasyev613e2a92014-04-15 13:36:58 -070026#ifndef NFD_DAEMON_FACE_UDP_CHANNEL_HPP
27#define NFD_DAEMON_FACE_UDP_CHANNEL_HPP
Giulio Grassi624f6c62014-02-18 19:42:14 +010028
Junxiao Shi61e3cc52014-03-03 20:40:28 -070029#include "channel.hpp"
Junxiao Shi61e3cc52014-03-03 20:40:28 -070030#include "core/global-io.hpp"
Giulio Grassi624f6c62014-02-18 19:42:14 +010031#include "udp-face.hpp"
32
33namespace nfd {
34
35namespace udp {
Junxiao Shi61e3cc52014-03-03 20:40:28 -070036typedef boost::asio::ip::udp::endpoint Endpoint;
Giulio Grassi624f6c62014-02-18 19:42:14 +010037} // namespace udp
38
39/**
40 * \brief Class implementing UDP-based channel to create faces
41 *
42 *
43 */
Junxiao Shi61e3cc52014-03-03 20:40:28 -070044class UdpChannel : public Channel
Giulio Grassi624f6c62014-02-18 19:42:14 +010045{
46public:
Giulio Grassi624f6c62014-02-18 19:42:14 +010047 /**
48 * \brief Exception of UdpChannel
49 */
50 struct Error : public std::runtime_error
51 {
52 Error(const std::string& what) : runtime_error(what) {}
53 };
Giulio Grassi624f6c62014-02-18 19:42:14 +010054
55 /**
56 * \brief Create UDP channel for the local endpoint
57 *
58 * To enable creation of faces upon incoming connections,
59 * one needs to explicitly call UdpChannel::listen method.
60 * The created socket is bound to the localEndpoint.
61 * reuse_address option is set
62 *
63 * \throw UdpChannel::Error if bind on the socket fails
64 */
65 UdpChannel(const udp::Endpoint& localEndpoint,
Alexander Afanasyeveb3197f2014-03-17 19:28:18 -070066 const time::seconds& timeout);
Giulio Grassi624f6c62014-02-18 19:42:14 +010067
68 /**
69 * \brief Enable listening on the local endpoint, accept connections,
70 * and create faces when remote host makes a connection
71 * \param onFaceCreated Callback to notify successful creation of the face
72 * \param onAcceptFailed Callback to notify when channel fails
73 *
Alexander Afanasyev5959b012014-06-02 19:18:12 +030074 * Once a face is created, if it doesn't send/receive anything for
75 * a period of time equal to timeout, it will be destroyed
76 * \todo this functionality has to be implemented
77 *
Giulio Grassi624f6c62014-02-18 19:42:14 +010078 * \throws UdpChannel::Error if called multiple times
79 */
80 void
81 listen(const FaceCreatedCallback& onFaceCreated,
82 const ConnectFailedCallback& onAcceptFailed);
83
84 /**
85 * \brief Create a face by establishing connection to remote endpoint
86 *
87 * \throw UdpChannel::Error if bind or connect on the socket fail
88 */
89 void
90 connect(const udp::Endpoint& remoteEndpoint,
Steve DiBenedettoca53ac62014-03-27 19:58:40 -060091 const FaceCreatedCallback& onFaceCreated,
92 const ConnectFailedCallback& onConnectFailed);
Giulio Grassi624f6c62014-02-18 19:42:14 +010093 /**
94 * \brief Create a face by establishing connection to the specified
95 * remote host and remote port
96 *
97 * This method will never block and will return immediately. All
98 * necessary hostname and port resolution and connection will happen
99 * in asynchronous mode.
100 *
101 * If connection cannot be established within specified timeout, it
102 * will be aborted.
103 */
104 void
105 connect(const std::string& remoteHost, const std::string& remotePort,
106 const FaceCreatedCallback& onFaceCreated,
107 const ConnectFailedCallback& onConnectFailed);
108
109 /**
110 * \brief Get number of faces in the channel
111 */
112 size_t
113 size() const;
114
115private:
116 shared_ptr<UdpFace>
117 createFace(const shared_ptr<boost::asio::ip::udp::socket>& socket,
Giulio Grassi69871f02014-03-09 16:14:44 +0100118 const FaceCreatedCallback& onFaceCreated,
Alexander Afanasyev355c0662014-03-20 18:08:17 -0700119 bool isOnDemand);
Giulio Grassi624f6c62014-02-18 19:42:14 +0100120 void
121 afterFaceFailed(udp::Endpoint& endpoint);
122
123 /**
Junxiao Shi61e3cc52014-03-03 20:40:28 -0700124 * \brief The UdpChannel has received a new pkt from a remote endpoint not yet
Giulio Grassi624f6c62014-02-18 19:42:14 +0100125 * associated with any UdpFace
126 */
127 void
Junxiao Shi5dd26c32014-07-20 23:15:14 -0700128 newPeer(const boost::system::error_code& error, size_t nBytesReceived);
Giulio Grassi624f6c62014-02-18 19:42:14 +0100129
130 void
131 handleEndpointResolution(const boost::system::error_code& error,
132 boost::asio::ip::udp::resolver::iterator remoteEndpoint,
133 const FaceCreatedCallback& onFaceCreated,
134 const ConnectFailedCallback& onConnectFailed,
135 const shared_ptr<boost::asio::ip::udp::resolver>& resolver);
136
137private:
138 udp::Endpoint m_localEndpoint;
139
140 /**
141 * \brief Endpoint used to store the information about the last new remote endpoint
142 */
143 udp::Endpoint m_newRemoteEndpoint;
144
145 /**
146 * Callbacks for face creation.
147 * New communications are detected using async_receive_from.
148 * Its handler has a fixed signature. No space for the face callback
149 */
150 FaceCreatedCallback onFaceCreatedNewPeerCallback;
Junxiao Shi61e3cc52014-03-03 20:40:28 -0700151
Giulio Grassi624f6c62014-02-18 19:42:14 +0100152 // @todo remove the onConnectFailedNewPeerCallback if it remains unused
153 ConnectFailedCallback onConnectFailedNewPeerCallback;
154
155 /**
156 * \brief Socket used to "accept" new communication
157 **/
158 shared_ptr<boost::asio::ip::udp::socket> m_socket;
159
160 uint8_t m_inputBuffer[MAX_NDN_PACKET_SIZE];
161
162 typedef std::map< udp::Endpoint, shared_ptr<UdpFace> > ChannelFaceMap;
163 ChannelFaceMap m_channelFaces;
164
165 /**
166 * \brief If true, it means the function listen has already been called
167 */
168 bool m_isListening;
Alexander Afanasyev9bcbc7c2014-04-06 19:37:37 -0700169
Giulio Grassi69871f02014-03-09 16:14:44 +0100170 /**
Alexander Afanasyev355c0662014-03-20 18:08:17 -0700171 * \brief every time m_idleFaceTimeout expires all the idle (and on-demand)
Giulio Grassi69871f02014-03-09 16:14:44 +0100172 * faces will be removed
173 */
Alexander Afanasyeveb3197f2014-03-17 19:28:18 -0700174 time::seconds m_idleFaceTimeout;
Giulio Grassi624f6c62014-02-18 19:42:14 +0100175};
176
177} // namespace nfd
178
Alexander Afanasyev613e2a92014-04-15 13:36:58 -0700179#endif // NFD_DAEMON_FACE_UDP_CHANNEL_HPP