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