epoc32/include/mw/http/framework/ctxdata.h
author William Roberts <williamr@symbian.org>
Wed, 31 Mar 2010 12:27:01 +0100
branchSymbian2
changeset 3 e1b950c65cb4
parent 2 epoc32/include/http/framework/ctxdata.h@2fe1408b6811
child 4 837f303aceeb
permissions -rw-r--r--
Attempt to represent the S^2->S^3 header reorganisation as a series of "hg rename" operations
     1 // Copyright (c) 2001-2009 Nokia Corporation and/or its subsidiary(-ies).
     2 // All rights reserved.
     3 // This component and the accompanying materials are made available
     4 // 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
     5 // which accompanies this distribution, and is available
     6 // at the URL "http://www.symbianfoundation.org/legal/licencesv10.html".
     7 //
     8 // Initial Contributors:
     9 // Nokia Corporation - initial contribution.
    10 //
    11 // Contributors:
    12 //
    13 // Description:
    14 //
    15 
    16 
    17 
    18 /**
    19  @file CTxData.h
    20  @warning : This file contains Rose Model ID comments - please do not delete
    21 */
    22 
    23 #ifndef __CTXDATA_H__
    24 #define __CTXDATA_H__
    25 
    26 // System includes
    27 #include <e32base.h>
    28 #include <http/framework/cprottransaction.h>
    29 #include <http/mhttpdatasupplier.h>
    30 #include <http/rhttpsession.h> // this include is needed to ensure that the <rhttp.inl> is compiled by gcc...
    31 
    32 
    33 //##ModelId=3B1E52A8001F
    34 class CTxData : public CBase, public MHTTPDataSupplier
    35 /**
    36 An abstract base class for the encoding of request data to be transmitted by a
    37 protocol handler.
    38 @publishedAll
    39 @released
    40 */
    41 	{
    42 public: // methods
    43 
    44 /** @fn				~CTxData()
    45 	Intended Usage:	Destructor - cleans up and releases resources to the system	
    46 */
    47 	IMPORT_C
    48 	//##ModelId=3B1E52A80051
    49 	virtual ~CTxData();
    50 
    51 /** @fn				CProtTransaction& ProtTrans()
    52 	Intended Usage:	Obtain the protocol transaction whose request part is represented
    53 					as encoded data by this object.
    54 	@return The protocol transaction object
    55 */
    56 	IMPORT_C
    57 	//##ModelId=3B1E52A80049
    58 	CProtTransaction& ProtTrans();
    59 
    60 protected:
    61 
    62 /** @fn				CTxData()
    63 	Intended Usage:	Default constructor	- creates a Tx data object not associated
    64 					with any protocol transaction.
    65 */
    66 	IMPORT_C
    67 	//##ModelId=3A925A44019E
    68 	CTxData();
    69 	
    70 /** @fn				CTxData(CProtTransaction& aProtTransaction)
    71 	Intended Usage:	Normal constructor, of a CTxData that corresponds to the supplied
    72 					protocol transaction.
    73 	@param			aProtTransaction	(in) The transaction for which this object
    74 											 represents the transmitted data.
    75 */
    76 	IMPORT_C CTxData(CProtTransaction& aProtTransaction);
    77 
    78 /** @fn				ConstructL()
    79 	Intended Usage:	Second phase construction, default
    80 */
    81 	IMPORT_C
    82 	//##ModelId=3B1E52A8003D
    83 	void ConstructL();
    84 
    85 protected: // attributes
    86 
    87 	/** The HTTP transaction from whose request this OTA transmission data is built.
    88 		Note that the transaction is not owned by this object.
    89 	*/
    90 	//##ModelId=3B1E52A80035
    91 	CProtTransaction* iProtTrans;
    92 
    93 private: // methods
    94 
    95 /**	@fn				Reserved1()
    96 	Intended Usage:	Reserve a slot in the v-table to preserve future BC
    97  */
    98 	//##ModelId=3C4C37D6010F
    99 	inline virtual void Reserved1();
   100 
   101 /**	@fn				Reserved2()
   102 	Intended Usage:	Reserve a slot in the v-table to preserve future BC
   103  */
   104 	//##ModelId=3C4C37D600FB
   105 	inline virtual void Reserved2();
   106 	};
   107 
   108 
   109 inline void CTxData::Reserved1()
   110 	{}
   111 inline void CTxData::Reserved2()
   112 	{}
   113 
   114 
   115 #endif // __CTXDATA_H__