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@4: // under the terms of "Eclipse Public License v1.0"
williamr@2: // which accompanies this distribution, and is available
williamr@4: // at the URL "http://www.eclipse.org/legal/epl-v10.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:  @file CTxData.h
williamr@2:  @warning : This file contains Rose Model ID comments - please do not delete
williamr@2: */
williamr@2: 
williamr@2: #ifndef __CTXDATA_H__
williamr@2: #define __CTXDATA_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: 
williamr@2: //##ModelId=3B1E52A8001F
williamr@2: class CTxData : public CBase, public MHTTPDataSupplier
williamr@2: /**
williamr@2: An abstract base class for the encoding of request data to be transmitted by a
williamr@2: protocol handler.
williamr@2: @publishedAll
williamr@2: @released
williamr@2: */
williamr@2: 	{
williamr@2: public: // methods
williamr@2: 
williamr@2: /** @fn				~CTxData()
williamr@2: 	Intended Usage:	Destructor - cleans up and releases resources to the system	
williamr@2: */
williamr@2: 	IMPORT_C
williamr@2: 	//##ModelId=3B1E52A80051
williamr@2: 	virtual ~CTxData();
williamr@2: 
williamr@2: /** @fn				CProtTransaction& ProtTrans()
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=3B1E52A80049
williamr@2: 	CProtTransaction& ProtTrans();
williamr@2: 
williamr@2: protected:
williamr@2: 
williamr@2: /** @fn				CTxData()
williamr@2: 	Intended Usage:	Default constructor	- creates a Tx data object not associated
williamr@2: 					with any protocol transaction.
williamr@2: */
williamr@2: 	IMPORT_C
williamr@2: 	//##ModelId=3A925A44019E
williamr@2: 	CTxData();
williamr@2: 	
williamr@2: /** @fn				CTxData(CProtTransaction& aProtTransaction)
williamr@2: 	Intended Usage:	Normal constructor, of a CTxData that corresponds to the supplied
williamr@2: 					protocol transaction.
williamr@2: 	@param			aProtTransaction	(in) The transaction for which this object
williamr@2: 											 represents the transmitted data.
williamr@2: */
williamr@2: 	IMPORT_C CTxData(CProtTransaction& aProtTransaction);
williamr@2: 
williamr@2: /** @fn				ConstructL()
williamr@2: 	Intended Usage:	Second phase construction, default
williamr@2: */
williamr@2: 	IMPORT_C
williamr@2: 	//##ModelId=3B1E52A8003D
williamr@2: 	void ConstructL();
williamr@2: 
williamr@2: protected: // attributes
williamr@2: 
williamr@2: 	/** The HTTP transaction from whose request this OTA transmission data is built.
williamr@2: 		Note that the transaction is not owned by this object.
williamr@2: 	*/
williamr@2: 	//##ModelId=3B1E52A80035
williamr@2: 	CProtTransaction* iProtTrans;
williamr@2: 
williamr@2: private: // methods
williamr@2: 
williamr@2: /**	@fn				Reserved1()
williamr@2: 	Intended Usage:	Reserve a slot in the v-table to preserve future BC
williamr@2:  */
williamr@2: 	//##ModelId=3C4C37D6010F
williamr@2: 	inline virtual void Reserved1();
williamr@2: 
williamr@2: /**	@fn				Reserved2()
williamr@2: 	Intended Usage:	Reserve a slot in the v-table to preserve future BC
williamr@2:  */
williamr@2: 	//##ModelId=3C4C37D600FB
williamr@2: 	inline virtual void Reserved2();
williamr@2: 	};
williamr@2: 
williamr@2: 
williamr@2: inline void CTxData::Reserved1()
williamr@2: 	{}
williamr@2: inline void CTxData::Reserved2()
williamr@2: 	{}
williamr@2: 
williamr@2: 
williamr@2: #endif // __CTXDATA_H__