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