Collapse all Symbian^3 Product Developer Library

CHTTPSession Class Reference

class CHTTPSession : public CBase

Inherits from

CHTTPSession
- CBase

Public Member Functions
	~CHTTPSession()
void	AddTransactionL(CTransaction *)
void	Block()
TBool	CanAddFilters()
CHeaderCodec *	Codec()
RHTTPConnectionInfo	ConnectionInfo()
void	CreateProtocolHandlerL()
void	FailSessionEvent(THTTPFilterHandle)
TFilterConfigurationIterator *	FilterConfigIterator()
RArray< THTTPFilterRegistration > &	FilterQueue()
const RArray< THTTPFilterRegistration > &	FilterQueue()
TInt	FindTransaction(CTransaction *)
RHTTPSession	Handle()
MHttpDataOptimiser *	HttpDataOptimiser()
TBool	IsBlocking()
void	ListAvailableProtocolsL(RPointerArray< HBufC8 > &)
CHTTPManager &	Manager()
const CHTTPManager &	Manager()
CHTTPSession *	NewL()
CHTTPSession *	NewL(const TDesC8 &)
CHTTPSession *	NewL(const TDesC8 &, MHTTPFilterCreationCallback *)
TInt	NextFilterHandle()
TInt	NextTransactionID()
void	RemoveTransaction(CTransaction *)
RHTTPHeaders	RequestSessionHeadersL()
RHTTPHeaders	ResponseSessionHeadersL()
void	SendSessionEventL(THTTPSessionEvent, THTTPSessionEvent::TDirection, THTTPFilterHandle)
TInt	SessionServerCert(TCertInfo &)
const CCertificate *	SessionServerCert()
void	SetSessionEventCallback(MHTTPSessionEventCallback *)
void	SetupDefaultProxyFromCommsDatL()
void	SetupHttpDataOptimiser(MHttpDataOptimiser &)
void	TransactionHasBlocked()
TInt	TransactionServerCert(TCertInfo &, RHTTPTransaction)
const CCertificate *	TransactionServerCert(RHTTPTransaction)
void	Unblock()

Private Member Functions
	CHTTPSession()
void	CleanListImplementationArray(TAny *)
void	ConstructL(const TDesC8 &, MHTTPFilterCreationCallback *)
void	CreateProtocolHandlerL(const TDesC8 &)
void	InitializeFiltersL(const TDesC8 &)

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

Private Member Enumerations
enum	TBlockingStates { ENormal = 0, EShouldBlock, EHasBlocked }

Private Attributes
TBlockingStates	iBlockingState
TClientFilter	iClientFilter
CHeaderFieldPart *	iConnectionInfo
TDummyTransactionCallback	iDummyTransactionCallback
RImplInfoPtrArray	iEComFilterInfoArray
TFilterConfigurationIterator *	iFilterConfigIter
RPointerArray< TSessionFilterInfo >	iFilterInfoList
RArray< THTTPFilterRegistration >	iFilterQueue
__DECLARE_PERFORMANCE_LOG MHttpDataOptimiser *	iHttpDataOptimiser
CHTTPManager *	iManager
TInt	iNextFilterHandle
CProtocolHandler *	iProtocolHandler
CHeaders *	iRequestSessionHeaders
CHeaders *	iResponseSessionHeaders
TBool	iSessionClosing
CTransaction *	iSessionEventTransaction
TInt	iTransCount
RArray< CTransaction * >	iTransactions

Constructor & Destructor Documentation

CHTTPSession()

CHTTPSession

(

)

[private]

~CHTTPSession()

~CHTTPSession

(

)

Member Functions Documentation

AddTransactionL(CTransaction *)

void

AddTransactionL

(

CTransaction *

aTransaction

)

Parameters

CTransaction * aTransaction

Block()

void

Block

(

)

[inline]

CanAddFilters()

TBool

CanAddFilters

(

)

const [inline]

CleanListImplementationArray(TAny *)

void

CleanListImplementationArray

(

TAny *

aArray

)

[private, static]

Parameters

TAny * aArray

Codec()

CHeaderCodec *

Codec

(

)

const [inline]

ConnectionInfo()

RHTTPConnectionInfo

ConnectionInfo

(

)

const [inline]

ConstructL(const TDesC8 &, MHTTPFilterCreationCallback *)

void	ConstructL	(	const TDesC8 &	aProtocol,
			MHTTPFilterCreationCallback *	aSessionCallback
		)	[private]

Parameters

const TDesC8 & aProtocol
MHTTPFilterCreationCallback * aSessionCallback

CreateProtocolHandlerL()

void

CreateProtocolHandlerL

(

)

CreateProtocolHandlerL(const TDesC8 &)

void

CreateProtocolHandlerL

(

const TDesC8 &

aProtocol

)

[private]

Parameters

const TDesC8 & aProtocol

FailSessionEvent(THTTPFilterHandle)

void

FailSessionEvent

(

THTTPFilterHandle

aStart = THTTPFilterHandle::EClient

)

Parameters

THTTPFilterHandle aStart = THTTPFilterHandle::EClient

FilterConfigIterator()

TFilterConfigurationIterator *

FilterConfigIterator

(

)

const

FilterQueue()

RArray< THTTPFilterRegistration > &

FilterQueue

(

)

[inline]

FilterQueue()

const RArray< THTTPFilterRegistration > &

FilterQueue

(

)

const [inline]

FindTransaction(CTransaction *)

TInt

FindTransaction

