THTTPEvent in Application Protocols HTTP

class THTTPEvent;

Description

A HTTP status message. Status messages consist of a UID and a status code within that UID. Extension dlls that needs to create new status messages should use their own UID and create status codes within that UID.

Members

Defined in THTTPEvent:
EAll, EAnySessionEvent, EAnyTransactionEvent, ECancel, EClosed, EFailed, EGetCipherSuite, EGotResponseBodyData, EGotResponseHeaders, EGotResponseTrailerHeaders, EIncoming, EMoreDataReceivedThanExpected, ENeedTunnel, ENotifyNewRequestBodyPart, EOutgoing, ERedirectRequiresConfirmation, ERedirectedPermanently, ERedirectedTemporarily, ERequestComplete, EResponseComplete, ESubmit, ESucceeded, ETooMuchRequestData, EUnrecoverableError, IsSessionEvent(), TDirection, THTTPEvent(), THTTPEvent(), THTTPEvent(), TStandardEvent, TTransactionEvent, TTransactionWarning, iIsSessionEventFlag, iStatus, iUID, operator!=(), operator!=(), operator!=(), operator=(), operator=(), operator==(), operator==(), operator==()

inline THTTPEvent(TInt aStatus, TUint aUID=KHTTPUid);

Description

Constructor

Parameters

`TInt aStatus`	The status value.
`TUint aUID`	The UID.

inline THTTPEvent(TStandardEvent aStatus=EAnyTransactionEvent);

Description

Constructor (using a standard event and the HTTP UID)

Parameters


                              TStandardEvent aStatus

The standard event to use.

inline THTTPEvent(TTransactionEvent aStatus);

Description

Constructor (using a transaction event and the HTTP UID)

Parameters


                              TTransactionEvent aStatus

The transaction event to use.

inline THTTPEvent &operator=(TStandardEvent aStatus);

Description

Assigns a standard event code to an event object

Parameters


                              TStandardEvent aStatus

The standard event.

Return value


                              THTTPEvent &

The HTTP event object.

inline THTTPEvent &operator=(TTransactionEvent aStatus);

Description

Assigns a transaction event code to an event object

Parameters


                              TTransactionEvent aStatus

The transaction event.

Return value


                              THTTPEvent &

The HTTP event object.

inline TBool operator==(THTTPEvent aThat) const;

Description

Equality operator

Parameters


                              THTTPEvent aThat

Return value


                              TBool

ETrue if the HTTP event objects are equal.

inline TBool operator!=(THTTPEvent aThat) const;

Description

Inequality operator

Parameters


                              THTTPEvent aThat

Return value


                              TBool

ETrue if the HTTP event objects are not equal.

inline TBool operator==(TStandardEvent aStatus) const;

Description

Equality operator (compares with a standard event)

Parameters


                              TStandardEvent aStatus

Return value


                              TBool

ETrue if the standard event objects are equal.

inline TBool operator!=(TStandardEvent aStatus) const;

Description

Inequality operator (compares with a standard event)

Parameters


                              TStandardEvent aStatus

Return value


                              TBool

ETrue if the standard event objects are not equal.

inline TBool operator==(TTransactionEvent aStatus) const;

Description

Equality operator (compares with a transaction event)

Parameters


                              TTransactionEvent aStatus

Return value


                              TBool

ETrue if the transaction event objects are equal.

inline TBool operator!=(TTransactionEvent aStatus) const;

Description

Inequality operator (compares with a transaction event)

Parameters


                              TTransactionEvent aStatus

Return value


                              TBool

ETrue if the transaction event objects are not equal.

inline TBool IsSessionEvent() const;

Description

Return value


                              TBool

ETrue if the event is a session event

TStandardEvent

Description

The TStandardEvent type is used to specify a family of event types. Any negative event number is used to convey error codes. All events are incoming (originate with the origin server) unless otherwise indicated. Outgoing messages will not be seen by the MHTTPTransactionCallback's MHFRunL.

`EAll`	Used when registering filter to indicate the filter is instrested in ALL events, both transaction and session events.
`EAnyTransactionEvent`	Used when registering filters to indicate the filter is interested in any transaction event, from any direction.
`EAnySessionEvent`	Used when registering filters to indicate the filter is interested in any session event.

TTransactionEvent

Description

The TTransactionEvents type defines the events that correspond to transactions. Outgoing events originate from the client or from filters. The clients do not send these explicitly since the API methods of RHTTPTransaction do it on their behalf. Incoming events originate from the protocol handler or from filters, and clients should handle these. The ESucceeded and EFailed events are mutually exclusive, but one will always be sent to the client as the final event for a transaction.

