RHttpDownloadMgr Class Reference

#include <mw/downloadmgrclient.h>

class RHttpDownloadMgr : public RSessionBase

Inherits from

RHttpDownloadMgr

Public Member Functions
	RHttpDownloadMgr()
IMPORT_C void	AddObserverL(MHttpDownloadMgrObserver &)
IMPORT_C void	Close()
IMPORT_C void	ConnectL(TUid, MHttpDownloadMgrObserver &, TBool)
IMPORT_C RHttpDownload &	CreateClientSideDownloadL(TInt, TBool &)
IMPORT_C RHttpDownload &	CreateCodDownloadL(const TDesC8 &, const TDesC8 &, const TDesC8 &, CEikonEnv *, TBool &)
IMPORT_C RHttpDownload &	CreateDownloadL(const TDesC8 &, TBool &)
IMPORT_C RHttpDownload &	CreateDownloadL(const TDesC8 &)
IMPORT_C const CDownloadArray &	CurrentDownloads()
IMPORT_C TInt	DeleteAll()
IMPORT_C TInt	Disconnect()
IMPORT_C RHttpDownload *	FindDownload(const TDesC8 &, const TDesC8 &)
IMPORT_C TInt	GetBoolAttribute(const TUint, TBool &)
IMPORT_C TInt	GetIntAttribute(const TUint, TInt32 &)
IMPORT_C TInt	GetStringAttribute(const TUint, TDes16 &)
IMPORT_C TInt	GetStringAttribute(const TUint, TDes8 &)
TBool	IsNewDownloadPossible()
IMPORT_C TInt	PauseAll()
IMPORT_C void	RemoveObserver(MHttpDownloadMgrObserver &)
IMPORT_C TInt	ResetAll()
IMPORT_C TInt	SetBoolAttribute(const TUint, TBool)
IMPORT_C TInt	SetDefaultBoolAttribute(const TUint, TBool)
IMPORT_C TInt	SetDefaultIntAttribute(const TUint, TInt32)
IMPORT_C TInt	SetDefaultStringAttribute(const TUint, const TDesC16 &)
IMPORT_C TInt	SetDefaultStringAttribute(const TUint, const TDesC8 &)
IMPORT_C TInt	SetIntAttribute(const TUint, TInt32)
IMPORT_C void	SetNextUriObserver(MHttpDownloadMgrNextUriObserver *)
IMPORT_C TInt	SetStringAttribute(const TUint, const TDesC16 &)
IMPORT_C TInt	SetStringAttribute(const TUint, const TDesC8 &)
IMPORT_C TInt	StartAll()
IMPORT_C TVersion	Version()

Protected Member Functions
RHttpDownload &	AddToArrayL(RHttpDownload *)
void	HandleDMgrEventL(RHttpDownload &, THttpDownloadEvent)

Inherited Attributes
	RHandleBase::iHandle

Inherited Enumerations
	RHandleBase:TAttributes
	RSessionBase:TAttachMode

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()

Detailed Description

Creates a download manager session and performs operations on it

Since: Series 60 2.8

Constructor & Destructor Documentation

RHttpDownloadMgr ( )

IMPORT_C

RHttpDownloadMgr

(

)

C++ default constructor.

Member Function Documentation

AddObserverL ( MHttpDownloadMgrObserver & )

IMPORT_C void

AddObserverL

(

MHttpDownloadMgrObserver &

aObserver

)

Adds client to the observer list.

Parameter	Description
aObserver	Observer.

Returns: None.

AddToArrayL ( RHttpDownload * )

RHttpDownload &

AddToArrayL

(

RHttpDownload *

aElement

)

[protected]

Adds the created download to the list. If it is already added, then it will do nothing.

Parameter	Description
aElement	Download subsession.

Returns: RHttpDownload& reference to the added item in the list.

Close ( )

IMPORT_C void

(

)

Reimplemented from RHandleBase::Close()

Closes download manager session.

Returns: None.

ConnectL ( TUid, MHttpDownloadMgrObserver &, TBool )

IMPORT_C void	ConnectL	(	TUid	aAppUid,
			MHttpDownloadMgrObserver &	aObserver,
			TBool	aMaster
		)

Creates a download manager session.

Parameter	Description
aAppUid	Client application's UID.
aObserver	Observer
aMaster	Indicates whether (if ETrue) this instance inherints all downloads of other instances. (stand-alone app flag).

