1.1 --- /dev/null Thu Jan 01 00:00:00 1970 +0000
1.2 +++ b/epoc32/include/mw/http/framework/crxdata.h Wed Mar 31 12:27:01 2010 +0100
1.3 @@ -0,0 +1,127 @@
1.4 +// Copyright (c) 2001-2009 Nokia Corporation and/or its subsidiary(-ies).
1.5 +// All rights reserved.
1.6 +// This component and the accompanying materials are made available
1.7 +// 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
1.8 +// which accompanies this distribution, and is available
1.9 +// at the URL "http://www.symbianfoundation.org/legal/licencesv10.html".
1.10 +//
1.11 +// Initial Contributors:
1.12 +// Nokia Corporation - initial contribution.
1.13 +//
1.14 +// Contributors:
1.15 +//
1.16 +// Description:
1.17 +//
1.18 +
1.19 +
1.20 +
1.21 +/**
1.22 + @file CRxData.h
1.23 + @warning : This file contains Rose Model ID comments - please do not delete
1.24 +*/
1.25 +
1.26 +#ifndef __CRXDATA_H__
1.27 +#define __CRXDATA_H__
1.28 +
1.29 +// System includes
1.30 +#include <e32base.h>
1.31 +#include <http/framework/cprottransaction.h>
1.32 +#include <http/mhttpdatasupplier.h>
1.33 +#include <http/rhttpsession.h> // this include is needed to ensure that the <rhttp.inl> is compiled by gcc...
1.34 +
1.35 +// Forward declarations
1.36 +class MRxDataObserver;
1.37 +
1.38 +
1.39 +//##ModelId=3B1E52AB0087
1.40 +class CRxData : public CBase, public MHTTPDataSupplier
1.41 +/**
1.42 +An abstract base class for the decoding of response data received by a
1.43 +protocol handler.
1.44 +@publishedAll
1.45 +@released
1.46 +*/
1.47 + {
1.48 +public:
1.49 +
1.50 +/** Intended Usage: Destructor - cleans up and releases resources to the system
1.51 +*/
1.52 + IMPORT_C
1.53 + //##ModelId=3B1E52AB00ED
1.54 + virtual ~CRxData();
1.55 +
1.56 +/** Intended Usage: Obtain the protocol transaction whose request part is represented
1.57 + as encoded data by this object.
1.58 + @return The protocol transaction object
1.59 +*/
1.60 + IMPORT_C
1.61 + //##ModelId=3B1E52AB00EC
1.62 + CProtTransaction& ProtTrans();
1.63 +
1.64 +public:
1.65 +
1.66 +/** Intended Usage: Resets the received data object to its initial state following
1.67 + construction. This method must be implemented for specific sub-
1.68 + classes of received data.
1.69 + @post The object is reset.
1.70 +*/
1.71 + //##ModelId=3BA60048014B
1.72 + virtual void ResetRxData() = 0;
1.73 +
1.74 +protected:
1.75 +
1.76 +/** Intended Usage: Default constructor - creates an Rx data object not associated
1.77 + with any protocol transaction.
1.78 +*/
1.79 + IMPORT_C
1.80 + //##ModelId=3A914E5F008F
1.81 + CRxData();
1.82 +
1.83 +/** Intended Usage: Normal constructor, of a CRxData that corresponds to the supplied
1.84 + protocol transaction, and which sends status updates to the supplied
1.85 + observer interface,
1.86 + @param aProtTrans (in) The transaction for which this object
1.87 + represents the transmitted data.
1.88 + @param aObserver (in) The object's observer.
1.89 +*/
1.90 + IMPORT_C CRxData(CProtTransaction& aProtTrans, MRxDataObserver& aObserver);
1.91 +
1.92 +/** Intended Usage: Second phase construction, default
1.93 +*/
1.94 + IMPORT_C
1.95 + //##ModelId=3B1E52AB00BA
1.96 + void ConstructL();
1.97 +
1.98 +protected:
1.99 +
1.100 + /** The protocol transaction for which this object represents the encoded received data
1.101 + */
1.102 + //##ModelId=3B1E52AB00B2
1.103 + CProtTransaction* iProtTrans;
1.104 +
1.105 + /** This object's observer, to whom we forward status information
1.106 + */
1.107 + //##ModelId=3B1E7738028B
1.108 + MRxDataObserver* iObserver;
1.109 +
1.110 +private: // methods
1.111 +
1.112 +/** Intended Usage: Reserve a slot in the v-table to preserve future BC
1.113 + */
1.114 + //##ModelId=3C4C37DA0007
1.115 + inline virtual void Reserved1();
1.116 +
1.117 +/** Intended Usage: Reserve a slot in the v-table to preserve future BC
1.118 + */
1.119 + //##ModelId=3C4C37D903DB
1.120 + inline virtual void Reserved2();
1.121 + };
1.122 +
1.123 +
1.124 +inline void CRxData::Reserved1()
1.125 + {}
1.126 +inline void CRxData::Reserved2()
1.127 + {}
1.128 +
1.129 +
1.130 +#endif // __CRXDATA_H__