NS-3 based Named Data Networking (NDN) simulator
ndnSIM 2.0: NDN, CCN, CCNx, content centric networks
API Documentation
websocket-channel.cpp
Go to the documentation of this file.
1 /* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
26 #include "websocket-channel.hpp"
27 #include "core/global-io.hpp"
28 #include "core/scheduler.hpp"
29 
30 #include <boost/date_time/posix_time/posix_time.hpp>
31 
32 namespace nfd {
33 
34 NFD_LOG_INIT("WebSocketChannel");
35 
37  : m_localEndpoint(localEndpoint)
38  , m_isListening(false)
39  , m_pingInterval(10000)
40 {
41  setUri(FaceUri(m_localEndpoint, "ws"));
42 
43  // Setup WebSocket server
44  m_server.clear_access_channels(websocketpp::log::alevel::all);
45  m_server.clear_error_channels(websocketpp::log::alevel::all);
46 
47  m_server.set_message_handler(bind(&WebSocketChannel::handleMessage, this, _1, _2));
48  m_server.set_open_handler(bind(&WebSocketChannel::handleOpen, this, _1));
49  m_server.set_close_handler(bind(&WebSocketChannel::handleClose, this, _1));
50  m_server.init_asio(&getGlobalIoService());
51 
52  // Detect disconnections using ping-pong messages
53  m_server.set_pong_handler(bind(&WebSocketChannel::handlePong, this, _1, _2));
54  m_server.set_pong_timeout_handler(bind(&WebSocketChannel::handlePongTimeout, this, _1, _2));
55 
56  // Always set SO_REUSEADDR flag
57  m_server.set_reuse_addr(true);
58 }
59 
60 void
61 WebSocketChannel::setPingInterval(time::milliseconds interval)
62 {
63  m_pingInterval = interval;
64 }
65 
66 void
67 WebSocketChannel::setPongTimeout(time::milliseconds timeout)
68 {
69  m_server.set_pong_timeout(static_cast<long>(timeout.count()));
70 }
71 
72 void
73 WebSocketChannel::handlePongTimeout(websocketpp::connection_hdl hdl, std::string msg)
74 {
75  auto it = m_channelFaces.find(hdl);
76  if (it != m_channelFaces.end()) {
77  NFD_LOG_TRACE(__func__ << ": " << it->second->getRemoteUri());
78  it->second->close();
79  m_channelFaces.erase(it);
80  }
81 }
82 
83 void
84 WebSocketChannel::handlePong(websocketpp::connection_hdl hdl, std::string msg)
85 {
86  auto it = m_channelFaces.find(hdl);
87  if (it != m_channelFaces.end()) {
88  NFD_LOG_TRACE("Pong from " << it->second->getRemoteUri());
89  }
90 }
91 
92 void
93 WebSocketChannel::handleMessage(websocketpp::connection_hdl hdl,
94  websocket::Server::message_ptr msg)
95 {
96  auto it = m_channelFaces.find(hdl);
97  if (it != m_channelFaces.end()) {
98  it->second->handleReceive(msg->get_payload());
99  }
100 }
101 
102 void
103 WebSocketChannel::handleOpen(websocketpp::connection_hdl hdl)
104 {
105  try {
106  std::string remote = "wsclient://" + m_server.get_con_from_hdl(hdl)->get_remote_endpoint();
107  auto face = make_shared<WebSocketFace>(FaceUri(remote), this->getUri(),
108  hdl, ref(m_server));
109  m_onFaceCreatedCallback(face);
110  m_channelFaces[hdl] = face;
111  // Schedule ping message
112  scheduler::EventId pingEvent = scheduler::schedule(m_pingInterval,
113  bind(&WebSocketChannel::sendPing,
114  this, hdl));
115  face->setPingEventId(pingEvent);
116  }
117  catch (const FaceUri::Error& e) {
118  NFD_LOG_WARN(e.what());
119  websocketpp::lib::error_code ec;
120  m_server.close(hdl, websocketpp::close::status::normal, "closed by channel", ec);
121  // ignore error on close
122  }
123  catch (const websocketpp::exception& e) {
124  NFD_LOG_WARN("Cannot get remote connection: " << e.what());
125  websocketpp::lib::error_code ec;
126  m_server.close(hdl, websocketpp::close::status::normal, "closed by channel", ec);
127  // ignore error on close
128  }
129 }
130 
131 void
132 WebSocketChannel::sendPing(websocketpp::connection_hdl hdl)
133 {
134  auto it = m_channelFaces.find(hdl);
135  if (it != m_channelFaces.end()) {
136  NFD_LOG_TRACE("Sending ping to " << it->second->getRemoteUri());
137 
138  websocketpp::lib::error_code ec;
139  m_server.ping(hdl, "NFD-WebSocket", ec);
140  if (ec)
141  {
142  NFD_LOG_WARN("Failed to ping " << it->second->getRemoteUri() << ": " << ec.message());
143  it->second->close();
144  m_channelFaces.erase(it);
145  return;
146  }
147 
148  // Schedule next ping message
149  scheduler::EventId pingEvent = scheduler::schedule(m_pingInterval,
150  bind(&WebSocketChannel::sendPing,
151  this, hdl));
152  it->second->setPingEventId(pingEvent);
153  }
154 }
155 
156 void
157 WebSocketChannel::handleClose(websocketpp::connection_hdl hdl)
158 {
159  auto it = m_channelFaces.find(hdl);
160  if (it != m_channelFaces.end()) {
161  NFD_LOG_TRACE(__func__ << ": " << it->second->getRemoteUri());
162  it->second->close();
163  m_channelFaces.erase(it);
164  }
165 }
166 
167 void
169 {
170  if (isListening()) {
171  NFD_LOG_WARN("[" << m_localEndpoint << "] Already listening");
172  return;
173  }
174  m_isListening = true;
175 
176  m_onFaceCreatedCallback = onFaceCreated;
177  m_server.listen(m_localEndpoint);
178  m_server.start_accept();
179 }
180 
181 size_t
183 {
184  return m_channelFaces.size();
185 }
186 
187 } // namespace nfd
represents the underlying protocol and address used by a Face
Definition: face-uri.hpp:44
std::shared_ptr< ns3::EventId > EventId
Definition: scheduler.hpp:39
#define NFD_LOG_WARN(expression)
Definition: logger.hpp:39
WebSocketChannel(const websocket::Endpoint &localEndpoint)
Create WebSocket channel for the local endpoint.
const FaceUri & getUri() const
Definition: channel.hpp:63
Copyright (c) 2011-2015 Regents of the University of California.
Definition: ndn-common.hpp:38
size_t size() const
Get number of faces in the channel.
EventId schedule(const time::nanoseconds &after, const std::function< void()> &event)
schedule an event
Definition: scheduler.cpp:50
void listen(const FaceCreatedCallback &onFaceCreated)
Enable listening on the local endpoint, accept connections, and create faces when remote host makes a...
void setUri(const FaceUri &uri)
Definition: channel.cpp:34
#define NFD_LOG_INIT(name)
Definition: logger.hpp:33
#define NFD_LOG_TRACE(expression)
Definition: logger.hpp:35
boost::asio::io_service & getGlobalIoService()
Definition: global-io.hpp:35
boost::asio::ip::tcp::endpoint Endpoint
function< void(const shared_ptr< Face > &newFace)> FaceCreatedCallback
Prototype for the callback called when face is created (as a response to incoming connection or after...
Definition: channel.hpp:41