#include <mw/http/thttpevent.h>
| class THTTPEvent |
| Public Attributes | |
|---|---|
| TInt | iStatus |
| TUint | iUID |
| Protected Attributes | |
|---|---|
| TBool | iIsSessionEventFlag |
| Public Member Enumerations | |
|---|---|
| enum | TDirection { EOutgoing, EIncoming } |
| enum | TStandardEvent { EAll, EAnyTransactionEvent, EAnySessionEvent } |
| enum | TTransactionEvent { ESubmit, ECancel, ENotifyNewRequestBodyPart, EClosed, ..., EResume } |
| enum | TTransactionWarning { ERedirectedPermanently, ERedirectedTemporarily, EMoreDataReceivedThanExpected } |
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.
| TBool | iIsSessionEventFlag | [protected] |
Flag to indicate whether the event is a session event
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.
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.
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.
| Enumerator | Value | Description |
|---|---|---|
| ESubmit | KTransactionEventBaseStatus |
The transaction is being submitted. An outgoing event. |
| ECancel | KTransactionEventBaseStatus + 1 |
The transaction is being cancelled. An outgoing event. |
| ENotifyNewRequestBodyPart | KTransactionEventBaseStatus + 2 |
A new part of request body data is available for transmission. An outgoing event |
| EClosed | KTransactionEventBaseStatus + 3 |
The transaction is being closed. An outgoing event. |
| EGotResponseHeaders | KTransactionEventBaseStatus + 4 |
All the response headers have been received. An incoming event. |
| EGotResponseBodyData | KTransactionEventBaseStatus + 5 |
Some (more) body data has been received (in the HTTP response). An incoming event. |
| EResponseComplete | KTransactionEventBaseStatus + 6 |
The transaction's response is complete. An incoming event. |
| EGotResponseTrailerHeaders | KTransactionEventBaseStatus + 7 |
Some trailer headers have been received. An incoming event. |
| ESucceeded | KTransactionEventBaseStatus + 8 |
The transaction has succeeded. An incoming event. |
| EFailed | KTransactionEventBaseStatus + 9 |
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 | KTransactionEventBaseStatus + 10 |
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 | KTransactionEventBaseStatus + 11 |
An event that indicates that there is too much request data to be sent. The transaction will subsequently be cancelled. An incoming event. |
| ERedirectRequiresConfirmation | KTransactionEventBaseStatus + 12 |
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 | KTransactionEventBaseStatus + 13 |
A transaction has been specified to use a proxy and the request requires a tunnel to be establised to the origin server. |
| EGetCipherSuite | KTransactionEventBaseStatus + 14 |
The client wishes to view the current cipher suite. |
| ERequestComplete | KTransactionEventBaseStatus + 15 |
The transaction's request is complete. An incoming event. |
| EReceived100Continue | KTransactionEventBaseStatus + 16 |
An event to signal that 100 Continue response has been received. |
| ECancelWaitFor100Continue | KTransactionEventBaseStatus + 17 |
An event to cancel the wait for a 100-Continue event. |
| ESendTimeOut | KTransactionEventBaseStatus + 18 |
An event of Send Timeout for a Request. |
| EReceiveTimeOut | KTransactionEventBaseStatus + 19 |
An event of Receive Timeout for a Response. |
| ESuspend | KTransactionEventBaseStatus +20 |
An event that indicate that transaction Suspended. |
| EResume | KTransactionEventBaseStatus +21 |
An event that indicate that transaction Resume. |
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.
| THTTPEvent | ( | TStandardEvent | aStatus = EAnyTransactionEvent | ) | [inline] |
Constructor (using a standard event and the HTTP UID)
| Parameter | Description |
|---|---|
| aStatus | The standard event to use. |
| THTTPEvent | ( | TTransactionEvent | aStatus | ) | [inline] |
Constructor (using a transaction event and the HTTP UID)
| Parameter | Description |
|---|---|
| aStatus | The transaction event to use. |
| TBool | operator!= | ( | THTTPEvent | aThat | ) | const [inline] |
Inequality operator
Returns: ETrue if the HTTP event objects are not equal.
| TBool | operator!= | ( | TStandardEvent | aStatus | ) | const [inline] |
Inequality operator (compares with a standard event)
Returns: ETrue if the standard event objects are not equal.
| TBool | operator!= | ( | TTransactionEvent | aStatus | ) | const [inline] |
Inequality operator (compares with a transaction event)
Returns: ETrue if the transaction event objects are not equal.
| THTTPEvent & | operator= | ( | TStandardEvent | aStatus | ) | [inline] |
Assigns a standard event code to an event object
| Parameter | Description |
|---|---|
| aStatus | The standard event. |
Returns: The HTTP event object.
| THTTPEvent & | operator= | ( | TTransactionEvent | aStatus | ) | [inline] |
Assigns a transaction event code to an event object
| Parameter | Description |
|---|---|
| aStatus | The transaction event. |
Returns: The HTTP event object.
| TBool | operator== | ( | THTTPEvent | aThat | ) | const [inline] |
Equality operator
Returns: ETrue if the HTTP event objects are equal.
| TBool | operator== | ( | TStandardEvent | aStatus | ) | const [inline] |
Equality operator (compares with a standard event)
Returns: ETrue if the standard event objects are equal.
| TBool | operator== | ( | TTransactionEvent | aStatus | ) | const [inline] |
Equality operator (compares with a transaction event)
Returns: ETrue if the transaction event objects are equal.