CAuthenticationFilterInterface Class Reference

#include <mw/http/cauthenticationfilterinterface.h>

Link against: xcaphttptransport.lib

class CAuthenticationFilterInterface : public CBase

Inherits from

CAuthenticationFilterInterface

Nested Classes and Structures

CAuthenticationFilterInterface::TAuthenticationParams

Public Member Functions
	~CAuthenticationFilterInterface()
void	InstallFilterL(RHTTPSession &, MHTTPAuthenticationCallback *)

Inherited Functions
	CBase::CBase()
	CBase::Delete(CBase *)
	CBase::Extension_(TUint,TAny &,TAny )
	CBase::operator new(TUint)
	CBase::operator new(TUint,TAny *)
	CBase::operator new(TUint,TLeave)
	CBase::operator new(TUint,TLeave,TUint)
	CBase::operator new(TUint,TUint)
	CBase::~CBase()

Detailed Description

The ECOM interface definition for an HTTP authentication filter. Implementations of an authentication filter must inherit this class.

Constructor & Destructor Documentation

~CAuthenticationFilterInterface ( )

~CAuthenticationFilterInterface

(

)

[inline]

Intended Usage: Virtual destructor

Pre-condition: The object identified by the destructor key in iEcomDtorID exists

Post-condition: The object is destroyed

Member Function Documentation

InstallFilterL ( RHTTPSession &, MHTTPAuthenticationCallback * )

void	InstallFilterL	(	RHTTPSession &	aSession,
			MHTTPAuthenticationCallback *	aCallback
		)	[static, inline]

Intended Usage: This method is used to install the authentication filter to the filter queue. The returned pointer is not owned as the filters must be self-destroying when they are unloaded.

Pre-condition: The session had already been setup

Post-condition: The filter(s) have been installed

Parameter	Description
aSession	A handle to the transport session
aCallback	A pointer to the object implementing the callback function

Returns: Pointer to the newly installed plugin