(

CTransaction *

aTransaction

)

[inline]

Parameters

CTransaction * aTransaction

Handle()

RHTTPSession

Handle

(

)

[inline]

HttpDataOptimiser()

MHttpDataOptimiser *

HttpDataOptimiser

(

)

InitializeFiltersL(const TDesC8 &)

void

InitializeFiltersL

(

const TDesC8 &

aProtocol

)

[private]

Parameters

const TDesC8 & aProtocol

IsBlocking()

TBool

IsBlocking

(

)

const [inline]

When 1 transaction runs, the session is blocked using the Block function. It is unblocked at the end with the Unblock function.

If a transaction has run, it must block, and must inform the session of this by calling TransactionHasBlocked

If at least 1 transaction has blocked then when Unblock is called on the session, CTransaction::Unblock will be called on all the transactions. Any transaction that had blocked must then unblock and other transactions must do nothing.

The purpose of this implementation is to be as simple as possible, especialy in terms of storage, but to minimise the ammount of extra code that gets executed in the normal case (when no transactions fire while the session is blocked). This is why the session does not remember which transactions have blocked (which would add complex storage requirements) but it does remember if any have (meaning that all transactions don't need to be unblocked in the normal case)

ListAvailableProtocolsL(RPointerArray< HBufC8 > &)

void

ListAvailableProtocolsL

(

RPointerArray< HBufC8 > &

aProtocolArray

)

[static]

This methods lists all of the available protocols on the device. These are identified by using the list of protocol handler plugins discovered by ECom and appending the data type descriptors to the array. Any existing data in the array is deleted.

Parameters

RPointerArray< HBufC8 > & aProtocolArray

Manager()

CHTTPManager &

Manager

(

)

[inline]

Manager()

const CHTTPManager &

Manager

(

)

const [inline]

NewL()

CHTTPSession *

NewL

(

)

[static]

NewL(const TDesC8 &)

CHTTPSession *

NewL

(

const TDesC8 &

aProtocol

)

[static]

Parameters

const TDesC8 & aProtocol

NewL(const TDesC8 &, MHTTPFilterCreationCallback *)

CHTTPSession *	NewL	(	const TDesC8 &	aProtocol,
			MHTTPFilterCreationCallback *	aSessionCallback
		)	[static]

Constructs a session that allows filter configuration. This requires the callback interface of MHTTPFilterCreationCallback that is called during construction, so the client can determine the filters that are installed.

Parameters

const TDesC8 & aProtocol
MHTTPFilterCreationCallback * aSessionCallback

NextFilterHandle()

TInt

NextFilterHandle

(

)

[inline]

NextTransactionID()

TInt

NextTransactionID

(

)

[inline]

RemoveTransaction(CTransaction *)

void

RemoveTransaction

(

CTransaction *

aTransaction

)

Parameters

CTransaction * aTransaction

RequestSessionHeadersL()

RHTTPHeaders

RequestSessionHeadersL

(

)

Returns the request session headers. This will create the protocol handler if it doesn't already exist

leave: Leaves if protocol handler doesn't exist and fails to be created

ResponseSessionHeadersL()

RHTTPHeaders

ResponseSessionHeadersL

(

)

Returns the response session headers. This will create the protocol handler if it doesn't already exist

leave: KErrNoMemory if attempt to allocate memory fails

SendSessionEventL(THTTPSessionEvent, THTTPSessionEvent::TDirection, THTTPFilterHandle)

void	SendSessionEventL	(	THTTPSessionEvent	aStatus,
			THTTPSessionEvent::TDirection	aDirection,
			THTTPFilterHandle	aStart = THTTPFilterHandle::EClient
		)

Parameters

THTTPSessionEvent aStatus
THTTPSessionEvent::TDirection aDirection
THTTPFilterHandle aStart = THTTPFilterHandle::EClient

SessionServerCert(TCertInfo &)

TInt

SessionServerCert

(

TCertInfo &

aServerCert

)

[inline]

Get the Server Certificate for this session.

Parameters

TCertInfo & aServerCert

A TCertInfo which will be filled with the certificate information

SessionServerCert()

const CCertificate *

SessionServerCert

(

)

[inline]

Get the Server Certificate for the current session.

SetSessionEventCallback(MHTTPSessionEventCallback *)

void

SetSessionEventCallback

(

MHTTPSessionEventCallback *

aSessionEventCallback

)

Parameters

MHTTPSessionEventCallback * aSessionEventCallback

SetupDefaultProxyFromCommsDatL()

void

SetupDefaultProxyFromCommsDatL

(

)

Get the default IAP from CommsDat. For this IAP retrieve Sevrice Id & Service Type. Using these retrieve the default proxy server name & port number. Add these to the properties set of current Http session.

SetupHttpDataOptimiser(MHttpDataOptimiser &)

void

SetupHttpDataOptimiser

(

MHttpDataOptimiser &

aHttpOptimiser

)

Parameters

MHttpDataOptimiser & aHttpOptimiser

TransactionHasBlocked()

void

TransactionHasBlocked

(

)

[inline]

TransactionServerCert(TCertInfo &, RHTTPTransaction)

TInt	TransactionServerCert	(	TCertInfo &	aServerCert,
			RHTTPTransaction	aTransaction
		)	[inline]

Get the Server Certificate for the specified transaction.

Parameters

TCertInfo & aServerCert	A TCertInfo which will be filled with the certificate information
RHTTPTransaction aTransaction	The transaction for which the certificate is requested