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