NS-3 based Named Data Networking (NDN) simulator
ndnSIM 2.5: NDN, CCN, CCNx, content centric networks
API Documentation
websocket-transport.hpp
Go to the documentation of this file.
1 /* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
2 /*
3  * Copyright (c) 2014-2019, 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_WEBSOCKET_TRANSPORT_HPP
27 #define NFD_DAEMON_FACE_WEBSOCKET_TRANSPORT_HPP
28 
29 #include "transport.hpp"
30 #include "websocketpp.hpp"
31 
32 namespace nfd {
33 namespace face {
34 
40 {
41 public:
45 
49 };
50 
53 class WebSocketTransport final : public Transport
54  , protected virtual WebSocketTransportCounters
55 {
56 public:
60 
61  WebSocketTransport(websocketpp::connection_hdl hdl,
62  websocket::Server& server,
63  time::milliseconds pingInterval);
64 
65  const Counters&
66  getCounters() const final;
67 
71  void
72  receiveMessage(const std::string& msg);
73 
74  void
75  handlePong();
76 
77  void
79 
80 protected:
81  void
82  doClose() final;
83 
84 private:
85  void
86  doSend(const Block& packet, const EndpointId& endpoint) final;
87 
88  void
89  schedulePing();
90 
91  void
92  sendPing();
93 
94  void
95  processErrorCode(const websocketpp::lib::error_code& error);
96 
97 private:
98  websocketpp::connection_hdl m_handle;
99  websocket::Server& m_server;
100  time::milliseconds m_pingInterval;
101  scheduler::ScopedEventId m_pingEventId;
102 };
103 
104 inline const WebSocketTransport::Counters&
106 {
107  return *this;
108 }
109 
110 } // namespace face
111 } // namespace nfd
112 
113 #endif // NFD_DAEMON_FACE_WEBSOCKET_TRANSPORT_HPP
nfd::face::TransportCounters
Counters provided by a transport.
Definition: transport.hpp:54
nfd::face::WebSocketTransport::receiveMessage
void receiveMessage(const std::string &msg)
Translates a message into a Block and delivers it to the link service.
Definition: websocket-transport.cpp:95
nfd::face::WebSocketTransport::doClose
void doClose() final
performs Transport specific operations to close the transport
Definition: websocket-transport.cpp:164
nfd::face::WebSocketTransportCounters
counters provided by WebSocketTransport
Definition: websocket-transport.hpp:40
nfd::face::WebSocketTransport::Counters
WebSocketTransportCounters Counters
counters provided by WebSocketTransport
Definition: websocket-transport.hpp:59
nfd::face::WebSocketTransport::WebSocketTransport
WebSocketTransport(websocketpp::connection_hdl hdl, websocket::Server &server, time::milliseconds pingInterval)
Definition: websocket-transport.cpp:52
nfd::face::WebSocketTransport::handlePongTimeout
void handlePongTimeout()
Definition: websocket-transport.cpp:140
websocketpp.hpp
transport.hpp
ndn::scheduler::ScopedEventId
detail::ScopedCancelHandle< EventId > ScopedEventId
A scoped handle for a scheduled event.
Definition: scheduler.hpp:128
nfd::face::WebSocketTransport
A Transport that communicates on a WebSocket connection.
Definition: websocket-transport.hpp:55
nfd
Copyright (c) 2011-2015 Regents of the University of California.
Definition: ndn-common.hpp:40
nfd::face::WebSocketTransportCounters::nOutPings
PacketCounter nOutPings
count of outgoing Pings
Definition: websocket-transport.hpp:44
ndn::time
Definition: time-custom-clock.hpp:28
nfd::websocket::Server
websocketpp::server< websocketpp::config::asio > Server
Definition: websocketpp.hpp:46
nfd::face::WebSocketTransport::getCounters
const Counters & getCounters() const final
Definition: websocket-transport.hpp:105
ndn::scheduler
Definition: scheduler.cpp:27
nfd::face::WebSocketTransport::handlePong
void handlePong()
Definition: websocket-transport.cpp:132
nfd::PacketCounter
represents a counter of number of packets
Definition: counter.hpp:67
ndn::Block
Represents a TLV element of NDN packet format.
Definition: block.hpp:43
nfd::face::EndpointId
uint64_t EndpointId
Identifies a remote endpoint on the link.
Definition: face-common.hpp:65
nfd::face::WebSocketTransportCounters::nInPongs
PacketCounter nInPongs
count of incoming Pongs
Definition: websocket-transport.hpp:48
nfd::face::Transport
The lower half of a Face.
Definition: transport.hpp:109