Returns: None.

CreateClientSideDownloadL ( TInt, TBool & )

IMPORT_C RHttpDownload &	CreateClientSideDownloadL	(	TInt	aHttpTransaction,
			TBool &	aResult
		)

Creates a new download in client side.

Parameter	Description
aHttpTransaction	http transaction.
aResult	The result is true if the download is created. If the URL is already being downloaded the seult is false.

CreateCodDownloadL ( const TDesC8 &, const TDesC8 &, const TDesC8 &, CEikonEnv *, TBool & )

IMPORT_C RHttpDownload &	CreateCodDownloadL	(	const TDesC8 &	aUrl,
			const TDesC8 &	aBuf,
			const TDesC8 &	aMimeType,
			CEikonEnv *	aEikEnv,
			TBool &	aResult
		)

Creates a new download subsession for COD.

Parameter	Description
aUrl	The url from the COD is downloaded.
aBuf	The COD descriptor.
aMimeType	The mimetype.
aEikEnv	Eikon environment or NULL. Can be NULL if download does not require UI functionality.
aResult	The result is true if the download is created. If the URL is already being downloaded the seult is false.

Returns: RHttpDownload&

CreateDownloadL ( const TDesC8 &, TBool & )

IMPORT_C RHttpDownload &	CreateDownloadL	(	const TDesC8 &	aUrl,
			TBool &	aResult
		)

Creates a new download subsession.

Parameter	Description
aUrl	The url to be downloaded.
aResult	The result is true if the download is created. If the URL is already being downloaded the seult is false.

Returns: RHttpDownload&

CreateDownloadL ( const TDesC8 & )

IMPORT_C RHttpDownload &

CreateDownloadL

(

const TDesC8 &

aUrl

)

Creates a new download subsession. It creates a new one even if the URL is already beeing downloaded.

Parameter	Description
aUrl	The url to be downloaded. If the URL is already being downloaded the seult is false.

Returns: RHttpDownload&

CurrentDownloads ( )

IMPORT_C const CDownloadArray &

CurrentDownloads

(

)

const

Returns a list of the current downloads.

Returns: CDownloadArray

DeleteAll ( )

IMPORT_C TInt

DeleteAll

(

)

Deletes all downloads.

Returns: None.

Disconnect ( )

IMPORT_C TInt

Disconnect

(

)

Disconnect the http connection and pauses all downloads.

Returns: None.

FindDownload ( const TDesC8 &, const TDesC8 & )

IMPORT_C RHttpDownload *	FindDownload	(	const TDesC8 &	aUrl,
			const TDesC8 &	aMsgBody
		)

Finds if the download is already created

Since: 2.8

Parameter	Description
aUrl	given URL
aMsgBody	Message body from post operation

Returns: Returns a pointer to the found download or null. This pointer is NOT owned by the client!

GetBoolAttribute ( const TUint, TBool & )

IMPORT_C TInt	GetBoolAttribute	(	const TUint	aAttribute,
			TBool &	aValue
		)

Gets the value for a TBool attribute.

Parameter	Description
aAttribute	Identifies the attribute to be retrived.
aValue	On completion, contains the requested TBool attribute.

Returns: None.

GetIntAttribute ( const TUint, TInt32 & )

IMPORT_C TInt	GetIntAttribute	(	const TUint	aAttribute,
			TInt32 &	aValue
		)

Gets the value for a TInt attribute.

Parameter	Description
aAttribute	Identifies the attribute to be retrived.
aValue	On completion, contains the requested TInt attribute.

Returns: None.

GetStringAttribute ( const TUint, TDes16 & )

IMPORT_C TInt	GetStringAttribute	(	const TUint	aAttribute,
			TDes16 &	aValue
		)

Gets the value for a TDes16 attribute.

Parameter	Description
aAttribute	Identifies the attribute to be retrived.
aValue	On completion, contains the requested TDes16 attribute.

Returns: None.

GetStringAttribute ( const TUint, TDes8 & )

IMPORT_C TInt	GetStringAttribute	(	const TUint	aAttribute,
			TDes8 &	aValue
		)

Gets the value for a TDes8 attribute.

Parameter	Description
aAttribute	Identifies the attribute to be retrived.
aValue	On completion, contains the requested TDes8 attribute.

