epoc32/include/mw/http/thttphdrfielditer.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@4
    17
 @file
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 __THTTPHDRFIELDITER_H__
williamr@2
    22
#define __THTTPHDRFIELDITER_H__
williamr@2
    23
williamr@2
    24
// System includes
williamr@2
    25
#include <e32std.h>
williamr@2
    26
#include <stringpool.h>
williamr@2
    27
williamr@2
    28
// Forward declarations
williamr@2
    29
class CHeaders;
williamr@2
    30
williamr@2
    31
williamr@2
    32
//##ModelId=3A914DFD005C
williamr@2
    33
class THTTPHdrFieldIter
williamr@2
    34
/** 
williamr@2
    35
Iterator class to iterate the fields within a RHTTPHeaders. 
williamr@2
    36
@publishedAll
williamr@2
    37
@released
williamr@2
    38
*/
williamr@2
    39
	{
williamr@2
    40
public:
williamr@2
    41
	/** Construct an iterator for the fields of the supplied header collection.
williamr@2
    42
		@param aHeaders The header collection whose fields we want to iterate
williamr@2
    43
	*/
williamr@2
    44
	//##ModelId=3A914DFD0087
williamr@2
    45
	THTTPHdrFieldIter(const CHeaders* aHeaders);
williamr@2
    46
	/** Class destructor
williamr@2
    47
	*/
williamr@2
    48
	//##ModelId=3A914DFD0086
williamr@2
    49
	IMPORT_C ~THTTPHdrFieldIter();
williamr@2
    50
williamr@2
    51
	/** Reset iterator to point at the first field in the header collection
williamr@2
    52
	*/
williamr@2
    53
	//##ModelId=3A914DFD0085
williamr@2
    54
	IMPORT_C void First();
williamr@2
    55
williamr@2
    56
	/** Check if the iterator is at the end of the collection. If so,
williamr@2
    57
	    further calls to operator() will return NULL.
williamr@2
    58
		@return True if the iterator has reached the end of the header
williamr@2
    59
		fields 
williamr@2
    60
	*/
williamr@2
    61
	//##ModelId=3A914DFD0084
williamr@2
    62
	IMPORT_C TBool AtEnd() const;
williamr@2
    63
williamr@2
    64
	/** Advance the iterator to the next field.
williamr@2
    65
		@return True if the iterator still points at a valid part
williamr@2
    66
		after advancing.
williamr@2
    67
	*/
williamr@2
    68
	//##ModelId=3A914DFD007E
williamr@2
    69
	IMPORT_C void operator++();
williamr@2
    70
williamr@2
    71
	/** Obtain the name of the header field currently pointed at by
williamr@2
    72
		the iterator.
williamr@2
    73
		@return The field name; or <empty string> if the iterator has
williamr@2
    74
		gone off the end of the header collection 
williamr@2
    75
	*/
williamr@2
    76
	//##ModelId=3A914DFD007D
williamr@2
    77
	IMPORT_C RStringTokenF operator()();
williamr@2
    78
williamr@2
    79
private:
williamr@2
    80
williamr@2
    81
	/** Check the iterator state for invalidity following deletions in the collection
williamr@2
    82
	*/
williamr@2
    83
	//##ModelId=3BA613240002
williamr@2
    84
	void CheckInvalidation();
williamr@2
    85
williamr@2
    86
	/** The headers whose fields we are iterating.
williamr@2
    87
	*/
williamr@2
    88
	//##ModelId=3A914DFD007A
williamr@2
    89
	const CHeaders* iHeaders;
williamr@2
    90
	/** The index of the field in the header that is currently pointed
williamr@2
    91
		at by the iterator
williamr@2
    92
	*/
williamr@2
    93
	//##ModelId=3A914DFD0072
williamr@2
    94
	TInt iPosIdx;
williamr@2
    95
	};
williamr@2
    96
williamr@2
    97
inline THTTPHdrFieldIter::THTTPHdrFieldIter(const CHeaders* aHeaders)
williamr@2
    98
	: iHeaders(aHeaders)
williamr@2
    99
	{
williamr@2
   100
	First();
williamr@2
   101
	}
williamr@2
   102
williamr@2
   103
williamr@2
   104
#endif // __THTTPHDRFIELDITER_H__