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