Returns: None.

HandleDMgrEventL ( RHttpDownload &, THttpDownloadEvent )

void	HandleDMgrEventL	(	RHttpDownload &	aDownload,
			THttpDownloadEvent	aEvent
		)	[protected]

Indicates an event.

Parameter	Description
aDownload	The download with which the event occured.
aEvent	Event type.

Returns: None.

IsNewDownloadPossible ( )

TBool

IsNewDownloadPossible

(

)

Checks for possibility of a new donload

Returns: TBool,possibility of a new download.

PauseAll ( )

IMPORT_C TInt

PauseAll

(

)

Pauses all downloads.

Returns: None.

RemoveObserver ( MHttpDownloadMgrObserver & )

IMPORT_C void

RemoveObserver

(

MHttpDownloadMgrObserver &

aObserver

)

Removes client from the observer list.

Parameter	Description
aObserver	Observer.

Returns: None.

ResetAll ( )

IMPORT_C TInt

ResetAll

(

)

Resets all downloads.

Returns: None.

SetBoolAttribute ( const TUint, TBool )

IMPORT_C TInt	SetBoolAttribute	(	const TUint	aAttribute,
			TBool	aValue
		)

Sets the value for a TBool attribute.

Parameter	Description
aAttribute	Identifies the attribute to be set.
aValue	The value to be set.

Returns: None.

SetDefaultBoolAttribute ( const TUint, TBool )

IMPORT_C TInt	SetDefaultBoolAttribute	(	const TUint	aAttribute,
			TBool	aValue
		)

Sets the value for the default TBool attribute.

Parameter	Description
aAttribute	Identifies the attribute to be set.
aValue	The value to be set.

Returns: None.

SetDefaultIntAttribute ( const TUint, TInt32 )

IMPORT_C TInt	SetDefaultIntAttribute	(	const TUint	aAttribute,
			TInt32	aValue
		)

Sets the value for the default TInt attribute.

Parameter	Description
aAttribute	Identifies the attribute to be set.
aValue	The value to be set.

Returns: None.

SetDefaultStringAttribute ( const TUint, const TDesC16 & )

IMPORT_C TInt	SetDefaultStringAttribute	(	const TUint	aAttribute,
			const TDesC16 &	aValue
		)

Sets the value for the default TDesC attribute.

Parameter	Description
aAttribute	Identifies the attribute to be set.
aValue	The value to be set.

Returns: None.

SetDefaultStringAttribute ( const TUint, const TDesC8 & )

IMPORT_C TInt	SetDefaultStringAttribute	(	const TUint	aAttribute,
			const TDesC8 &	aValue
		)

Sets the value for the default TDesC8 attribute.

Parameter	Description
aAttribute	Identifies the attribute to be set.
aValue	The value to be set.

Returns: None.

SetIntAttribute ( const TUint, TInt32 )

IMPORT_C TInt	SetIntAttribute	(	const TUint	aAttribute,
			TInt32	aValue
		)

Sets the value for a TInt attribute.

Parameter	Description
aAttribute	Identifies the attribute to be set.
aValue	The value to be set.

Returns: None.

SetNextUriObserver ( MHttpDownloadMgrNextUriObserver * )

IMPORT_C void

SetNextUriObserver

(

MHttpDownloadMgrNextUriObserver *

aObserver

)

Set next uri observer.

Parameter	Description
aObserver	Observer.

Returns: None.

SetStringAttribute ( const TUint, const TDesC16 & )

IMPORT_C TInt	SetStringAttribute	(	const TUint	aAttribute,
			const TDesC16 &	aValue
		)

Sets the value for a TDesC attribute.

Parameter	Description
aAttribute	Identifies the attribute to be set.
aValue	The value to be set.

Returns: None.

SetStringAttribute ( const TUint, const TDesC8 & )

IMPORT_C TInt	SetStringAttribute	(	const TUint	aAttribute,
			const TDesC8 &	aValue
		)

Sets the value for a TDesC8 attribute.

Parameter	Description
aAttribute	Identifies the attribute to be set.
aValue	The value to be set.

Returns: None.

StartAll ( )

IMPORT_C TInt

StartAll

(

)

Resumes all downloads.

Returns: None.

Version ( )

IMPORT_C TVersion

Version

(

)

const

Gives version information.

Returns: TVersion Contains version information.