SNode.C
Loading...
Searching...
No Matches
SubProtocolFactorySelector.h
Go to the documentation of this file.
1/*
2 * SNode.C - A Slim Toolkit for Network Communication
3 * Copyright (C) Volker Christian <me@vchrist.at>
4 * 2020, 2021, 2022, 2023, 2024, 2025
5 *
6 * This program is free software: you can redistribute it and/or modify
7 * it under the terms of the GNU Lesser General Public License as published
8 * by the Free Software Foundation, either version 3 of the License, or
9 * (at your option) any later version.
10 *
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU Lesser General Public License for more details.
15 *
16 * You should have received a copy of the GNU Lesser General Public License
17 * along with this program. If not, see <http://www.gnu.org/licenses/>.
18 */
19
20/*
21 * MIT License
22 *
23 * Permission is hereby granted, free of charge, to any person obtaining a copy
24 * of this software and associated documentation files (the "Software"), to deal
25 * in the Software without restriction, including without limitation the rights
26 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
27 * copies of the Software, and to permit persons to whom the Software is
28 * furnished to do so, subject to the following conditions:
29 *
30 * The above copyright notice and this permission notice shall be included in
31 * all copies or substantial portions of the Software.
32 *
33 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
34 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
35 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
36 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
37 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
38 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
39 * THE SOFTWARE.
40 */
41
42#ifndef WEB_WEBSOCKET_CLIENT_SUBPROTOCOLSELECTOR_H
43#define WEB_WEBSOCKET_CLIENT_SUBPROTOCOLSELECTOR_H
44
45#include "web/websocket/SubProtocolFactorySelector.h"
46
47namespace web::websocket {
48 template <typename SubProtocolT>
49 class SubProtocolFactory;
50
51 namespace client {
52 class SubProtocol;
53 } // namespace client
54} // namespace web::websocket
55
56#ifndef DOXYGEN_SHOULD_SKIP_THIS
57
58#include <string>
59
60#endif /* DOXYGEN_SHOULD_SKIP_THIS */
61
62namespace web::websocket::client {
63
65 : public web::websocket::SubProtocolFactorySelector<web::websocket::SubProtocolFactory<web::websocket::client::SubProtocol>> {
66 public:
68
70
71 private:
72 using Super = web::websocket::SubProtocolFactorySelector<web::websocket::SubProtocolFactory<web::websocket::client::SubProtocol>>;
73
74 public:
76
78
79 static void allowDlOpen();
80
81 template <typename SubProtocolFactory>
82 static void link(const std::string& subProtocolName, SubProtocolFactory* (*getSubProtocolFactory)()) {
83 SubProtocolFactorySelector::instance()->Super::link(subProtocolName, getSubProtocolFactory);
84 }
85
86 private:
87 SubProtocolFactory* load(const std::string& subProtocolName) override;
88
90 };
91
92} // namespace web::websocket::client
93
94extern template class web::websocket::SubProtocolFactorySelector<web::websocket::SubProtocolFactory<web::websocket::client::SubProtocol>>;
95
96#endif // WEB_WEBSOCKET_CLIENT_SUBPROTOCOLSELECTOR_H
std::size_t receive()
Definition Receiver.cpp:65
void sendClose(uint16_t statusCode=1000, const char *reason=nullptr, std::size_t reasonLength=0) override
void sendPing(const char *reason=nullptr, std::size_t reasonLength=0) override
~SocketContextUpgrade() override=default
void onMessageData(const char *chunk, uint64_t chunkLen) override
SocketContextUpgrade(const SocketContextUpgrade &)=delete
SocketContextUpgrade & operator=(const SocketContextUpgrade &)=delete
void sendMessage(uint8_t opCode, const char *message, std::size_t messageLength) override
void sendClose(const char *message, std::size_t messageLength) override
void sendMessageFrame(const char *message, std::size_t messageLength) override
void sendMessageEnd(const char *message, std::size_t messageLength) override
SocketContextUpgrade(core::socket::stream::SocketConnection *socketConnection, web::http::SocketContextUpgradeFactory< Request, Response > *socketContextUpgradeFactory, Role role)
void sendPong(const char *reason=nullptr, std::size_t reasonLength=0) override
void sendMessageStart(uint8_t opCode, const char *message, std::size_t messageLength) override
core::socket::stream::SocketConnection * getSocketConnection() override
void onMessageError(uint16_t errnum) override
SubProtocolFactory * select(const std::string &subProtocolName, Role role)
virtual std::size_t deleteSubProtocol(SubProtocol *subProtocol)
SubProtocol * createSubProtocol(SubProtocolContext *subProtocolContext)
void sendMessageEnd(const char *message, std::size_t messageLength)
void sendMessage(uint8_t opCode, const char *message, std::size_t messageLength)
void sendMessageStart(uint8_t opCode, const char *message, std::size_t messageLength)
void sendMessageFrame(const char *message, std::size_t messageLength)
web::websocket::SubProtocolFactory< SubProtocol > * subProtocolFactory
std::string loadSubProtocol(const std::string &subProtocolName)
SocketContextUpgrade(core::socket::stream::SocketConnection *socketConnection, web::http::SocketContextUpgradeFactory< web::http::client::Request, web::http::client::Response > *socketContextUpgradeFactory)
SubProtocolFactory * load(const std::string &subProtocolName) override
SubProtocolFactorySelector(const SubProtocolFactorySelector &)=delete
SubProtocolFactorySelector & operator=(const SubProtocolFactorySelector &)=delete
static void link(const std::string &subProtocolName, SubProtocolFactory *(*getSubProtocolFactory)())
friend class web::websocket::SocketContextUpgrade
Definition SubProtocol.h:79
#define CLOSE_SOCKET_TIMEOUT