Class CCookieFilterInterface

class CCookieFilterInterface

Support

Supported from 7.0

Description

The ECom interface definition for an HTTP cookie filter.

A cookie filter responds to any events in the Transport Framework for which cookie support may be required. If it finds cookies in a response, it passes them to the cookie manager, and as requests are submitted it asks the cookie manager for the cookies to be added.

A client uses this interface to install a cookie filter for a transport session, and to specify the cookie manager to handle the storage and retrieval of cookies.

Implementations of a cookie filter must inherit this class.

Derivation

CBase Base class for all classes to be instantiated on the heap CCookieFilterInterface The ECom interface definition for an HTTP cookie filter

Defined in CCookieFilterInterface:
InstallFilterL(), TCookieFilterParams, iEcomDtorID, ~CCookieFilterInterface()

Inherited from CBase:
operator new()

inline static void InstallFilterL(RHTTPSession& aSession, MHttpCookieManager* aCallback);

Description

Installs the cookie filter to the transport framework's filter queue.

Parameters

RHTTPSession& aSession A handle to the client's transport session MHttpCookieManager* aCallback A pointer to a cookie manager supplied by the client

~CCookieFilterInterface();

Description

Destructor.

struct TCookieFilterParams

Description

Encapsulates the cookie filter initiation parameters passed by the client in InstallFilterL().

Defined in CCookieFilterInterface::TCookieFilterParams:
iCallback, iSession

---

iSession

RHTTPSession* iSession;

Description

A handle to the client's transport session.

---

iCallback

MHttpCookieManager* iCallback;

Description

A pointer to a cookie manager supplied by the client.

private: TUid iEcomDtorID;

Description

This member is internal and not intended for use.