#include <mw/http/rhttpmessage.h>
| class RHTTPMessage |
| Protected Attributes | |
|---|---|
| CMessage * | iImplementation |
| Public Member Functions | |
|---|---|
| RHTTPMessage() | |
| IMPORT_C MHTTPDataSupplier * | Body() |
| IMPORT_C RHTTPHeaders | GetHeaderCollection() |
| IMPORT_C TBool | HasBody() |
| IMPORT_C void | RemoveBody() |
| IMPORT_C void | SetBody(MHTTPDataSupplier &) |
An abstract HTTP message. In RFC2616, an HTTP message is defined as having a header and an optional body. This class is specialised for HTTP requests and responses.
| IMPORT_C MHTTPDataSupplier * | Body | ( | ) | const |
Gets the body. The body is supplied as a MHTTPDataSupplier, which can be used to return the current data chunk, and to acknowledge when that chunk has been consumed by the client.
Note that the client can assume the body object will remain unchanged from when it receives the first data until the end of the transaction.
Returns: A data supplier that provides access to a body data chunk. NULL if the body has not been set, or has been removed
| IMPORT_C RHTTPHeaders | GetHeaderCollection | ( | ) |
Returns the header collection for the message
| IMPORT_C TBool | HasBody | ( | ) | const |
Determine whether this message has any associated body data.
Returns: ETrue if there is some body data, EFalse if not.
| IMPORT_C void | SetBody | ( | MHTTPDataSupplier & | aBody | ) |
Sets the messages body, replacing any existing body. The body is supplied as a MHTTPDataSupplier, which will then return the data in 1 or more chunks on request.
| Parameter | Description |
|---|---|
| aBody | The data supplier that will supply the body. |