RHTTPMessage Class Reference

class RHTTPMessage

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.

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 &)
Protected Attributes
CMessage * iImplementation

Constructor & Destructor Documentation

RHTTPMessage()

RHTTPMessage ( ) [inline]

Member Functions Documentation

Body()

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.

GetHeaderCollection()

IMPORT_C RHTTPHeaders GetHeaderCollection ( )

Returns the header collection for the message

HasBody()

IMPORT_C TBool HasBody ( ) const

Determine whether this message has any associated body data.

RemoveBody()

IMPORT_C void RemoveBody ( )

Removes the body

SetBody(MHTTPDataSupplier &)

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.

Parameters

MHTTPDataSupplier & aBody The data supplier that will supply the body.

Member Data Documentation

CMessage * iImplementation

CMessage * iImplementation [protected]