SubProtocol.h

Go to the documentation of this file.

/*
 * SNode.C - A Slim Toolkit for Network Communication
 * Copyright (C) Volker Christian <me@vchrist.at>
 *               2020, 2021, 2022, 2023, 2024, 2025
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as published
 * by the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 * GNU Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with this program. If not, see <http://www.gnu.org/licenses/>.
 */
 
/*
 * MIT License
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 * THE SOFTWARE.
 */
 
#ifndef WEB_WEBSOCKET_SERVER_SUBSPROTOCOL_H
#define WEB_WEBSOCKET_SERVER_SUBSPROTOCOL_H
 
#include "web/websocket/SubProtocol.h"
 
namespace web::websocket::server {
    class SocketContextUpgrade;
} // namespace web::websocket::server
 
// IWYU pragma: no_include "web/websocket/SubProtocol.hpp"
 
#ifndef DOXYGEN_SHOULD_SKIP_THIS
 
#include <cstddef>
#include <functional>
#include <string>
 
#endif /* DOXYGEN_SHOULD_SKIP_THIS */
 
namespace web::websocket::server {
 
    class SubProtocol : public web::websocket::SubProtocol<web::websocket::server::SocketContextUpgrade> {
    private:
        using Super = web::websocket::SubProtocol<web::websocket::server::SocketContextUpgrade>;
 
    protected:
        SubProtocol(SubProtocolContext* subProtocolContext, const std::string& name, int pingInterval = 0, int maxFlyingPings = 3);
 
    public:
        ~SubProtocol() override;
 
        /* Facade (API) to WSServerContext -> WSTransmitter to be used from SubProtocol-Subclasses */
        using Super::sendMessage;
 
        using Super::sendMessageEnd;
        using Super::sendMessageFrame;
        using Super::sendMessageStart;
 
        using Super::sendClose;
 
        void subscribe(const std::string& group);
 
        void sendBroadcast(const char* message, std::size_t messageLength, bool excludeSelf = false);
        void sendBroadcast(const std::string& message, bool excludeSelf = false);
 
        void sendBroadcastStart(const char* message, std::size_t messageLength, bool excludeSelf = false);
        void sendBroadcastStart(const std::string& message, bool excludeSelf = false);
 
        void sendBroadcastFrame(const char* message, std::size_t messageLength, bool excludeSelf = false);
        void sendBroadcastFrame(const std::string& message, bool excludeSelf = false);
 
        void sendBroadcastEnd(const char* message, std::size_t messageLength, bool excludeSelf = false);
        void sendBroadcastEnd(const std::string& message, bool excludeSelf = false);
 
        void forEachClient(const std::function<void(const SubProtocol*)>& sendToClient, bool excludeSelf = false);
 
    private:
        std::string group;
 
        template <typename RequestT, typename ResponseT, typename SubProtocolT>
        friend class web::websocket::SocketContextUpgrade;
 
        friend class GroupsManager;
    };
 
} // namespace web::websocket::server
 
extern template class web::websocket::SubProtocol<web::websocket::server::SocketContextUpgrade>;
 
#endif // WEB_WEBSOCKET_SERVER_SUBSPROTOCOL_H