IHTTPLinkResourceServerCache.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 __IHTTPLinkResourceServerCache__
#define __IHTTPLinkResourceServerCache__

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

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

class IHTTPLinkResourceServerCache : public IPMUnknown
{
public:
 enum { kDefaultIID = IID_IHTTPLINKRESOURCESERVERCACHE };

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

 typedef boost::function<void(
 const URI& inUri,
 const HTTPLinkSubsystemTypes::HTTPAssetDownloadState& inState,
 std::shared_ptr<IHTTPLinkCachedAssetEntry> cachedAssetEntry)> AssetDownloadCompletionCallback;

 virtual bool16 Initialize() = 0;

 virtual bool16 Shutdown() = 0;

 virtual std::shared_ptr<IHTTPLinkCachedAssetEntry> GetCachedAssetEntry(const URI& inUri,
 bool16 inDownloadIfMissing = kTrue,
 HTTPLinkSubsystemTypes::AssetDownloadMode inDownloadMode = HTTPLinkSubsystemTypes::kAssetDownloadMode_Sync,
 IHTTPLinkResourceServerCache::AssetDownloadProgressCallback downloadProgressCallback = NULL,
 IHTTPLinkResourceServerCache::AssetDownloadCompletionCallback downloadCompletionCallback = NULL) = 0;

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

 virtual bool16 IsCachedAssetEntryStale(const URI& inUri, const IHTTPLinkResourceServerAPIWrapper::AssetMetadataPtr assetCurrentAttributes) = 0;

 virtual bool16 PurgeCache(bool16 forcePurgeAll = kFalse) = 0;

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

 virtual void ReadWriteSnapshotForBackgroundThread(IPMStream* s) = 0;
};

#endif // __IHTTPLinkResourceServerCache__