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 IOT_MQTT_MQTTSUBPROTOCOL_H
#define IOT_MQTT_MQTTSUBPROTOCOL_H
 
namespace web::websocket {
    class SubProtocolContext;
}
 
namespace utils {
    class Timeval;
}
 
namespace iot::mqtt {
    class Mqtt;
}
 
#include "core/EventReceiver.h"
#include "iot/mqtt/MqttContext.h"
 
#ifndef DOXYGEN_SHOULD_SKIP_THIS
 
#include <cstddef>
#include <cstdint>
#include <functional>
#include <string>
#include <vector>
 
#endif // DOXYGEN_SHOULD_SKIP_THIS
 
namespace iot::mqtt {
 
    class OnReceivedFromPeerEvent : public core::EventReceiver {
    public:
        explicit OnReceivedFromPeerEvent(const std::function<void(const utils::Timeval&)>& onReceivedFromPeer);
 
    private:
        void onEvent(const utils::Timeval& currentTime) override;
 
        std::function<void(const utils::Timeval&)> onReceivedFromPeer;
    };
 
    template <typename WSSubProtocolRoleT>
    class SubProtocol
        : public WSSubProtocolRoleT
        , private iot::mqtt::MqttContext {
    private:
        using WSSubProtocolRole = WSSubProtocolRoleT;
 
    public:
        SubProtocol(web::websocket::SubProtocolContext* subProtocolContext, const std::string& name, iot::mqtt::Mqtt* mqtt);
        ~SubProtocol() override = default;
 
        std::size_t recv(char* chunk, std::size_t chunklen) override;
        void send(const char* chunk, std::size_t chunklen) override;
 
        void end(bool fatal = false) override;
        void close() override;
 
    private:
        void onConnected() override;
        void onMessageStart(int opCode) override;
        void onMessageData(const char* chunk, std::size_t chunkLen) override;
        void onMessageEnd() override;
        void onMessageError(uint16_t errnum) override;
        void onDisconnected() override;
        bool onSignal(int sig) override;
 
        core::socket::stream::SocketConnection* getSocketConnection() const override;
 
        OnReceivedFromPeerEvent onReceivedFromPeerEvent;
 
        std::string data;
        std::vector<char> buffer;
        std::size_t cursor = 0;
        std::size_t size = 0;
    };
 
} // namespace iot::mqtt
 
#endif // IOT_MQTT_MQTTSUBPROTOCOL_H