YiSocket.h

Go to the documentation of this file.

#ifndef _YI_SOCKET_H_
#define _YI_SOCKET_H_

#include <framework/YiPredef.h>

static const uint32_t s_uDefaultSocketConnectTimeoutMs = 10000;

class IYISocket
{
public:
    enum SOCKET_RESULT
    {
        YI_SOCKET_SUCCESS,
        YI_SOCKET_ERROR,
        YI_SOCKET_NOT_CONNECTED,
        YI_SOCKET_CLOSE,
        YI_SOCKET_WOULD_BLOCK
    };

public:
    virtual ~IYISocket() {};
    
    virtual bool Connect() = 0;
    
    virtual bool Disconnect() = 0;
    
    virtual bool IsConnected() const = 0;

    virtual SOCKET_RESULT Send(const char *pBuffer, size_t uLength) = 0;

    virtual SOCKET_RESULT Send(const char *pBuffer, size_t uLength, size_t &uSent) = 0;

    virtual SOCKET_RESULT Receive(char *pBuffer, size_t uLength, size_t &uReceived) = 0;

    virtual uint64_t GetTotalBytesSent() const = 0;

    virtual uint64_t GetTotalBytesReceived() const = 0;

    virtual void SetConnectionTimeoutMs(uint32_t uTimeoutMs) = 0;

    virtual uint32_t GetConnectionTimeoutMs() const = 0;

    virtual bool SetSocketBlockingEnabled(bool bBlocking) = 0;

    static inline bool SOCKET_OPERATION_SUCCEEDED(SOCKET_RESULT eResult)
    {
        return ((eResult == IYISocket::YI_SOCKET_SUCCESS) || (eResult == IYISocket::YI_SOCKET_WOULD_BLOCK));
    }
};

#endif /* _YI_SOCKET_H_ */