Class RHTTPMessage

class RHTTPMessage;

Description

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.

Members

Defined in RHTTPMessage:

• Body()constGets the body. The body is supplied as a MHTTPDataSupplier, which can be used to...
• GetHeaderCollection()Returns the header collection for the message
• HasBody()constDetermine whether this message has any associated body data.
• RHTTPMessage()Default (uninitialised) constructor.
• RemoveBody()Removes the body
• SetBody(MHTTPDataSupplier &)Sets the messages body, replacing any existing body. The body is supplied as a M...
• iImplementation

inline RHTTPMessage();

Description

Default (uninitialised) constructor.

IMPORT_C RHTTPHeaders GetHeaderCollection();

Description

Returns the header collection for the message

Return value

IMPORT_C void SetBody(MHTTPDataSupplier &aBody);

Description

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.

Parameters

IMPORT_C void RemoveBody();

Description

Removes the body

IMPORT_C TBool HasBody() const;

Description

Determine whether this message has any associated body data.

Return value

IMPORT_C MHTTPDataSupplier* Body() const;

Description

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.

Return value

protected: CMessage * iImplementation;

Description