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