Symbian^3 Product Developer Library >

RCookieManager Class Reference

class RCookieManager : public RSessionBase

It is the client interface to the Cookie Server.

Inherits from

Nested Classes and Structures

Public Member Functions
RCookieManager(RStringPool)
IMPORT_C TIntClearAllAppUidCookies(const TUint32 &)
IMPORT_C TIntClearCookies(TInt &)
IMPORT_C voidClose()
IMPORT_C TIntConnect()
IMPORT_C voidGetCookiesL(const TDesC8 &, RPointerArray< CCookie > &, TBool &)
IMPORT_C voidGetCookiesL(const TDesC8 &, RPointerArray< CCookie > &, TBool &, TUint32 &)
IMPORT_C TIntSetAppUidL(const TUint32 &)
IMPORT_C TIntStoreCookie(const CCookie &, const TUriC8 &)
IMPORT_C TIntStoreCookie(const CCookie &, const TUriC8 &, TUint32 &)
Private Member Functions
TInt DestroyCookiesFromMemory(TInt &)
TInt DoGetCookieSize(const TDesC8 &, TPckg< TInt > &)
TInt DoGetCookieSize(const TDesC8 &, TPckg< TInt > &, TDesC &)
TInt DoGetCookies(TDes8 &)
TInt DoStoreCookie(const TDesC8 &, const TDesC8 &, TDesC &)
TInt GetClientSideCookies(const TDesC8 &, RPointerArray< CCookie > &, TBool &, TUint32)
TInt GetCookieSharableFlagFromServer(TBool &)
voidStoreCookieAtClientSide(const CCookie *, const TDesC8 &, TUint32)
TVersion Version()
Inherited Functions
RHandleBase::Attributes()const
RHandleBase::BTraceId()const
RHandleBase::DoExtendedClose()
RHandleBase::Duplicate(const RThread &,TOwnerType)
RHandleBase::FullName()const
RHandleBase::FullName(TDes &)const
RHandleBase::Handle()const
RHandleBase::HandleInfo(THandleInfo *)
RHandleBase::Name()const
RHandleBase::NotifyDestruction(TRequestStatus &)
RHandleBase::Open(const TFindHandleBase &,TOwnerType)
RHandleBase::OpenByName(const TDesC &,TOwnerType,TInt)
RHandleBase::RHandleBase()
RHandleBase::RHandleBase(TInt)
RHandleBase::SetHandle(TInt)
RHandleBase::SetHandleNC(TInt)
RSessionBase::CreateSession(RServer2,const TVersion &)
RSessionBase::CreateSession(RServer2,const TVersion &,TInt)
RSessionBase::CreateSession(RServer2,const TVersion &,TInt,TIpcSessionType,const TSecurityPolicy *,TRequestStatus *)
RSessionBase::CreateSession(const TDesC &,const TVersion &)
RSessionBase::CreateSession(const TDesC &,const TVersion &,TInt)
RSessionBase::CreateSession(const TDesC &,const TVersion &,TInt,TIpcSessionType,const TSecurityPolicy *,TRequestStatus *)
RSessionBase::CreateSession(const TDesC &,const TVersion &,TInt,TRequestStatus *)
RSessionBase::Open(RMessagePtr2,TInt,TOwnerType)
RSessionBase::Open(RMessagePtr2,TInt,const TSecurityPolicy &,TOwnerType)
RSessionBase::Open(TInt,TOwnerType)
RSessionBase::Open(TInt,const TSecurityPolicy &,TOwnerType)
RSessionBase::Send(TInt)const
RSessionBase::Send(TInt,const TIpcArgs &)const
RSessionBase::SendReceive(TInt)const
RSessionBase::SendReceive(TInt,TRequestStatus &)const
RSessionBase::SendReceive(TInt,const TIpcArgs &)const
RSessionBase::SendReceive(TInt,const TIpcArgs &,TRequestStatus &)const
RSessionBase::SetReturnedHandle(TInt)
RSessionBase::SetReturnedHandle(TInt,RHandleBase &)
RSessionBase::SetReturnedHandle(TInt,const TSecurityPolicy &)
RSessionBase::ShareAuto()
RSessionBase::ShareProtected()
Inherited Enumerations
RHandleBase:TAttributes
RSessionBase:TAttachMode
Private Attributes
TCookieMgrInternalStruct *iCookieMgrData
RStringPool iStringPool
Inherited Attributes
RHandleBase::iHandle

Constructor & Destructor Documentation

RCookieManager(RStringPool)

IMPORT_CRCookieManager(RStringPoolaStringPool)

Parameters

RStringPool aStringPool

Member Functions Documentation

ClearAllAppUidCookies(const TUint32 &)

IMPORT_C TIntClearAllAppUidCookies(const TUint32 &aAppUid)

Parameters

const TUint32 & aAppUid

ClearCookies(TInt &)

IMPORT_C TIntClearCookies(TInt &aDeletedCookies)

Clear all cookies.

Parameters

TInt & aDeletedCookiesOn return, it contains the number of deleted cookies.

Close()

IMPORT_C voidClose()

Connect()

IMPORT_C TIntConnect()

