epoc32/include/mw/http/framework/rheaderfield.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 RHeaderField.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 __RHEADERFIELD_H__
williamr@2
    22
#define __RHEADERFIELD_H__
williamr@2
    23
williamr@2
    24
// System includes
williamr@2
    25
#include <e32base.h>
williamr@2
    26
#include <http/thttphdrval.h>
williamr@2
    27
#include <http/rhttppropertyset.h>
williamr@2
    28
#include <http/rhttpheaders.h>
williamr@2
    29
williamr@2
    30
// Forward declarations
williamr@2
    31
class CHeaderField;
williamr@2
    32
class THeaderFieldPartIter;
williamr@2
    33
williamr@2
    34
williamr@2
    35
/**
williamr@2
    36
The default chunk size for Raw data should be set to the average length of a header field when encoded in
williamr@2
    37
plaintext.
williamr@2
    38
@publishedAll
williamr@2
    39
@released
williamr@2
    40
*/
williamr@2
    41
const TInt KDefaultRawChunkSize= 32;
williamr@2
    42
williamr@2
    43
williamr@2
    44
//##ModelId=3B1E52A50396
williamr@2
    45
class RHeaderField
williamr@2
    46
/**
williamr@2
    47
An proxy object for a single field in an HTTP header.  The class is used by
williamr@2
    48
implementations of CHeaderCodec in order to manipulate the header at the part and
williamr@2
    49
parameter level, or to obtain raw data, during a header encode/decode operation.
williamr@2
    50
@publishedAll
williamr@2
    51
@released
williamr@2
    52
*/
williamr@2
    53
	{
williamr@2
    54
public: // methods
williamr@2
    55
williamr@2
    56
	//##ModelId=3BA6004002BC
williamr@2
    57
	RHeaderField(CHeaderField& aHeaderField);
williamr@2
    58
williamr@2
    59
	IMPORT_C
williamr@2
    60
	//##ModelId=3B1E52A503C0
williamr@2
    61
	RStringF Name() const;
williamr@2
    62
williamr@2
    63
	IMPORT_C
williamr@2
    64
	//##ModelId=3B1E52A503BF
williamr@2
    65
	THeaderFieldPartIter PartsL();
williamr@2
    66
williamr@2
    67
	IMPORT_C
williamr@2
    68
	//##ModelId=3B1E52A503B9
williamr@2
    69
	void RawDataL(TPtrC8& aRawData);
williamr@2
    70
williamr@2
    71
	IMPORT_C
williamr@2
    72
	//##ModelId=3BA6004002B2
williamr@2
    73
	RHTTPHeaders Collection();
williamr@2
    74
williamr@2
    75
	IMPORT_C
williamr@2
    76
	//##ModelId=3B1E52A503B6
williamr@2
    77
	void SetPartL(CHeaderFieldPart* aPart, TInt aIndex);
williamr@2
    78
williamr@2
    79
	IMPORT_C
williamr@2
    80
	//##ModelId=3B1E52A503B4
williamr@2
    81
	void BeginRawDataL(TInt aChunkSize = KDefaultRawChunkSize);
williamr@2
    82
williamr@2
    83
	IMPORT_C
williamr@2
    84
	//##ModelId=3B1E52A503AB
williamr@2
    85
	void WriteRawDataL(const TDesC8& aData);
williamr@2
    86
williamr@2
    87
	IMPORT_C
williamr@2
    88
	//##ModelId=3B1E52A503AD
williamr@2
    89
	void WriteRawDataL(TChar aData);
williamr@2
    90
williamr@2
    91
	IMPORT_C
williamr@2
    92
	//##ModelId=3B1E52A503AA
williamr@2
    93
	void CommitRawData();
williamr@2
    94
williamr@2
    95
private: // attributes
williamr@2
    96
williamr@2
    97
	/** The internal representation of this header field
williamr@2
    98
	*/
williamr@2
    99
	//##ModelId=3B1E52A503A2
williamr@2
   100
	CHeaderField& iHeaderField;
williamr@2
   101
};
williamr@2
   102
williamr@2
   103
inline RHeaderField::RHeaderField(CHeaderField& aHeaderField)
williamr@2
   104
	: iHeaderField(aHeaderField)
williamr@2
   105
	{
williamr@2
   106
	}
williamr@2
   107
williamr@2
   108
#endif // __CHEADERFIELD_H__