IHTTPAssetDownloadManager.h

//========================================================================================
// 
// $File$
// 
// Owner: Sanyam Jain
// 
// $Author$
// 
// $DateTime$
// 
// $Revision$
// 
// $Change$
// 
// ADOBE CONFIDENTIAL
// 
// Copyright 2016 Adobe 
// All Rights Reserved.
// 
// NOTICE: Adobe permits you to use, modify, and distribute this file in 
// accordance with the terms of the Adobe license agreement accompanying 
// it. If you have received this file from a source other than Adobe, 
// then your use, modification, or distribution of it requires the prior 
// written permission of Adobe.
// 
//========================================================================================
#ifndef __IHTTPAssetDownloadManager__
#define __IHTTPAssetDownloadManager__

#include "IPMUnknown.h"
#include "LinksID.h"
#include "HTTPLinkSubsystemTypes.h"
#include "URI.h"

#include "boost/config.hpp"
#include "boost/shared_ptr.hpp"
#include "boost/function.hpp"

/*
 AdobePatentID="P7137-US"
 AdobePatentID="P7225-US"
 AdobePatentID="P7609-US"
*/

class IHTTPAssetDownloadManager : public IPMUnknown
{
public:
 enum { kDefaultIID = IID_IHTTPASSETDOWNLOADMANAGER };

 typedef boost::function<void (
 const URI& inURI,
 const IDFile& cachedFilePath,
 HTTPLinkSubsystemTypes::HTTPAssetDownloadState inState, 
 const float inProgress)> AssetDownloadProgressCallback;

 typedef boost::function<void (
 const URI& inURI,
 HTTPLinkSubsystemTypes::HTTPAssetDownloadState inState,
 const IDFile& cachedFilePath)> AssetDownloadCompletionCallback;

 virtual bool16 Initialize() = 0;

 virtual bool16 Shutdown() = 0;

 virtual bool16 StartDownload(const URI& inUri,
 HTTPLinkSubsystemTypes::AssetDownloadMode inDownloadMode, 
 IHTTPAssetDownloadManager::AssetDownloadProgressCallback progressCallback = NULL,
 IHTTPAssetDownloadManager::AssetDownloadCompletionCallback completionCallback = NULL) = 0;

 virtual bool16 StartDownload(const URI& inUri,
 HTTPLinkSubsystemTypes::AssetDownloadMode inDownloadMode,
 const IDFile& downloadPath,
 IHTTPAssetDownloadManager::AssetDownloadProgressCallback progressCallback = NULL,
 IHTTPAssetDownloadManager::AssetDownloadCompletionCallback completionCallback = NULL) = 0;

 virtual bool16 PauseDownload(const URI& inUri) = 0;

 virtual bool16 ResumeDownload(const URI& inUri) = 0;

 virtual bool16 CancelDownload(const URI& inUri) = 0;

 virtual bool16 PauseAllDownloads() = 0;

 virtual bool16 ResumeAllDownloads() = 0;

 virtual bool16 CancelAllDownloads() = 0;
 
 virtual HTTPLinkSubsystemTypes::HTTPAssetDownloadState GetDownloadState(const URI& inUri) const = 0;

 virtual bool16 GetProgress(const URI& inUri, float& outProgress) const = 0;

 virtual bool16 InProgress(const URI& inUri) const = 0;
};

#endif // __IHTTPAssetDownloadManager__