Class RHTTPTransaction

class RHTTPTransaction

Support

Supported from 7.0

Description

A transport framework transaction.

A transaction encapsulates a request and a response. It is associated with a session, and must be created using RHTTPSession::OpenTransactionL().

Defined in RHTTPTransaction:
Cancel(), Close(), Fail(), Id(), NotifyNewRequestBodyPartL(), PropertySet(), RHTTPTransaction(), Request(), Response(), SendEventL(), ServerCert(), Session(), SubmitL(), iImplementation, operator!=(), operator==()

See also:

• RHTTPSession
• RHTTPSession::OpenTransactionL()

inline RHTTPTransaction();

Description

Default (uninitialised) constructor.

void SubmitL(THTTPFilterHandle aStart=THTTPFilterHandle::EClient);

Description

Submits a transaction.

After the headers and other details have been set up, use this function to make the request.

Parameters

Leave codes

void NotifyNewRequestBodyPartL(THTTPFilterHandle aStart=THTTPFilterHandle::EClient);

Description

Notifies the framework of the availability of more request body data.

This is used when submitting body data in several parts.

Parameters

Leave codes

void SendEventL(THTTPEvent aStatus, THTTPEvent::TDirection aDirection, THTTPFilterHandle aStart);

Description

Sends an event to all relevant filters.

This function is predominantly used by filters, rather than by the client.

Parameters

Leave codes

RHTTPResponse Response() const;

Description

Gets the transaction response.

Note that the returned response may not be valid if it has not been created yet.

Return value

RHTTPRequest Request() const;

Description

Gets the transaction request.

Return value

RHTTPSession Session() const;

Description

Gets the transport framework session in use.

Return value

RHTTPTransactionPropertySet PropertySet() const;

Description

Gets the transaction's property set.

This is used by filters to store transaction-specific information, and by clients to specify properties such as reload or no cache behaviour.

Return value

void Cancel(THTTPFilterHandle aStart=THTTPFilterHandle::EClient);

Description

Cancels the transaction.

Parameters

void Close();

Description

Closes the transaction and frees all owned resources.

Transactions must be opened using RHTTPSession::OpenTransactionL().

Transactions are also closed when you close their session.

void Fail(THTTPFilterHandle aStart=THTTPFilterHandle::ECurrentFilter);

Description

This function should be called by filters when they have failed due to running out of memory.

It cancels the transaction and sends the synchronous events EUnrecoverableError and EFailed to the client to inform it of the failure.

An example use would be a filter that attempts to send an event to the client from a MHFRunError() to inform the client of a failure, if the call to SendEventL() leaves, Fail() can be used to abort.

Parameters

TBool operator ==(RHTTPTransaction aTrans) const;

Description

Equality operator.

Parameters

Return value

TBool operator !=(RHTTPTransaction aTrans) const;

Description

Inequality operator.

Parameters

Return value

TInt Id() const;

Description

Gets this transaction's ID, which is unique within its session.

This is mostly used to identify transactions in logging code.

Return value

TInt ServerCert(TCertInfo& aServerCert);

Description

Obtains the server certificate information for this transaction.

This function should only be used for HTTP. For WSP, use RHttpSession::ServerCert().

Parameters

Return value

Description

This is internal and not intended for use.

private: CTransaction* iImplementation;

Description

This is internal and not intended for use.