epoc32/include/http/rhttpfiltercollection.h
author William Roberts <williamr@symbian.org>
Tue, 16 Mar 2010 16:12:26 +0000
branchSymbian2
changeset 2 2fe1408b6811
parent 0 061f57f2323e
permissions -rw-r--r--
Final list of Symbian^2 public API header files
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@2
     4
// 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
williamr@2
     5
// which accompanies this distribution, and is available
williamr@2
     6
// at the URL "http://www.symbianfoundation.org/legal/licencesv10.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
williamr@2
    18
/**
williamr@2
    19
 @file RHTTPFilterCollection.h
williamr@2
    20
 @warning : This file contains Rose Model ID comments - please do not delete
williamr@2
    21
*/
williamr@2
    22
williamr@2
    23
#ifndef	__RHTTPFILTERCOLLECTION_H__
williamr@2
    24
#define	__RHTTPFILTERCOLLECTION_H__ 
williamr@2
    25
williamr@2
    26
// System includes
williamr@2
    27
#include <e32std.h>
williamr@2
    28
#include <http/thttpevent.h>
williamr@2
    29
#include <stringpool.h>
williamr@2
    30
williamr@2
    31
// Forward declarations
williamr@2
    32
class CHTTPSession;
williamr@2
    33
class RHTTPSession;
williamr@2
    34
class MHTTPFilter;
williamr@2
    35
class THTTPFilterIterator;
williamr@2
    36
williamr@2
    37
williamr@2
    38
//##ModelId=3C4C187C02B3
williamr@2
    39
class RHTTPFilterCollection
williamr@2
    40
/** 
williamr@2
    41
A Handle on the filter collection in a session. It provides
williamr@2
    42
facilities for adding and deleting filters and for querying what
williamr@2
    43
filters are installed. 
williamr@2
    44
@publishedAll
williamr@2
    45
@released
williamr@2
    46
@see RHTTPSession::FilterCollection 
williamr@2
    47
@see MHTTPFilter::TPositions
williamr@2
    48
*/
williamr@2
    49
	{
williamr@2
    50
 public:
williamr@2
    51
	//##ModelId=3C4C187C02F9
williamr@2
    52
	inline RHTTPFilterCollection();
williamr@2
    53
williamr@2
    54
	//##ModelId=3C4C187C02E5
williamr@2
    55
	IMPORT_C void AddFilterL(MHTTPFilter& aFilter, THTTPEvent aEvent,
williamr@2
    56
							 RStringF aHeader, TInt aStatusCode, 
williamr@2
    57
 							 TInt aPosition, RStringF aName);
williamr@2
    58
williamr@2
    59
williamr@2
    60
	//##ModelId=3C4C187C02F1
williamr@2
    61
	IMPORT_C void AddFilterL(MHTTPFilter& aFilter, THTTPEvent aEvent, 
williamr@2
    62
 							 TInt aPosition, RStringF aName);
williamr@2
    63
williamr@2
    64
	//##ModelId=3C4C187C02DF
williamr@2
    65
	IMPORT_C TBool CanChangeFilters() const;
williamr@2
    66
williamr@2
    67
	//##ModelId=3C4C187C02DD
williamr@2
    68
	IMPORT_C void RemoveFilter(RStringF aFilter);
williamr@2
    69
williamr@2
    70
	//##ModelId=3C4C187C02DB
williamr@2
    71
	IMPORT_C THTTPFilterIterator Query(RStringF aName = RStringF());
williamr@2
    72
williamr@2
    73
	//##ModelId=3C4C187C02D1
williamr@2
    74
	inline RHTTPSession Session() const;
williamr@2
    75
williamr@2
    76
 private:
williamr@2
    77
	friend class CHTTPSession;
williamr@2
    78
	friend class RHTTPSession;
williamr@2
    79
williamr@2
    80
	//##ModelId=3C4C187C02C9
williamr@2
    81
	CHTTPSession* iImplementation;
williamr@2
    82
	};
williamr@2
    83
williamr@2
    84
/** Constructor
williamr@2
    85
  */
williamr@2
    86
inline RHTTPFilterCollection::RHTTPFilterCollection()
williamr@2
    87
		: iImplementation(NULL)
williamr@2
    88
	{
williamr@2
    89
	}
williamr@2
    90
williamr@2
    91
#endif //	__RHTTPFILTERCOLLECTION_H__