`ESubmit`	The transaction is being submitted. An outgoing event.
`ECancel`	The transaction is being cancelled. An outgoing event.
`ENotifyNewRequestBodyPart`	A new part of request body data is available for transmission. An outgoing event
`EClosed`	The transaction is being closed. An outgoing event.
`EGotResponseHeaders`	All the response headers have been received. An incoming event.
`EGotResponseBodyData`	Some (more) body data has been received (in the HTTP response). An incoming event.
`EResponseComplete`	The transaction's response is complete. An incoming event.
`EGotResponseTrailerHeaders`	Some trailer headers have been received. An incoming event.
`ESucceeded`	The transaction has succeeded. An incoming event.
`EFailed`	The transaction has failed. This is a 'catch-all' for communicating failures, and more details of the failure should have been notified in previous messages or status codes. If the client could process these then it is possible that it should not consider the transaction a failure. For instance a browser that displays the body of 404 responses to the user would not consider a 404 response to be a failure, as it would display it just like a 200 response even though a 404 will be flagged as a 'failure'. An incoming event.
`EUnrecoverableError`	Generated from `RHTTPTransaction::Fail()`. A filter has failed in a way that prevents it from using the normal event mechanism to inform the client of the error. This probably means it's run out of memory. An incoming event.
`ETooMuchRequestData`	An event that indicates that there is too much request data to be sent. The transaction will subsequently be cancelled. An incoming event.
`ERedirectRequiresConfirmation`	If the returned status code for a transaciton is either 301, 302 or 307 and the requested method is NOT a GET or HEAD, then the filter sends the client an event ERedirectRequiresConfirmation as stated in RFC2616. On receiving this event, the transaction is already setup with the redirected URI and the client is required to make the decision to whether to submit the transaction or close the transaction. If the requested method is GET or HEAD the transaction is automatically redirected and this event is not used.
`ENeedTunnel`	A transaction has been specified to use a proxy and the request requires a tunnel to be establised to the origin server.
`EGetCipherSuite`	The client wishes to view the current cipher suite.
`ERequestComplete`	The transaction's request is complete. An incoming event.

TDirection

Description

The TDirection type defines the direction of an event. An outgoing event originates from the client or from filters. The clients do not send these explicitly since the API methods of RHTTPTransaction or RHTTPSession do it on their behalf. Incoming events originate from the protocol handler or from filters, and clients should handle these.

`EOutgoing`	An event originating with the client (e.g. start transaction).
`EIncoming`	An event originating with the server (e.g. something received).

TTransactionWarning

Description

The TTransactionWarning type indicates that something in a transaction may be incorrect but the transaction may continue. It may also indicate that something (e.g. a filter) may have performed an action that has changed the transaction and that the client should be informed of this.

`ERedirectedPermanently`	An event indicating that the transaction has been redirected and the original origin server indicated that it was a permanent redirection. The URI for the transaction is now the redirected location. A permanent redirection may require further client behavior if the request came from a stored URI. This is to avoid further redirections on subsequent requests for this resource.
`ERedirectedTemporarily`	An event indicating that the transaction has been redirected and the original server indicated that it was a temporary redirection.
`EMoreDataReceivedThanExpected`	An event generated by the Protocol Handler when it receives a Content- Length value that does not match the actual length of the body data.

TInt iStatus;

Description

The status value.

TUint iUID;

Description

The UID.

protected: TBool iIsSessionEventFlag;

Description

Flag to indicate whether the event is a session event

Class THTTPEvent

Description

Members

Construction and destruction

THTTPEvent()

Description

Parameters

THTTPEvent()

Description

Parameters

THTTPEvent()

Description

Parameters

Member functions

operator=()

Description

Parameters

Return value

operator=()

Description

Parameters

Return value

operator==()

Description

Parameters

Return value

operator!=()

Description

Parameters

Return value

operator==()

Description

Parameters

Return value

operator!=()

Description

Parameters

Return value

operator==()

Description

Parameters

Return value

operator!=()

Description

Parameters

Return value

IsSessionEvent()

Description

Return value

Member enumerations

Enum TStandardEvent

Description

Enum TTransactionEvent

Description

Enum TDirection

Description

Enum TTransactionWarning

Description

Member data

iStatus

Description

iUID

Description

iIsSessionEventFlag

Description

Class `THTTPEvent`

`THTTPEvent()`

`THTTPEvent()`

`THTTPEvent()`

`operator=()`

`operator=()`

`operator==()`

`operator!=()`

`operator==()`

`operator!=()`

`operator==()`

`operator!=()`

`IsSessionEvent()`

Enum `TStandardEvent`

Enum `TTransactionEvent`

Enum `TDirection`

Enum `TTransactionWarning`

`iStatus`

`iUID`

`iIsSessionEventFlag`