author | William Roberts <williamr@symbian.org> |
Wed, 31 Mar 2010 12:27:01 +0100 | |
branch | Symbian2 |
changeset 3 | e1b950c65cb4 |
parent 2 | epoc32/include/http/framework/crxdata.h@2fe1408b6811 |
child 4 | 837f303aceeb |
permissions | -rw-r--r-- |
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 CRxData.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 __CRXDATA_H__ |
williamr@2 | 24 |
#define __CRXDATA_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 |
// Forward declarations |
williamr@2 | 33 |
class MRxDataObserver; |
williamr@2 | 34 |
|
williamr@2 | 35 |
|
williamr@2 | 36 |
//##ModelId=3B1E52AB0087 |
williamr@2 | 37 |
class CRxData : public CBase, public MHTTPDataSupplier |
williamr@2 | 38 |
/** |
williamr@2 | 39 |
An abstract base class for the decoding of response data received by a |
williamr@2 | 40 |
protocol handler. |
williamr@2 | 41 |
@publishedAll |
williamr@2 | 42 |
@released |
williamr@2 | 43 |
*/ |
williamr@2 | 44 |
{ |
williamr@2 | 45 |
public: |
williamr@2 | 46 |
|
williamr@2 | 47 |
/** Intended Usage: Destructor - cleans up and releases resources to the system |
williamr@2 | 48 |
*/ |
williamr@2 | 49 |
IMPORT_C |
williamr@2 | 50 |
//##ModelId=3B1E52AB00ED |
williamr@2 | 51 |
virtual ~CRxData(); |
williamr@2 | 52 |
|
williamr@2 | 53 |
/** Intended Usage: Obtain the protocol transaction whose request part is represented |
williamr@2 | 54 |
as encoded data by this object. |
williamr@2 | 55 |
@return The protocol transaction object |
williamr@2 | 56 |
*/ |
williamr@2 | 57 |
IMPORT_C |
williamr@2 | 58 |
//##ModelId=3B1E52AB00EC |
williamr@2 | 59 |
CProtTransaction& ProtTrans(); |
williamr@2 | 60 |
|
williamr@2 | 61 |
public: |
williamr@2 | 62 |
|
williamr@2 | 63 |
/** Intended Usage: Resets the received data object to its initial state following |
williamr@2 | 64 |
construction. This method must be implemented for specific sub- |
williamr@2 | 65 |
classes of received data. |
williamr@2 | 66 |
@post The object is reset. |
williamr@2 | 67 |
*/ |
williamr@2 | 68 |
//##ModelId=3BA60048014B |
williamr@2 | 69 |
virtual void ResetRxData() = 0; |
williamr@2 | 70 |
|
williamr@2 | 71 |
protected: |
williamr@2 | 72 |
|
williamr@2 | 73 |
/** Intended Usage: Default constructor - creates an Rx data object not associated |
williamr@2 | 74 |
with any protocol transaction. |
williamr@2 | 75 |
*/ |
williamr@2 | 76 |
IMPORT_C |
williamr@2 | 77 |
//##ModelId=3A914E5F008F |
williamr@2 | 78 |
CRxData(); |
williamr@2 | 79 |
|
williamr@2 | 80 |
/** Intended Usage: Normal constructor, of a CRxData that corresponds to the supplied |
williamr@2 | 81 |
protocol transaction, and which sends status updates to the supplied |
williamr@2 | 82 |
observer interface, |
williamr@2 | 83 |
@param aProtTrans (in) The transaction for which this object |
williamr@2 | 84 |
represents the transmitted data. |
williamr@2 | 85 |
@param aObserver (in) The object's observer. |
williamr@2 | 86 |
*/ |
williamr@2 | 87 |
IMPORT_C CRxData(CProtTransaction& aProtTrans, MRxDataObserver& aObserver); |
williamr@2 | 88 |
|
williamr@2 | 89 |
/** Intended Usage: Second phase construction, default |
williamr@2 | 90 |
*/ |
williamr@2 | 91 |
IMPORT_C |
williamr@2 | 92 |
//##ModelId=3B1E52AB00BA |
williamr@2 | 93 |
void ConstructL(); |
williamr@2 | 94 |
|
williamr@2 | 95 |
protected: |
williamr@2 | 96 |
|
williamr@2 | 97 |
/** The protocol transaction for which this object represents the encoded received data |
williamr@2 | 98 |
*/ |
williamr@2 | 99 |
//##ModelId=3B1E52AB00B2 |
williamr@2 | 100 |
CProtTransaction* iProtTrans; |
williamr@2 | 101 |
|
williamr@2 | 102 |
/** This object's observer, to whom we forward status information |
williamr@2 | 103 |
*/ |
williamr@2 | 104 |
//##ModelId=3B1E7738028B |
williamr@2 | 105 |
MRxDataObserver* iObserver; |
williamr@2 | 106 |
|
williamr@2 | 107 |
private: // methods |
williamr@2 | 108 |
|
williamr@2 | 109 |
/** Intended Usage: Reserve a slot in the v-table to preserve future BC |
williamr@2 | 110 |
*/ |
williamr@2 | 111 |
//##ModelId=3C4C37DA0007 |
williamr@2 | 112 |
inline virtual void Reserved1(); |
williamr@2 | 113 |
|
williamr@2 | 114 |
/** Intended Usage: Reserve a slot in the v-table to preserve future BC |
williamr@2 | 115 |
*/ |
williamr@2 | 116 |
//##ModelId=3C4C37D903DB |
williamr@2 | 117 |
inline virtual void Reserved2(); |
williamr@2 | 118 |
}; |
williamr@2 | 119 |
|
williamr@2 | 120 |
|
williamr@2 | 121 |
inline void CRxData::Reserved1() |
williamr@2 | 122 |
{} |
williamr@2 | 123 |
inline void CRxData::Reserved2() |
williamr@2 | 124 |
{} |
williamr@2 | 125 |
|
williamr@2 | 126 |
|
williamr@2 | 127 |
#endif // __CRXDATA_H__ |