epoc32/include/http/thttpfilterregistration.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 THTTPFilterRegistration.h
    20  @warning : This file contains Rose Model ID comments - please do not delete
    21 */
    22 
    23 #ifndef __THTTPFILTERREGISTRATION_H__
    24 #define __THTTPFILTERREGISTRATION_H__ 
    25 
    26 // System includes
    27 #include <e32std.h>
    28 #include <stringpool.h>
    29 #include <http/thttpevent.h>
    30 
    31 // Forward declarations
    32 class MHTTPFilter;
    33 
    34 
    35 //##ModelId=3C4C187D0188
    36 class THTTPFilterRegistration
    37 /** 
    38 A registration of a filter in the filter queue
    39 @publishedAll
    40 @released
    41 */
    42 	{
    43  public:
    44 	/// Default constructor
    45 	//##ModelId=3C4C187D020B
    46 	THTTPFilterRegistration();
    47 	/// Constructor
    48 	//##ModelId=3C4C187D0214
    49 	THTTPFilterRegistration(MHTTPFilter& aFilter, THTTPEvent aEvent,
    50 						RStringTokenF aHeader, TInt aStatusCode, 
    51 						TInt aPosition, RStringTokenF aName, TInt aHandle);
    52 	/// Equality operator
    53 	//##ModelId=3C4C187D0201
    54 	TBool operator==(THTTPFilterRegistration& aThat);
    55 	/// Inequality operator
    56 	//##ModelId=3C4C187D01F9
    57 	TBool operator!=(THTTPFilterRegistration& aThat);
    58 
    59  public:
    60 	/// The position
    61 	//##ModelId=3C4C187D01F6
    62 	TInt				iPosition; // This MUST be first!
    63 	/// The filter
    64 	//##ModelId=3C4C187D01E4
    65 	MHTTPFilter*		iFilter;
    66 	/// The event it's interested in (or any)
    67 	//##ModelId=3C4C187D01D8
    68 	THTTPEvent			iEvent;
    69 	/// The header it's interested in (or any)
    70 	//##ModelId=3C4C187D01C6
    71 	RStringTokenF	iHeader;
    72 	/// The status it's interested in (or any)
    73 	//##ModelId=3C4C187D01BC
    74 	TInt				iStatus;
    75 	/// The name of the filter
    76 	//##ModelId=3C4C187D01B2
    77 	RStringTokenF    iName;
    78 	/// The handle of the filter
    79 	//##ModelId=3C4C187D01A8
    80 	TInt                iHandle;
    81 	};
    82 
    83 inline THTTPFilterRegistration::THTTPFilterRegistration()
    84 		: iEvent(THTTPEvent::EAll)
    85 	{
    86 	}
    87 
    88 inline THTTPFilterRegistration::THTTPFilterRegistration(MHTTPFilter& aFilter, 
    89 														THTTPEvent aEvent,
    90 														RStringTokenF aHeader,
    91 														TInt aStatusCode, 
    92 														TInt aPosition,
    93 														RStringTokenF aName,
    94 														TInt aHandle)
    95 		:iPosition(aPosition), iFilter(&aFilter), iEvent(aEvent),
    96 	iHeader(aHeader), iStatus(aStatusCode) , iName(aName), iHandle(aHandle)
    97 	{
    98 	}
    99 
   100 
   101 
   102 #endif // __THTTPFILTERREGISTRATION_H__