williamr@2: // Copyright (c) 2001-2009 Nokia Corporation and/or its subsidiary(-ies).
williamr@2: // All rights reserved.
williamr@2: // This component and the accompanying materials are made available
williamr@2: // under the terms of the License "Symbian Foundation License v1.0" to Symbian Foundation members and "Symbian Foundation End User License Agreement v1.0" to non-members
williamr@2: // which accompanies this distribution, and is available
williamr@2: // at the URL "http://www.symbianfoundation.org/legal/licencesv10.html".
williamr@2: //
williamr@2: // Initial Contributors:
williamr@2: // Nokia Corporation - initial contribution.
williamr@2: //
williamr@2: // Contributors:
williamr@2: //
williamr@2: // Description:
williamr@2: //
williamr@2: 
williamr@2: 
williamr@2: 
williamr@2: /**
williamr@2:  @file CRxData.h
williamr@2:  @warning : This file contains Rose Model ID comments - please do not delete
williamr@2: */
williamr@2: 
williamr@2: #ifndef __CRXDATA_H__
williamr@2: #define __CRXDATA_H__
williamr@2: 
williamr@2: // System includes
williamr@2: #include <e32base.h>
williamr@2: #include <http/framework/cprottransaction.h>
williamr@2: #include <http/mhttpdatasupplier.h>
williamr@2: #include <http/rhttpsession.h> // this include is needed to ensure that the <rhttp.inl> is compiled by gcc...
williamr@2: 
williamr@2: // Forward declarations
williamr@2: class MRxDataObserver;
williamr@2: 
williamr@2: 
williamr@2: //##ModelId=3B1E52AB0087
williamr@2: class CRxData : public CBase, public MHTTPDataSupplier
williamr@2: /**
williamr@2: An abstract base class for the decoding of response data received by a
williamr@2: protocol handler.
williamr@2: @publishedAll
williamr@2: @released
williamr@2: */
williamr@2: 	{
williamr@2: public:
williamr@2: 
williamr@2: /** Intended Usage:	Destructor - cleans up and releases resources to the system	
williamr@2: */
williamr@2: 	IMPORT_C
williamr@2: 	//##ModelId=3B1E52AB00ED
williamr@2: 	virtual ~CRxData();
williamr@2: 
williamr@2: /** Intended Usage:	Obtain the protocol transaction whose request part is represented
williamr@2: 					as encoded data by this object.
williamr@2: 	@return The protocol transaction object
williamr@2: */
williamr@2: 	IMPORT_C
williamr@2: 	//##ModelId=3B1E52AB00EC
williamr@2: 	CProtTransaction& ProtTrans();
williamr@2: 
williamr@2: public:
williamr@2: 
williamr@2: /** Intended Usage:	Resets the received data object to its initial state following
williamr@2: 					construction.  This method must be implemented for specific sub-
williamr@2: 					classes of received data.
williamr@2: 	@post			The object is reset.
williamr@2: */
williamr@2: 	//##ModelId=3BA60048014B
williamr@2: 	virtual void ResetRxData() = 0;
williamr@2: 
williamr@2: protected:
williamr@2: 
williamr@2: /** Intended Usage:	Default constructor	- creates an Rx data object not associated
williamr@2: 					with any protocol transaction.
williamr@2: */
williamr@2: 	IMPORT_C
williamr@2: 	//##ModelId=3A914E5F008F
williamr@2: 	CRxData();
williamr@2: 
williamr@2: /** Intended Usage:	Normal constructor, of a CRxData that corresponds to the supplied
williamr@2: 					protocol transaction, and which sends status updates to the supplied
williamr@2: 					observer interface,
williamr@2: 	@param			aProtTrans			(in) The transaction for which this object
williamr@2: 											 represents the transmitted data.
williamr@2: 	@param			aObserver			(in) The object's observer.
williamr@2: */
williamr@2: 	IMPORT_C CRxData(CProtTransaction& aProtTrans, MRxDataObserver& aObserver);
williamr@2: 
williamr@2: /** Intended Usage:	Second phase construction, default
williamr@2: */
williamr@2: 	IMPORT_C
williamr@2: 	//##ModelId=3B1E52AB00BA
williamr@2: 	void ConstructL();
williamr@2: 
williamr@2: protected:
williamr@2: 
williamr@2: 	/** The protocol transaction for which this object represents the encoded received data
williamr@2: 	*/
williamr@2: 	//##ModelId=3B1E52AB00B2
williamr@2: 	CProtTransaction* iProtTrans;
williamr@2: 
williamr@2: 	/** This object's observer, to whom we forward status information
williamr@2: 	*/
williamr@2: 	//##ModelId=3B1E7738028B
williamr@2: 	MRxDataObserver* iObserver;
williamr@2: 
williamr@2: private: // methods
williamr@2: 
williamr@2: /**	Intended Usage:	Reserve a slot in the v-table to preserve future BC
williamr@2:  */
williamr@2: 	//##ModelId=3C4C37DA0007
williamr@2: 	inline virtual void Reserved1();
williamr@2: 
williamr@2: /**	Intended Usage:	Reserve a slot in the v-table to preserve future BC
williamr@2:  */
williamr@2: 	//##ModelId=3C4C37D903DB
williamr@2: 	inline virtual void Reserved2();
williamr@2: 	};
williamr@2: 
williamr@2: 
williamr@2: inline void CRxData::Reserved1()
williamr@2: 	{}
williamr@2: inline void CRxData::Reserved2()
williamr@2: 	{}
williamr@2: 
williamr@2: 
williamr@2: #endif // __CRXDATA_H__