DestroyCookiesFromMemory(TInt &)

TInt DestroyCookiesFromMemory(TInt &aDeleteStatus)[private]

Parameters

TInt & aDeleteStatus

DoGetCookieSize(const TDesC8 &, TPckg< TInt > &)

TInt DoGetCookieSize(const TDesC8 &aRequestUri,
TPckg< TInt > &aPkgSize
)const [private]

Gets the sum of cookie sizes for a given request URI. After this method call there will be available the set of cookies on server-side that have been collected by the URI in question.

Parameters

const TDesC8 & aRequestUriThe HTTP transaction request's URI,
TPckg< TInt > & aPkgSize

DoGetCookieSize(const TDesC8 &, TPckg< TInt > &, TDesC &)

TInt DoGetCookieSize(const TDesC8 &aRequestUri,
TPckg< TInt > &aPkgSize,
TDesC &aAppUidPtr
)const [private]

Parameters

const TDesC8 & aRequestUri
TPckg< TInt > & aPkgSize
TDesC & aAppUidPtr

DoGetCookies(TDes8 &)

TInt DoGetCookies(TDes8 &aBuffer)const [private]

Puts those cookies in the buffer that have been previously selected on server-side as a result of the GetCookieSize method.

Parameters

TDes8 & aBufferBuffer to be filled with appropriate cookies.

DoStoreCookie(const TDesC8 &, const TDesC8 &, TDesC &)

TInt DoStoreCookie(const TDesC8 &aPackedCookie,
const TDesC8 &aUri,
TDesC &aAppUidPtr
)const [private]

Parameters

const TDesC8 & aPackedCookie
const TDesC8 & aUri
TDesC & aAppUidPtr

GetClientSideCookies(const TDesC8 &, RPointerArray< CCookie > &, TBool &, TUint32)

TInt GetClientSideCookies(const TDesC8 &aRequestUri,
RPointerArray< CCookie > &aCookies,
TBool &aFound,
TUint32aWidgetUid
)[private]

Parameters

const TDesC8 & aRequestUri
RPointerArray< CCookie > & aCookies
TBool & aFound
TUint32 aWidgetUid

GetCookieSharableFlagFromServer(TBool &)

TInt GetCookieSharableFlagFromServer(TBool &aCookieSharableFlag)const [private]

Parameters

TBool & aCookieSharableFlag

GetCookiesL(const TDesC8 &, RPointerArray< CCookie > &, TBool &)

IMPORT_C voidGetCookiesL(const TDesC8 &aUri,
RPointerArray< CCookie > &aCookies,
TBool &aCookie2Reqd
)

Get the relevant cookies for a transaction

Parameters

const TDesC8 & aUriThe URI of the current HTTP request.
RPointerArray< CCookie > & aCookies
TBool & aCookie2ReqdFlag indicating whether a Cookie2 header should be added to the outgoing request headers

GetCookiesL(const TDesC8 &, RPointerArray< CCookie > &, TBool &, TUint32 &)

IMPORT_C voidGetCookiesL(const TDesC8 &aUri,
RPointerArray< CCookie > &aCookies,
TBool &aCookie2Reqd,
TUint32 &aAppUid
)

Parameters

const TDesC8 & aUri
RPointerArray< CCookie > & aCookies
TBool & aCookie2Reqd
TUint32 & aAppUid

SetAppUidL(const TUint32 &)

IMPORT_C TIntSetAppUidL(const TUint32 &aAppUid)

Sets the AppUidL

Parameters

const TUint32 & aAppUidthe application UID.

StoreCookie(const CCookie &, const TUriC8 &)

IMPORT_C TIntStoreCookie(const CCookie &aCookie,
const TUriC8 &aUri
)

Store a cookie. This will get called with each cookie that is encountered in a transaction response.

Parameters

const CCookie & aCookieThe cookie to be stored. Ownership of aCookie is passed to this class.
const TUriC8 & aUriThe uri that sent this cookie. This is required to complete any missing attributes of the cookie and to ensure the cookie is valid.

StoreCookie(const CCookie &, const TUriC8 &, TUint32 &)

IMPORT_C TIntStoreCookie(const CCookie &aCookie,
const TUriC8 &aUri,
TUint32 &aAppUid
)

Parameters

const CCookie & aCookie
const TUriC8 & aUri
TUint32 & aAppUid

StoreCookieAtClientSide(const CCookie *, const TDesC8 &, TUint32)

voidStoreCookieAtClientSide(const CCookie *aCookie,
const TDesC8 &aUri,
TUint32aWidgetUid = 0
)[private]

Parameters

const CCookie * aCookie
const TDesC8 & aUri
TUint32 aWidgetUid = 0

Version()

TVersion Version()const [private]

Member Data Documentation

TCookieMgrInternalStruct * iCookieMgrData

TCookieMgrInternalStruct *iCookieMgrData[private]

RStringPool iStringPool

RStringPool iStringPool[private]

Copyright ©2010 Nokia Corporation and/or its subsidiary(-ies).
All rights reserved. Unless otherwise stated, these materials are provided under the terms of the Eclipse Public License v1.0.