Class RHTTPMessage

class RHTTPMessage

Support

Supported from 7.0

Description

A message: this is the base class for requests and responses.

Message is the HTTP terminology for data exchanged between client and server, specifically being either a request or response.

A message is made up of a body and a collection of headers. The body is supplied by a MHTTPDataSupplier object, which will then return the data in one or more chunks on request.

Defined in RHTTPMessage:
Body(), GetHeaderCollection(), HasBody(), RHTTPMessage(), RemoveBody(), SetBody(), iImplementation

See also:

• RHTTPRequest
• RHTTPResponse

inline RHTTPMessage();

Description

Default constructor.

RHTTPHeaders GetHeaderCollection();

Description

Gets the header collection for the message.

Return value

void SetBody(MHTTPDataSupplier& aBody);

Description

Sets the message's body, replacing any existing body.

Parameters

void RemoveBody();

Description

Removes the body.

TBool HasBody() const;

Description

Tests if this message has any associated body data.

Return value

MHTTPDataSupplier* Body() const;

Description

Gets the body.

The body is supplied as an 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

Description

This is internal and not intended for use.

protected: CMessage* iImplementation;

Description

This is internal and not intended for use.