Symbian
 Developer Library

DEVELOPER LIBRARY

[Index] [Glossary] [Previous] [Next]



Location: mhttpcookiemanager.h

Class MHttpCookieManager

class MHttpCookieManager

Support

Supported from 7.0

Description

Cookie manager abstract interface.

The 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 cookie manager is created, and owned, by the client using HTTP. The client specifies the manager to use when it installs the cookie filter with CCookieFilterInterface::InstallFilterL().

Defined in MHttpCookieManager:
GetCookiesL(), StoreCookieL()


Member functions


StoreCookieL()

virtual void StoreCookieL(CCookie* aCookie, const TUriC8& aUri)=0;

Description

Stores a cookie.

This function is called for each cookie that is encountered in a transaction response

Parameters

CCookie* aCookie

The cookie to store

const TUriC8& aUri

The URI of the request that supplied this cookie. This is required so that the manager can complete any missing attributes of the cookie.

Leave codes

Standard Symbian OS leave codes


GetCookiesL()

virtual void GetCookiesL(RHTTPTransaction aTransaction, RArray<CCookie*>& aCookieList, TBool& aCookie2Reqd)=0;

Description

Gets the relevant cookies for a transaction.

Parameters

RHTTPTransaction aTransaction

The transaction for which cookies are requested

RArray<CCookie*>& aCookieList

An array that, on return, is filled with the cookies for aTransaction. The array should be empty when this function is called.

TBool& aCookie2Reqd

Flag indicating whether a Cookie2 header should be added to the outgoing request headers

Leave codes

Standard Symbian OS leave codes