ws_websocket.hpp

浏览该文件的文档.

#pragma once

namespace ws
{
enum OpCode : winux::uint
{
    dataContinued = 0x0U, 
    dataText = 0x1U, 
    dataBinary = 0x2U, 
    dataRsv3 = 0x3U,
    dataRsv4 = 0x4U,
    dataRsv5 = 0x5U,
    dataRsv6 = 0x6U,
    dataRsv7 = 0x7U,
    ctrlClose = 0x8U, 
    ctrlPing = 0x9U, 
    ctrlPong = 0xAU, 
    ctrlRsvB = 0xBU,
    ctrlRsvC = 0xCU,
    ctrlRsvD = 0xDU,
    ctrlRsvE = 0xEU,
    ctrlRsvF = 0xFU,
};

enum WebSocketErrorCode
{
    errNothing, 
    errCnnUnexpectedInvalid,    
    //errCnnUpgradeFail,
};

enum FrameType
{
    ftBasic = 0b0010,
    ftBasicMasked = 0b0011,
    ftExtended16 = 0b0100,
    ftExtended16Masked = 0b0101,
    ftExtended64 = 0b1000,
    ftExtended64Masked = 0b1001,
};

enum ReadyState
{
    stateNone,      
    stateConnecting,
    stateOpen,      
    stateClosing,   
    stateClosed,    
};

#pragma pack(push, 1)

struct FrameBase
{
    winux::uint8 opcode:4;
    winux::uint8 rsv3:1;
    winux::uint8 rsv2:1;
    winux::uint8 rsv1:1;
    winux::uint8 fin:1;

    winux::uint8 payloadLen:7;
    winux::uint8 mask:1;

    FrameBase()
    {
        memset( this, 0, sizeof(*this) );
    }
};

// 基本帧 payload len < 126, mask == 0
struct FrameBasic : FrameBase
{
    FrameBasic()
    {
        memset( this, 0, sizeof(*this) );
    }

    template < typename _Ty >
    _Ty * data()
    {
        return reinterpret_cast<_Ty*>( this + 1 );
    }
};
#pragma pack(pop)


#pragma pack(push, 2)
// 基本掩码帧 payload len < 126, mask == 1
struct FrameBasicMasked : FrameBase
{
    winux::uint8 maskingKey[4];

    FrameBasicMasked()
    {
        memset( this, 0, sizeof(*this) );
    }

    template < typename _Ty >
    _Ty * data()
    {
        return reinterpret_cast<_Ty*>( this + 1 );
    }
};

// 16位数据扩展帧 payload len == 126, mask == 0
struct FrameExtended16 : FrameBase
{
    winux::uint16 extendedPayloadLen;

    FrameExtended16()
    {
        memset( this, 0, sizeof(*this) );
    }

    template < typename _Ty >
    _Ty * data()
    {
        return reinterpret_cast<_Ty*>( this + 1 );
    }
};

// 16位数据扩展掩码帧 payload len == 126, mask == 1
struct FrameExtended16Masked : FrameBase
{
    winux::uint16 extendedPayloadLen;
    winux::uint8 maskingKey[4];

    FrameExtended16Masked()
    {
        memset( this, 0, sizeof(*this) );
    }

    template < typename _Ty >
    _Ty * data()
    {
        return reinterpret_cast<_Ty*>( this + 1 );
    }
};

// 64位数据扩展帧 payload len == 127, mask == 0
struct FrameExtended64 : FrameBase
{
    winux::uint64 extendedPayloadLen;

    FrameExtended64()
    {
        memset( this, 0, sizeof(*this) );
    }

    template < typename _Ty >
    _Ty * data()
    {
        return reinterpret_cast<_Ty*>( this + 1 );
    }
};

// 64位数据扩展掩码帧 payload len == 127, mask == 1
struct FrameExtended64Masked : FrameBase
{
    winux::uint64 extendedPayloadLen;
    winux::uint8 maskingKey[4];

    FrameExtended64Masked()
    {
        memset( this, 0, sizeof(*this) );
    }

    template < typename _Ty >
    _Ty * data()
    {
        return reinterpret_cast<_Ty*>( this + 1 );
    }
};

// 关闭帧载荷数据
struct CloseFramePayloadData
{
    winux::uint16 code;
    template < typename _Ty >
    _Ty * data()
    {
        return reinterpret_cast<_Ty*>( this + 1 );
    }
};
#pragma pack(pop)


// 构建WebSocket帧
HTTPWRAPPER_FUNC_DECL(winux::Buffer) BuildFrame( OpCode opcode, bool fin, bool mask, winux::byte * payloadData = nullptr, size_t payloadDataSize = 0 );
// 构建WebSocket数据。指定perFrameMaxPayloadSize将自动分片成多个帧
HTTPWRAPPER_FUNC_DECL(std::vector<winux::Buffer>) BuildFramesFromData( OpCode opcode, bool mask, winux::Buffer payloadData = winux::Buffer(), size_t perFrameMaxPayloadSize = -1 );


class WsHttpServer;
class HTTPWRAPPER_DLL WsHttpRequestCtx : public http::HttpRequestCtx
{
public:
    WsHttpRequestCtx( WsHttpServer * server, winux::uint64 clientId, winux::String const & clientEpStr, winux::SharedPointer<eiennet::ip::tcp::Socket> clientSockPtr );

    enum TaskType
    {
        ttRecvWebSocketFrameBase = http::HttpRequestCtx::ttNextStart,    
        ttRecvWebSocketFrame,   
        ttDoProcessWebSocketFrameTask   
    };

private:
    winux::AnsiString _message;  // websocket消息缓冲区，用于接收多帧数据（一条消息可能分片）
    int _messageType;   // 消息类型，0没有；1文本；2二进制
    ReadyState _state;  // WebSocket连接状态

    friend class WsHttpServer;
};

class HTTPWRAPPER_DLL WsHttpServer : public http::HttpServer
{
public:
    using HttpServer::HttpServer;

protected:
    virtual bool _beginRouting( winux::SharedPointer<http::HttpRequestCtx> requestCtxPtr, http::UrlPathPartData const & urlData, http::Response & rsp ) override;

    DEFINE_CUSTOM_EVENT( Open, ( winux::SharedPointer<WsHttpRequestCtx> requestCtxPtr ), ( requestCtxPtr ) )
    DEFINE_CUSTOM_EVENT( Message, ( winux::SharedPointer<WsHttpRequestCtx> requestCtxPtr, winux::AnsiString const & data, int messageType ), ( requestCtxPtr, data, messageType ) )
    DEFINE_CUSTOM_EVENT( Close, ( winux::SharedPointer<WsHttpRequestCtx> requestCtxPtr, winux::uint16 errCode, winux::AnsiString const & errStr ), ( requestCtxPtr, errCode, errStr ) )
    DEFINE_CUSTOM_EVENT( Error, ( winux::SharedPointer<WsHttpRequestCtx> requestCtxPtr, WebSocketErrorCode ec ), ( requestCtxPtr, ec ) )
};


} // namespace ws