YiWebSocket.h

Go to the documentation of this file.

#ifndef _YI_WEBSOCKET_H_
#define _YI_WEBSOCKET_H_

#include "framework/YiPredef.h"
#include "signal/YiSignal.h"
#include "utility/YiString.h"

class CYIWebSocketPriv;

static const uint32_t s_uDefaultWebSocketConnectTimeoutMs = 10000;

class CYIWebSocket
{
public:
    enum MESSAGE_TYPE
    {
        NONE,
        BINARY,
        TEXT,
        UNKNOWN
    };

    enum WEBSOCKET_RESULT
    {
        WS_SUCCESS,    
        WS_ERROR,
        WS_NOT_CONNECTED,            
        WS_ALREADY_CONNECTED, 
        WS_COULD_NOT_CONNECT,
        WS_CONNECT_TIMEOUT,
        WS_BUFFER_TOO_SMALL,
        WS_PROTOCOL_NOT_SUPPORTED
    };

public:
    static std::unique_ptr<CYIWebSocket> Create(const CYIString &url);

    virtual ~CYIWebSocket();

    WEBSOCKET_RESULT Connect();
    
    WEBSOCKET_RESULT Disconnect();
    
    bool IsConnected() const;
    
    WEBSOCKET_RESULT Send(MESSAGE_TYPE eType, const char *pBuffer, size_t nLength);

    WEBSOCKET_RESULT Receive(MESSAGE_TYPE &eType, char *pBuffer, size_t nLength, size_t &nReceived);

    WEBSOCKET_RESULT Peek(CYIWebSocket::MESSAGE_TYPE& eType, size_t& nLength);

    void SetConnectionTimeoutMs(uint32_t uTimeoutMs);

    uint32_t GetConnectionTimeoutMs() const;

    CYISignal <CYIWebSocket *> WebSocketDisconnected;

    CYISignal<CYIWebSocket *, MESSAGE_TYPE, uint32_t> WebSocketReceivedMessage;

protected:
    CYIWebSocket(const CYIString &url);

private:
    YI_DISALLOW_COPY_AND_ASSIGN(CYIWebSocket);
    
    CYIWebSocketPriv *m_pPriv;
};

#endif // _YI_WEBSOCKET_H_