epoc32/include/http/thttpfilterhandle.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 THTTPFilterHandle.h
    20  @warning : This file contains Rose Model ID comments - please do not delete
    21 */
    22 
    23 #ifndef	__THTTPFILTERHANDLE_H__
    24 #define	__THTTPFILTERHANDLE_H__
    25 
    26 // System includes
    27 #include <e32std.h>
    28 
    29 
    30 //##ModelId=3A914DF50317
    31 class THTTPFilterHandle
    32 /** 
    33 A Filter registration handle. This identifies a particular filter
    34 registration, and is passed to the filter in MHFLoad. It is used
    35 to identify filters for deletion and for locating the start point
    36 for sending events. It is an opaque class; all you need to be able
    37 to do with it is to compare them for equality.
    38 @publishedAll
    39 @released
    40 */
    41 	{
    42  public:
    43 	/* Note. These are negative as values for particular filters use
    44        positive values.*/
    45 	/** Alisases for the client, and the filters you're most likely to want
    46 		to refer to.
    47 	*/
    48 	enum TStandardValues
    49 		{
    50 		EUndefined = 0, ///< Undefined default value.
    51 		EClient = -1, ///< Placeholder for the client.
    52 		EProtocolHandler = -2, ///< Constant value for the protocol handler.
    53 		/// When sending an event from a MHFRunL, indicates the current filter.
    54 		ECurrentFilter = -3 
    55 		};
    56  public:
    57 	//##ModelId=3A914DF50336
    58 	inline THTTPFilterHandle(TStandardValues aVal = EUndefined);
    59 	//##ModelId=3A914DF5032D
    60 	inline TBool operator==(THTTPFilterHandle aThat) const;
    61 	//##ModelId=3A914DF5032B
    62 	inline TBool operator!=(THTTPFilterHandle aThat) const;
    63  private:
    64 	//##ModelId=3A914DF50323
    65 	TInt iValue;
    66 	friend class RHTTPSession;
    67 	friend class RHTTPFilterCollection;
    68 	friend class CHTTPSession;
    69 	friend class CTransaction;
    70 	};  
    71 
    72 inline THTTPFilterHandle::THTTPFilterHandle(TStandardValues aVal)
    73 		: iValue(aVal)
    74 	{
    75 	}
    76 
    77 inline TBool THTTPFilterHandle::operator==(THTTPFilterHandle aThat) const
    78 	{
    79 	return iValue == aThat.iValue;
    80 	}
    81 
    82 inline TBool THTTPFilterHandle::operator!=(THTTPFilterHandle aThat) const
    83 	{
    84 	return !(*this == aThat);
    85 	}
    86 
    87 
    88 #endif // __THTTPFILTERHANDLE_H__