Collapse all Symbian^3 Product Developer Library

CHttpTransferWorker Class Reference

class CHttpTransferWorker : public CBase

Virtual base class for CHttpDowloadWorker and CHttpUploadWorker.

httptransfer.lib

Since: S60 v3.2

Inherits from

CHttpTransferWorker
- CBase

Public Member Functions
	~CHttpTransferWorker()
void	CancelTransfer()
void	ConnectL()
TBool	IsWaiting()
TAny *	Key()
TInt	MHFRunError(TInt, RHTTPTransaction, const THTTPEvent &)
void	MHFRunL(RHTTPTransaction, const THTTPEvent &)
const HBufC *	Path()
TBool	ProcessOnGoing()
CHttpFile *	ProcessedFile()
void	SetFileL(CHttpFile &)
void	SetHeaderL(RHTTPHeaders, TInt, const TDesC8 &)
void	SetHeaderL(RHTTPHeaders, const TDesC8 &, const TDesC8 &)
void	StartProcessL()
void	TimerCallback()
void	TrackProgress(TBool)
const HBufC8 *	Uri()

Protected Member Functions
void	ConstructL()

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

Public Member Enumerations
enum	THttpWorkerState { EHttpWaitingForStart, EHttpGetSent, EHttpPostSent, EHttpGetResponseReceived, EHttpTransactionIdle, EHttpTransactionCanceled }

Protected Attributes
TInt	iBufferSize
MHttpWorkerObserver *	iCallback
CUpnpConnectionManagerProxy *	iConnectionManagerProxy
RFile	iFile
HBufC *	iFileName
RFs	iFsSession
RHTTPTransaction	iHttpTransaction
MHttpTransferObserver *	iObserver
THttpWorkerState	iProcessState
CHttpFile *	iProcessedFile
RHTTPSession	iSession
RSocketServ	iSocketServer
RStringPool	iStringPool
CHttpTransferTimer *	iTimer

Constructor & Destructor Documentation

~CHttpTransferWorker()

~CHttpTransferWorker

(

)

[virtual]

Virtual destructor

Since: S60 v3.2

Member Functions Documentation

CancelTransfer()

void

CancelTransfer

(

)

[pure virtual]

Stops the transfer of the file

Since: S60 v3.2

ConnectL()

void

ConnectL

(

)

Connects the HTTP session

Since: S60 v3.2

ConstructL()

void

ConstructL

(

)

[protected]

Second phase constructor

Since: S60 v3.2

IsWaiting()

TBool

IsWaiting

(

)

const

Returns information if the worker is waiting for start

Since: S60 v3.2

Key()

TAny *

Key

(

)

const

Getter for key value of the processed file.

Since: S60 v3.2

MHFRunError(TInt, RHTTPTransaction, const THTTPEvent &)

TInt	MHFRunError	(	TInt	aError,
			RHTTPTransaction	aTransaction,
			const THTTPEvent &	aEvent
		)	[pure virtual]

Called by framework when leave occurs in handling of transaction event.

Since: S60 v3.2

Parameters

TInt aError	The leave code that occured.
RHTTPTransaction aTransaction	The transaction that was being processed
const THTTPEvent & aEvent	The event that was being processed

MHFRunL(RHTTPTransaction, const THTTPEvent &)

void	MHFRunL	(	RHTTPTransaction	aTransaction,
			const THTTPEvent &	aEvent
		)	[pure virtual]

Called by framework to notify about transaction events.

Since: S60 v3.2

Parameters

RHTTPTransaction aTransaction	Transaction, where the event occured.
const THTTPEvent & aEvent	Occured event.

Path()

const HBufC *

Path

(

)

const

Getter for Path

Since: S60 v3.2

ProcessOnGoing()

TBool

ProcessOnGoing

(

)

const

Returns information if the process is on-going

Since: S60 v3.2

ProcessedFile()

CHttpFile *

ProcessedFile

(

)

Returns a reference to the processed file. Returns NULL if the processed file is not set.

Since: S60 v3.2

SetFileL(CHttpFile &)

void

SetFileL

(

CHttpFile &

aFile

)

Sets file which should be transfered.

Since: S60 v3.2

Parameters

CHttpFile & aFile

New file

SetHeaderL(RHTTPHeaders, TInt, const TDesC8 &)

void	SetHeaderL	(	RHTTPHeaders	aHeaders,
			TInt	aHdrField,
			const TDesC8 &	aHdrValue
		)

Sets headers

Since: S60 v3.2

Parameters

RHTTPHeaders aHeaders	Header
TInt aHdrField	The field of the header
const TDesC8 & aHdrValue	Value of the header

SetHeaderL(RHTTPHeaders, const TDesC8 &, const TDesC8 &)

void	SetHeaderL	(	RHTTPHeaders	aHeaders,
			const TDesC8 &	aHdrField,
			const TDesC8 &	aHdrValue
		)

Sets headers

Since: S60 v3.2

Parameters

RHTTPHeaders aHeaders	Header
const TDesC8 & aHdrField	The field of the header
const TDesC8 & aHdrValue	Value of the header

StartProcessL()

void

StartProcessL

(

)

[virtual]

Starts the processing of a file. Asynchronous.

Since: S60 v3.2

TimerCallback()

void

TimerCallback

(

)

Call back for the timer

Since: S60 v3.2

TrackProgress(TBool)

void

TrackProgress

(

TBool

aValue

)

Sets tracking flag of the processed file to the value of the aValue attribute.

Since: S60 v3.2

Parameters

TBool aValue

New value

Uri()

const HBufC8 *

Uri

(

)

const

Getter for Uri

Since: S60 v3.2

Member Enumerations Documentation

Enum THttpWorkerState

State machine

Since: S60 v3.2

Enumerators

EHttpWaitingForStart
EHttpGetSent
EHttpPostSent
EHttpGetResponseReceived
EHttpTransactionIdle
EHttpTransactionCanceled

Member Data Documentation

TInt iBufferSize

TInt

iBufferSize

[protected]

Buffer size

MHttpWorkerObserver * iCallback

MHttpWorkerObserver *

iCallback

[protected]

Worker observer Not own.

CUpnpConnectionManagerProxy * iConnectionManagerProxy

CUpnpConnectionManagerProxy *

iConnectionManagerProxy

[protected]

Connection

RFile iFile

RFile

iFile

[protected]

File

HBufC * iFileName

HBufC *

iFileName

[protected]

Filename Own.

RFs iFsSession

RFs

iFsSession

[protected]

Handle to the file server session

RHTTPTransaction iHttpTransaction

RHTTPTransaction

iHttpTransaction

[protected]

A HTTP Transaction. This encapsulates 1 HTTP request and response. A Transaction is associated with a session, and must be created using the session's CreateTransactionL method.