1.1 --- /dev/null	Thu Jan 01 00:00:00 1970 +0000
     1.2 +++ b/epoc32/include/mw/http/framework/ctxdata.h	Wed Mar 31 12:27:01 2010 +0100
     1.3 @@ -0,0 +1,115 @@
     1.4 +// Copyright (c) 2001-2009 Nokia Corporation and/or its subsidiary(-ies).
     1.5 +// All rights reserved.
     1.6 +// This component and the accompanying materials are made available
     1.7 +// 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
     1.8 +// which accompanies this distribution, and is available
     1.9 +// at the URL "http://www.symbianfoundation.org/legal/licencesv10.html".
    1.10 +//
    1.11 +// Initial Contributors:
    1.12 +// Nokia Corporation - initial contribution.
    1.13 +//
    1.14 +// Contributors:
    1.15 +//
    1.16 +// Description:
    1.17 +//
    1.18 +
    1.19 +
    1.20 +
    1.21 +/**
    1.22 + @file CTxData.h
    1.23 + @warning : This file contains Rose Model ID comments - please do not delete
    1.24 +*/
    1.25 +
    1.26 +#ifndef __CTXDATA_H__
    1.27 +#define __CTXDATA_H__
    1.28 +
    1.29 +// System includes
    1.30 +#include <e32base.h>
    1.31 +#include <http/framework/cprottransaction.h>
    1.32 +#include <http/mhttpdatasupplier.h>
    1.33 +#include <http/rhttpsession.h> // this include is needed to ensure that the <rhttp.inl> is compiled by gcc...
    1.34 +
    1.35 +
    1.36 +//##ModelId=3B1E52A8001F
    1.37 +class CTxData : public CBase, public MHTTPDataSupplier
    1.38 +/**
    1.39 +An abstract base class for the encoding of request data to be transmitted by a
    1.40 +protocol handler.
    1.41 +@publishedAll
    1.42 +@released
    1.43 +*/
    1.44 +	{
    1.45 +public: // methods
    1.46 +
    1.47 +/** @fn				~CTxData()
    1.48 +	Intended Usage:	Destructor - cleans up and releases resources to the system	
    1.49 +*/
    1.50 +	IMPORT_C
    1.51 +	//##ModelId=3B1E52A80051
    1.52 +	virtual ~CTxData();
    1.53 +
    1.54 +/** @fn				CProtTransaction& ProtTrans()
    1.55 +	Intended Usage:	Obtain the protocol transaction whose request part is represented
    1.56 +					as encoded data by this object.
    1.57 +	@return The protocol transaction object
    1.58 +*/
    1.59 +	IMPORT_C
    1.60 +	//##ModelId=3B1E52A80049
    1.61 +	CProtTransaction& ProtTrans();
    1.62 +
    1.63 +protected:
    1.64 +
    1.65 +/** @fn				CTxData()
    1.66 +	Intended Usage:	Default constructor	- creates a Tx data object not associated
    1.67 +					with any protocol transaction.
    1.68 +*/
    1.69 +	IMPORT_C
    1.70 +	//##ModelId=3A925A44019E
    1.71 +	CTxData();
    1.72 +	
    1.73 +/** @fn				CTxData(CProtTransaction& aProtTransaction)
    1.74 +	Intended Usage:	Normal constructor, of a CTxData that corresponds to the supplied
    1.75 +					protocol transaction.
    1.76 +	@param			aProtTransaction	(in) The transaction for which this object
    1.77 +											 represents the transmitted data.
    1.78 +*/
    1.79 +	IMPORT_C CTxData(CProtTransaction& aProtTransaction);
    1.80 +
    1.81 +/** @fn				ConstructL()
    1.82 +	Intended Usage:	Second phase construction, default
    1.83 +*/
    1.84 +	IMPORT_C
    1.85 +	//##ModelId=3B1E52A8003D
    1.86 +	void ConstructL();
    1.87 +
    1.88 +protected: // attributes
    1.89 +
    1.90 +	/** The HTTP transaction from whose request this OTA transmission data is built.
    1.91 +		Note that the transaction is not owned by this object.
    1.92 +	*/
    1.93 +	//##ModelId=3B1E52A80035
    1.94 +	CProtTransaction* iProtTrans;
    1.95 +
    1.96 +private: // methods
    1.97 +
    1.98 +/**	@fn				Reserved1()
    1.99 +	Intended Usage:	Reserve a slot in the v-table to preserve future BC
   1.100 + */
   1.101 +	//##ModelId=3C4C37D6010F
   1.102 +	inline virtual void Reserved1();
   1.103 +
   1.104 +/**	@fn				Reserved2()
   1.105 +	Intended Usage:	Reserve a slot in the v-table to preserve future BC
   1.106 + */
   1.107 +	//##ModelId=3C4C37D600FB
   1.108 +	inline virtual void Reserved2();
   1.109 +	};
   1.110 +
   1.111 +
   1.112 +inline void CTxData::Reserved1()
   1.113 +	{}
   1.114 +inline void CTxData::Reserved2()
   1.115 +	{}
   1.116 +
   1.117 +
   1.118 +#endif // __CTXDATA_H__