RHTTPTransaction in Application Protocols HTTP

class RHTTPTransaction;

Description

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.

Members

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

Description

Default (uninitialised) constructor

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

Description

Submits a transaction. Once all the headers and other details have been set up, this call actualy causes the request to be made.

Parameters


                              THTTPFilterHandle aStart

Leave codes

KErrNoMemory

There was not enough memory.

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

Description

Notify HTTP of the availability of more request body data, when submitting body data in several parts.

Parameters


                              THTTPFilterHandle aStart

The filter supplying the new data. This will almost always be the client (default value)

Leave codes

KErrNoMemory

There was not enough memory.

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

Description

Sends a status message to all relevant filters. This function is predominantly used by filters, rather than by the client.

Parameters

`THTTPEvent aStatus`	The status message to send.
`THTTPEvent::TDirection aDirection`	The direction down the filter queue that this event will be propogated.
`THTTPFilterHandle aStart`

Leave codes

KErrNoMemory

There was not enough memory.

IMPORT_C RHTTPResponse Response() const;

Description

Gets the response. Note that the returned response may not be valid if it hasn't been created yet.

Return value

RHTTPResponse

IMPORT_C RHTTPRequest Request() const;

Description

Gets the request.

Return value

RHTTPRequest

IMPORT_C RHTTPSession Session() const;

Description

Returns the session associated with the transaction.

Return value

RHTTPSession

IMPORT_C RHTTPTransactionPropertySet PropertySet() const;

Description

Returns the transaction's property set. This is used by filters to store transaction-specific information, and by clients to specify things like reload or no cache behaviour.

Return value

RHTTPTransactionPropertySet

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

Description

Cancels the transaction.

Parameters


                              THTTPFilterHandle aStart

The entity that is initiating the cancel (defaults to the client). See THTTPFilterHandle for the values this can take.

IMPORT_C void Close();

Description

Closes the transaction and frees all owned resources. Transactions must be opened using RHTTPSession::OpenTransactionL. It is also closed when you close the session.

IMPORT_C 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. For instance in 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() may be used to 'give up'.

Parameters


                              THTTPFilterHandle aStart

inline TBool operator==(RHTTPTransaction aTrans) const;

Description

Equality operator to check if this transaction is the same as that one.

Parameters


                              RHTTPTransaction aTrans

The transaction to compare this one to.

Return value


                              TBool

inline TBool operator!=(RHTTPTransaction aTrans) const;

Description

Inequality operator

Parameters


                              RHTTPTransaction aTrans

The transaction to compare this one to.

Return value


                              TBool

IMPORT_C TInt Id() const;

Description

Obtain this transaction's ID, which is unique within its session. This is mostly used for producing a slightly-meaningful way of identifying transactions in logging code.

Return value

TInt

The transaction ID.

IMPORT_C TInt ServerCert(TCertInfo &aServerCert);

Description

Obtain the server certificate information for this transaction. This function should only be used for text-mode, for WSP use RHttpSession::ServerCert.

Parameters


                              TCertInfo &aServerCert

A client supplied object into which the certificate information will be placed.

Return value

TInt

KErrNone if certificate has been completed, KErrNotSupported if this function is called for WSP.

IMPORT_C RString CipherSuite();

Description

Obtain the cipher suite information for this transaction.

Return value

RString

RString containing the cipher suite as per RFC2246.

Class RHTTPTransaction

Description

Members

See also:

Construction and destruction