NFD: Named Data Networking Forwarding Daemon 24.07-28-gdcc0e6e0
Loading...
Searching...
No Matches
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-2024, 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#include <ndn-cxx/util/scheduler.hpp>
33
34namespace nfd::face {
35
49
53class WebSocketTransport final : public Transport
54 , protected virtual WebSocketTransportCounters
55{
56public:
61
62 WebSocketTransport(websocketpp::connection_hdl hdl,
63 websocket::Server& server,
64 time::milliseconds pingInterval);
65
66 const Counters&
67 getCounters() const final
68 {
69 return *this;
70 }
71
75 void
76 receiveMessage(const std::string& msg);
77
78 void
79 handlePong();
80
81 void
83
84protected:
85 void
86 doClose() final;
87
88private:
89 void
90 doSend(const Block& packet) final;
91
92 void
93 schedulePing();
94
95 void
96 sendPing();
97
98 void
99 processErrorCode(const websocketpp::lib::error_code& error);
100
101private:
102 websocketpp::connection_hdl m_handle;
103 websocket::Server& m_server;
104 time::milliseconds m_pingInterval;
105 ndn::scheduler::ScopedEventId m_pingEventId;
106};
107
108} // namespace nfd::face
109
110#endif // NFD_DAEMON_FACE_WEBSOCKET_TRANSPORT_HPP
Represents a counter of number of packets.
Definition counter.hpp:71
Counters provided by a transport.
Definition transport.hpp:55
The lower half of a Face.
Counters provided by WebSocketTransport.
PacketCounter nInPongs
Count of incoming pongs.
PacketCounter nOutPings
Count of outgoing pings.
A Transport that communicates on a WebSocket connection.
void doClose() final
Performs Transport specific operations to close the transport.
const Counters & getCounters() const final
void receiveMessage(const std::string &msg)
Translates a message into a Block and delivers it to the link service.
websocketpp::server< websocketpp::config::asio > Server