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
     1 // Copyright (c) 2001-2009 Nokia Corporation and/or its subsidiary(-ies).
     2 // All rights reserved.
     3 // This component and the accompanying materials are made available
     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
     5 // which accompanies this distribution, and is available
     6 // at the URL "http://www.symbianfoundation.org/legal/licencesv10.html".
     7 //
     8 // Initial Contributors:
     9 // Nokia Corporation - initial contribution.
    10 //
    11 // Contributors:
    12 //
    13 // Description:
    14 //
    15 
    16 
    17 
    18 /**
    19  @file RHTTPFilterCollection.h
    20  @warning : This file contains Rose Model ID comments - please do not delete
    21 */
    22 
    23 #ifndef	__RHTTPFILTERCOLLECTION_H__
    24 #define	__RHTTPFILTERCOLLECTION_H__ 
    25 
    26 // System includes
    27 #include <e32std.h>
    28 #include <http/thttpevent.h>
    29 #include <stringpool.h>
    30 
    31 // Forward declarations
    32 class CHTTPSession;
    33 class RHTTPSession;
    34 class MHTTPFilter;
    35 class THTTPFilterIterator;
    36 
    37 
    38 //##ModelId=3C4C187C02B3
    39 class RHTTPFilterCollection
    40 /** 
    41 A Handle on the filter collection in a session. It provides
    42 facilities for adding and deleting filters and for querying what
    43 filters are installed. 
    44 @publishedAll
    45 @released
    46 @see RHTTPSession::FilterCollection 
    47 @see MHTTPFilter::TPositions
    48 */
    49 	{
    50  public:
    51 	//##ModelId=3C4C187C02F9
    52 	inline RHTTPFilterCollection();
    53 
    54 	//##ModelId=3C4C187C02E5
    55 	IMPORT_C void AddFilterL(MHTTPFilter& aFilter, THTTPEvent aEvent,
    56 							 RStringF aHeader, TInt aStatusCode, 
    57  							 TInt aPosition, RStringF aName);
    58 
    59 
    60 	//##ModelId=3C4C187C02F1
    61 	IMPORT_C void AddFilterL(MHTTPFilter& aFilter, THTTPEvent aEvent, 
    62  							 TInt aPosition, RStringF aName);
    63 
    64 	//##ModelId=3C4C187C02DF
    65 	IMPORT_C TBool CanChangeFilters() const;
    66 
    67 	//##ModelId=3C4C187C02DD
    68 	IMPORT_C void RemoveFilter(RStringF aFilter);
    69 
    70 	//##ModelId=3C4C187C02DB
    71 	IMPORT_C THTTPFilterIterator Query(RStringF aName = RStringF());
    72 
    73 	//##ModelId=3C4C187C02D1
    74 	inline RHTTPSession Session() const;
    75 
    76  private:
    77 	friend class CHTTPSession;
    78 	friend class RHTTPSession;
    79 
    80 	//##ModelId=3C4C187C02C9
    81 	CHTTPSession* iImplementation;
    82 	};
    83 
    84 /** Constructor
    85   */
    86 inline RHTTPFilterCollection::RHTTPFilterCollection()
    87 		: iImplementation(NULL)
    88 	{
    89 	}
    90 
    91 #endif //	__RHTTPFILTERCOLLECTION_H__