websocket_frame.h

Go to the documentation of this file.

// BSD 3-Clause License
// Copyright (c) 2024, 🍀☀🌕🌥 🌊
// See the LICENSE file in the project root for full license information.
 
#pragma once
 
#include <array>
#include <cstdint>
#include <optional>
#include <vector>
 
namespace kcenon::network::internal
{
    enum class ws_opcode : uint8_t
    {
        continuation = 0x0,  
        text = 0x1,          
        binary = 0x2,        
        close = 0x8,         
        ping = 0x9,          
        pong = 0xA           
    };
 
    struct ws_frame_header
    {
        bool fin;                        
        bool rsv1;                       
        bool rsv2;                       
        bool rsv3;                       
        ws_opcode opcode;                
        bool mask;                       
        uint64_t payload_len;            
        std::array<uint8_t, 4> masking_key; 
    };
 
    class websocket_frame
    {
    public:
        static auto encode_frame(ws_opcode opcode, std::vector<uint8_t>&& payload,
                                 bool fin = true, bool mask = false)
            -> std::vector<uint8_t>;
 
        static auto decode_header(const std::vector<uint8_t>& data)
            -> std::optional<ws_frame_header>;
 
        static auto decode_payload(const ws_frame_header& header,
                                   const std::vector<uint8_t>& data)
            -> std::vector<uint8_t>;
 
        static auto apply_mask(std::vector<uint8_t>& data,
                               const std::array<uint8_t, 4>& mask) -> void;
 
        static auto generate_mask() -> std::array<uint8_t, 4>;
 
        static auto calculate_header_size(uint64_t payload_len, bool mask) -> size_t;
    };
 
} // namespace kcenon::network::internal