YiAbstractDownloadHelper.h

Go to the documentation of this file.

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

#include "binding/YiScriptableObject.h"
#include "network/YiUrl.h"
#include "signal/YiSignal.h"
#include "thread/YiRecursiveMutex.h"

class CYIHTTPRequest;
class CYIHTTPResponse;

class CYIAbstractDownloadHelper : public CYISignalHandler, public CYIScriptableObject
{
public:
    enum DOWNLOAD_STATE
    {
        IDLE = 0, 
        DOWNLOADING 
    };

    enum FAILURE_TYPE
    {
        INVALID_URL = 0, 
        NETWORK_ERROR 
    };

    CYIAbstractDownloadHelper();

    CYIAbstractDownloadHelper(const CYIUrl &url);

    virtual ~CYIAbstractDownloadHelper();

    const CYIUrl &GetUrl() const;

    void SetUrl(const CYIUrl &url);

    void StartDownload();

    void StartDownload(const CYIUrl &url);

    void CancelDownload();

    DOWNLOAD_STATE GetDownloadState() const;

    CYISignal<FAILURE_TYPE, const CYIUrl & /*url*/> DownloadFailed;
    CYISignal<const CYIUrl & /*url*/> DownloadCancelled;
    CYISignal<const CYIUrl & /*url*/> DownloadComplete;

protected:
    virtual void OnRequestCompleted(const std::shared_ptr<CYIHTTPRequest> &, const std::shared_ptr<CYIHTTPResponse> &, bool);

    virtual void OnRequestFailed(const std::shared_ptr<CYIHTTPRequest> &pRequest);

    virtual void CancelDownloadImplementation() = 0;

    DOWNLOAD_STATE m_state;
    CYIUrl m_url;
    std::shared_ptr<CYIHTTPRequest> m_pCurrentRequest;
    std::shared_ptr<CYIHTTPResponse> m_pCurrentResponse;
    mutable CYIRecursiveMutex m_stateMutex;

private:
    YI_DISALLOW_COPY_AND_ASSIGN(CYIAbstractDownloadHelper)
};

#endif