epoc32/include/mw/http/framework/rheaderfield.h
branchSymbian2
changeset 3 e1b950c65cb4
parent 2 2fe1408b6811
child 4 837f303aceeb
     1.1 --- /dev/null	Thu Jan 01 00:00:00 1970 +0000
     1.2 +++ b/epoc32/include/mw/http/framework/rheaderfield.h	Wed Mar 31 12:27:01 2010 +0100
     1.3 @@ -0,0 +1,110 @@
     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 RHeaderField.h
    1.23 + @warning : This file contains Rose Model ID comments - please do not delete
    1.24 +*/
    1.25 +
    1.26 +#ifndef __RHEADERFIELD_H__
    1.27 +#define __RHEADERFIELD_H__
    1.28 +
    1.29 +// System includes
    1.30 +#include <e32base.h>
    1.31 +#include <http/thttphdrval.h>
    1.32 +#include <http/rhttppropertyset.h>
    1.33 +#include <http/rhttpheaders.h>
    1.34 +
    1.35 +// Forward declarations
    1.36 +class CHeaderField;
    1.37 +class THeaderFieldPartIter;
    1.38 +
    1.39 +
    1.40 +/**
    1.41 +The default chunk size for Raw data should be set to the average length of a header field when encoded in
    1.42 +plaintext.
    1.43 +@publishedAll
    1.44 +@released
    1.45 +*/
    1.46 +const TInt KDefaultRawChunkSize= 32;
    1.47 +
    1.48 +
    1.49 +//##ModelId=3B1E52A50396
    1.50 +class RHeaderField
    1.51 +/**
    1.52 +An proxy object for a single field in an HTTP header.  The class is used by
    1.53 +implementations of CHeaderCodec in order to manipulate the header at the part and
    1.54 +parameter level, or to obtain raw data, during a header encode/decode operation.
    1.55 +@publishedAll
    1.56 +@released
    1.57 +*/
    1.58 +	{
    1.59 +public: // methods
    1.60 +
    1.61 +	//##ModelId=3BA6004002BC
    1.62 +	RHeaderField(CHeaderField& aHeaderField);
    1.63 +
    1.64 +	IMPORT_C
    1.65 +	//##ModelId=3B1E52A503C0
    1.66 +	RStringF Name() const;
    1.67 +
    1.68 +	IMPORT_C
    1.69 +	//##ModelId=3B1E52A503BF
    1.70 +	THeaderFieldPartIter PartsL();
    1.71 +
    1.72 +	IMPORT_C
    1.73 +	//##ModelId=3B1E52A503B9
    1.74 +	void RawDataL(TPtrC8& aRawData);
    1.75 +
    1.76 +	IMPORT_C
    1.77 +	//##ModelId=3BA6004002B2
    1.78 +	RHTTPHeaders Collection();
    1.79 +
    1.80 +	IMPORT_C
    1.81 +	//##ModelId=3B1E52A503B6
    1.82 +	void SetPartL(CHeaderFieldPart* aPart, TInt aIndex);
    1.83 +
    1.84 +	IMPORT_C
    1.85 +	//##ModelId=3B1E52A503B4
    1.86 +	void BeginRawDataL(TInt aChunkSize = KDefaultRawChunkSize);
    1.87 +
    1.88 +	IMPORT_C
    1.89 +	//##ModelId=3B1E52A503AB
    1.90 +	void WriteRawDataL(const TDesC8& aData);
    1.91 +
    1.92 +	IMPORT_C
    1.93 +	//##ModelId=3B1E52A503AD
    1.94 +	void WriteRawDataL(TChar aData);
    1.95 +
    1.96 +	IMPORT_C
    1.97 +	//##ModelId=3B1E52A503AA
    1.98 +	void CommitRawData();
    1.99 +
   1.100 +private: // attributes
   1.101 +
   1.102 +	/** The internal representation of this header field
   1.103 +	*/
   1.104 +	//##ModelId=3B1E52A503A2
   1.105 +	CHeaderField& iHeaderField;
   1.106 +};
   1.107 +
   1.108 +inline RHeaderField::RHeaderField(CHeaderField& aHeaderField)
   1.109 +	: iHeaderField(aHeaderField)
   1.110 +	{
   1.111 +	}
   1.112 +
   1.113 +#endif // __CHEADERFIELD_H__