YiHTTPRequest.h

Go to the documentation of this file.

// © You i Labs Inc. 2000-2017. All rights reserved.
#ifndef _YI_HTTP_REQUEST_H_
#define _YI_HTTP_REQUEST_H_

#include "binding/YiScriptableObject.h"
#include "framework/YiPredef.h"
#include "network/YiHTTPResponse.h"
#include "network/YiHTTPService.h" // To get access to HTTP_STATUS_CODE
#include "network/YiServer.h"
#include "network/YiUrl.h"
#include "signal/YiSignal.h"
#include "utility/YiString.h"

#undef DELETE // Microsoft definition

// Opaque container for cleanup operations
struct OpaqueCleanup;

class CYIHTTPRequestPriv;

class CYIHTTPRequest : public CYIScriptableObject
{
public:

    enum METHOD
    {
        GET, 
        PUT, 
        POST, 
        DELETE 
    };

    enum COMPRESSION_TYPE
    {
        UNCOMPRESSED, 
        GZIP 
    };

    CYIHTTPRequest();

    CYIHTTPRequest(const CYIUrl &url, CYIHTTPRequest::METHOD eMethod);

    CYIHTTPRequest(const CYIServer &server);

    CYIHTTPRequest(const CYIServer &server, const CYIUrl &url, CYIHTTPRequest::METHOD eMethod);

    virtual ~CYIHTTPRequest();

    void SetMethod(CYIHTTPRequest::METHOD eMethod);

    void SetServer(const CYIServer &server);

    void SetPostData(const CYIString &postData);

    const std::vector<char> &GetPostData() const;

    void AddHeader(const CYIString &header);

    const std::vector<CYIString> &GetHeaders() const;

    uint64_t GetUniqueID() const;

    uint32_t GetID() const;

    void SetID(uint32_t uRequestID);

    void SetContextID(uint32_t uContextID);

    uint32_t GetContextID() const;

    void SetCompressionType(COMPRESSION_TYPE eCompressionType);

    CYIHTTPRequest::COMPRESSION_TYPE GetCompressionType() const;

    METHOD GetMethod() const;

    void SetURL(const CYIUrl &url);

    const CYIUrl &GetURL() const;

    const CYIServer GetServer() const;

    void SetNetworkTimeoutMs(uint32_t uNetworkTimeoutMs);

    uint32_t GetNetworkTimeoutMs() const;

    void SetConnectionTimeoutMs(uint32_t uConnectionTimeoutMs);

    uint32_t GetConnectionTimeoutMs() const;

    void SetOpaqueCleanupObject(OpaqueCleanup *pCleanup);

    void SetIsConnectivityProbe(bool bIsConnectivityProbe);

    bool IsConnectivityProbe() const;

    void SetUseCookies(bool bUseCookies);

    bool IsUsingCookies() const;

    void *GetPriv() const;

    bool operator==(const CYIHTTPRequest &other) const;

    bool operator!=(const CYIHTTPRequest &other) const;

    CYISignal<const std::shared_ptr<CYIHTTPRequest> &, const std::shared_ptr<CYIHTTPResponse> &, bool /* bCachedResponse */> NotifyResponse; 
    CYISignal<const std::shared_ptr<CYIHTTPRequest> &, const HTTP_STATUS_CODE, const CYIString &> NotifyError; 

    CYISignal<const std::shared_ptr<CYIHTTPRequest> &, const std::shared_ptr<CYIHTTPResponse> &, const HTTP_STATUS_CODE> NotifyComplete; 

private:
    CYIHTTPRequestPriv *m_pPriv;

    YI_DISALLOW_COPY_AND_ASSIGN(CYIHTTPRequest)
};

#endif // _YI_HTTP_REQUEST_H_