epoc32/include/http/mhttpfiltercreationcallback.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 MHTTPFilterCreationCallback.h
    20  @warning : This file contains Rose Model ID comments - please do not delete
    21 */
    22 
    23 #ifndef __MHTTPFILTERCREATIONCALLBACK_H__
    24 #define __MHTTPFILTERCREATIONCALLBACK_H__
    25 
    26 // Forward declarations
    27 class TFilterConfigurationIterator;
    28 
    29 
    30 //##ModelId=3C4C0F450132
    31 class MHTTPFilterCreationCallback
    32 /**
    33 This class serves as a pure virtual interface required as a session callback to the client
    34 when the client requires to configure the filters that are installed. The session calls the
    35 method in the interface when the construction of the session is complete. The callback passes
    36 an object of CFilterConfigurationIterator that allows the client to configure the filters that
    37 are installed.
    38 @publishedAll
    39 @released
    40 */
    41 	{
    42 public: // Methods
    43 	/**
    44 	@fn				ConfigureSessionFiltersL(TFilterConfigurationIterator* aFilterConfigIter) = 0
    45 	Intended Usage:	Pure virtual that is called by the session when the session construction
    46 					is complete. This passes a CFilterConfigurationIterator back to the client
    47 					which allows the client to install or install selected filters.
    48 	@param			aFilterConfigIter Pointer to the filter configuration iterator. Ownership of
    49 					CFilterConfigurationIterator remains with the session and is not transfered
    50 	@pre 			The session has been constructed
    51 	@post			The filters that are installed are have been configured by the client
    52 	*/
    53 	//##ModelId=3C4C0F450150
    54 	virtual void ConfigureSessionFiltersL(TFilterConfigurationIterator* aFilterConfigIter) = 0;
    55 	};
    56 
    57 #endif // __MHTTPFILTERCREATIONCALLBACK_H__