WebSocketSession.h

/* Copyright (C) 2026 by Marc Boris Duerner
   SPDX-License-Identifier: LGPL-2.1-or-later WITH mif-exception
*/
 
#ifndef PT_HTTP_WEBSOCKETSESSION_H
#define PT_HTTP_WEBSOCKETSESSION_H
 
#include <Pt/Http/Api.h>
#include <Pt/Http/WebSocketMessage.h>
#include <Pt/Http/Message.h>
#include <Pt/Connectable.h>
#include <string>
#include <cstddef>
 
namespace Pt {
 
namespace Http {
 
class Stream;
class WebSocketService;
class WebSocketChannel;

class PT_HTTP_API WebSocketSession : public Connectable
{
    friend class WebSocketService;
    friend class WebSocketServlet;
 
    public:
        WebSocketSession(WebSocketService& service,
                         Stream& stream,
                         const Reply& reply);

        ~WebSocketSession();

        WebSocketService& service()
        { return *_service; }

        const WebSocketService& service() const
        { return *_service; }

        const std::string& protocol() const
        { return _protocol; }

        WebSocketMessage& incoming();

        WebSocketMessage& outgoing();

        void beginSend(bool finished = true);

        MessageProgress endSend();

        void beginReceive();

        MessageProgress endReceive();

        void beginPing(const char* payload = 0, std::size_t n = 0);

        void endPing();

        void beginShutdown(unsigned code = 1000,
                   const std::string& reason = std::string());

        void endShutdown();

        void close();

        unsigned closeCode() const;

        const std::string& closeReason() const;
 
    protected:
        virtual void onInput() = 0;

        virtual void onOutput() = 0;

        virtual void onPingReady();

        virtual void onShutdownReady();

        virtual void onClosed();

        virtual void onPong(const std::string& payload);
 
    private:
        void onInputReady();
 
        void onOutputReady();
 
        void onChannelPingReady();
 
        void onChannelShutdownReady();
 
        void onChannelClosed();
 
    private:
        WebSocketService* _service;
        WebSocketChannel* _channel;
        std::string _protocol;
};
 
} // namespace Http
 
} // namespace Pt
 
#endif