Collapse all Symbian^3 Application Developer Library

CUpnpHttpServerTransaction Class Reference

class CUpnpHttpServerTransaction : public CBase

Base abstract class for HTTP server transactions. Client has to derive from this class to implement required behavior.

dlnawebserver.lib

Since: S60 5.1

Inherits from

CUpnpHttpServerTransaction
- CBase

Public Member Functions
	~CUpnpHttpServerTransaction ()
IMPORT_C void	AddResponseHeaderL (const TDesC8 &, const TDesC8 &)
RFile &	DataSink ()
RFile &	DataSource ()
IMPORT_C TInt	Error ()
void	OnCallbackL ( TUpnpHttpServerEvent )
IMPORT_C TDesC8 &	QueryRequestHeader (const TDesC8 &)
IMPORT_C const TDesC8 &	QueryResponseHeader ()
IMPORT_C void	SetRequest (CUpnpHttpMessage *)

Protected Member Functions
	CUpnpHttpServerTransaction ()
IMPORT_C void	SetDataSinkL ( RFile &)
IMPORT_C void	SetDataSourceL ( RFile &)
IMPORT_C void	SetHttpCode ( TInt )

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	TUpnpHttpServerEvent { EOnRequestStart = 0, EOnResponseStart , EOnComplete }

Private Attributes
RFile	iFile
RBuf8	iHeaderBuffer
TInt	iHttpCode
CUpnpHttpMessage *	iRequest

Constructor & Destructor Documentation

CUpnpHttpServerTransaction()

IMPORT_C

CUpnpHttpServerTransaction

(

)

[protected]

C++ constructor.

~CUpnpHttpServerTransaction()

IMPORT_C

~CUpnpHttpServerTransaction

(

)

Destructor.

Member Functions Documentation

AddResponseHeaderL(const TDesC8 &, const TDesC8 &)

IMPORT_C void	AddResponseHeaderL	(	const TDesC8 &	aName,
			const TDesC8 &	aValue
		)

Adds pair : name - value to response header To add HTTP method and HTTP code, pass it as aValue parameter and as aName pass KNullDesC8.

Since: S60 5.1

Parameters

const TDesC8 & aName	header name
const TDesC8 & aValue	header value

DataSink()

RFile &

DataSink

(

)

DataSource()

RFile &

DataSource

(

)

Error()

IMPORT_C TInt

Error

(

)

OnCallbackL(TUpnpHttpServerEvent)

void

OnCallbackL

(

TUpnpHttpServerEvent

aEvent

)

[pure virtual]

Handler for transaction event.

Since: S60 5.1

Parameters

TUpnpHttpServerEvent aEvent

server event

QueryRequestHeader(const TDesC8 &)

IMPORT_C TDesC8 &

QueryRequestHeader

(

const TDesC8 &

aHeaderName

)

Returns request header value. When header not found, returns KNullDesC8.

Since: S60 5.1

Parameters

const TDesC8 & aHeaderName

header name

QueryResponseHeader()

IMPORT_C const TDesC8 &

QueryResponseHeader

(

)

Returns response header buffer.

Since: S60 5.1

SetDataSinkL(RFile &)

IMPORT_C void

SetDataSinkL

(

RFile &

aFile

)

[protected]

Sets data sink.

Since: S60 5.1

Parameters

RFile & aFile

File handle, may not be on cleanupstack

SetDataSourceL(RFile &)

IMPORT_C void

SetDataSourceL

(

RFile &

aFile

)

[protected]

Sets data source.

Since: S60 5.1

Parameters

RFile & aFile

File handle, may not be on cleanupstack

SetHttpCode(TInt)

IMPORT_C void

SetHttpCode

(

TInt

aCode

)

[protected]

Sets http code.

Since: S60 5.1

Parameters

TInt aCode

http code

SetRequest(CUpnpHttpMessage *)

IMPORT_C void

SetRequest

(

CUpnpHttpMessage *

aRequest

)

Parameters

CUpnpHttpMessage * aRequest

Member Enumerations Documentation

Enum TUpnpHttpServerEvent

Http Event type enumerator

Enumerators

EOnRequestStart = 0
EOnResponseStart
EOnComplete

Member Data Documentation

RFile iFile

RFile

iFile

[private]

RBuf8 iHeaderBuffer

RBuf8

iHeaderBuffer

[private]

TInt iHttpCode

TInt

iHttpCode

[private]

CUpnpHttpMessage * iRequest

CUpnpHttpMessage *

iRequest

[private]