IHTTPLinkConnectionManager.h

//========================================================================================
// 
// $File$
// 
// Owner: Arvinder Singh
// 
// $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 __IHTTPLinkConnectionManager__
#define __IHTTPLinkConnectionManager__

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

#include "IHTTPLinkResourceConnection.h"
#include "IHTTPLinkResourceStateBatchUpdater.h"

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

class IHTTPLinkConnectionManager : public IPMUnknown
{
public:
 enum { kDefaultIID = IID_IHTTPLINKCONNECTIONMANGER };

 /*
 HTTP Connection Result Enum
 */
 enum HTTPConnectionResult
 {
 kHTTPConnectionResult_Success,
 kHTTPConnectionResult_Error,
 kHTTPConnectionResult_Unknown
 };

 virtual bool16 Initialize() = 0;

 virtual bool16 Shutdown() = 0;

 /*
 Gets the HTTP Link Resource Connection for the input URI
 @param inAssetURI [IN] uri of the HTTP Asset.
 @return HTTP Link Resource Connection for the given URI.
 */
 virtual IHTTPLinkResourceConnection* GetHTTPConnection(const URI& inAssetURI) = 0;

 /*
 Releases the input HTTP Link Resource Connection
 @param inConnection [IN] HTTP Link Resource Connection.
 @return kHTTPConnectionResult_Success on succesful release of the connection given by inConnection.
 */
 virtual HTTPConnectionResult ReleaseHTTPConnection(IHTTPLinkResourceConnection* inConnection) = 0;

 /*
 Gets the HTTP Batch updater for the HTTP Link Resource Connection.
 @param inConnection [IN] HTTP Link Resource Connection.
 @return HTTPLinkResourceStateBatchUpdater for the given HTTP Link Resource Connection.
 */
 virtual IHTTPLinkResourceStateBatchUpdater* GetHTTPResourceStateBatchUpdater(IHTTPLinkResourceConnection* inConnection) = 0;

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

#endif // __IHTTPLinkConnectionManager__