epoc32/include/http/framework/crxdata.h
branchSymbian2
changeset 2 2fe1408b6811
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/epoc32/include/http/framework/crxdata.h	Tue Mar 16 16:12:26 2010 +0000
@@ -0,0 +1,127 @@
+// Copyright (c) 2001-2009 Nokia Corporation and/or its subsidiary(-ies).
+// All rights reserved.
+// This component and the accompanying materials are made available
+// 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
+// which accompanies this distribution, and is available
+// at the URL "http://www.symbianfoundation.org/legal/licencesv10.html".
+//
+// Initial Contributors:
+// Nokia Corporation - initial contribution.
+//
+// Contributors:
+//
+// Description:
+//
+
+
+
+/**
+ @file CRxData.h
+ @warning : This file contains Rose Model ID comments - please do not delete
+*/
+
+#ifndef __CRXDATA_H__
+#define __CRXDATA_H__
+
+// System includes
+#include <e32base.h>
+#include <http/framework/cprottransaction.h>
+#include <http/mhttpdatasupplier.h>
+#include <http/rhttpsession.h> // this include is needed to ensure that the <rhttp.inl> is compiled by gcc...
+
+// Forward declarations
+class MRxDataObserver;
+
+
+//##ModelId=3B1E52AB0087
+class CRxData : public CBase, public MHTTPDataSupplier
+/**
+An abstract base class for the decoding of response data received by a
+protocol handler.
+@publishedAll
+@released
+*/
+	{
+public:
+
+/** Intended Usage:	Destructor - cleans up and releases resources to the system	
+*/
+	IMPORT_C
+	//##ModelId=3B1E52AB00ED
+	virtual ~CRxData();
+
+/** Intended Usage:	Obtain the protocol transaction whose request part is represented
+					as encoded data by this object.
+	@return The protocol transaction object
+*/
+	IMPORT_C
+	//##ModelId=3B1E52AB00EC
+	CProtTransaction& ProtTrans();
+
+public:
+
+/** Intended Usage:	Resets the received data object to its initial state following
+					construction.  This method must be implemented for specific sub-
+					classes of received data.
+	@post			The object is reset.
+*/
+	//##ModelId=3BA60048014B
+	virtual void ResetRxData() = 0;
+
+protected:
+
+/** Intended Usage:	Default constructor	- creates an Rx data object not associated
+					with any protocol transaction.
+*/
+	IMPORT_C
+	//##ModelId=3A914E5F008F
+	CRxData();
+
+/** Intended Usage:	Normal constructor, of a CRxData that corresponds to the supplied
+					protocol transaction, and which sends status updates to the supplied
+					observer interface,
+	@param			aProtTrans			(in) The transaction for which this object
+											 represents the transmitted data.
+	@param			aObserver			(in) The object's observer.
+*/
+	IMPORT_C CRxData(CProtTransaction& aProtTrans, MRxDataObserver& aObserver);
+
+/** Intended Usage:	Second phase construction, default
+*/
+	IMPORT_C
+	//##ModelId=3B1E52AB00BA
+	void ConstructL();
+
+protected:
+
+	/** The protocol transaction for which this object represents the encoded received data
+	*/
+	//##ModelId=3B1E52AB00B2
+	CProtTransaction* iProtTrans;
+
+	/** This object's observer, to whom we forward status information
+	*/
+	//##ModelId=3B1E7738028B
+	MRxDataObserver* iObserver;
+
+private: // methods
+
+/**	Intended Usage:	Reserve a slot in the v-table to preserve future BC
+ */
+	//##ModelId=3C4C37DA0007
+	inline virtual void Reserved1();
+
+/**	Intended Usage:	Reserve a slot in the v-table to preserve future BC
+ */
+	//##ModelId=3C4C37D903DB
+	inline virtual void Reserved2();
+	};
+
+
+inline void CRxData::Reserved1()
+	{}
+inline void CRxData::Reserved2()
+	{}
+
+
+#endif // __CRXDATA_H__