MuHttpServer::Response Struct Reference

This structure contains information used to send a response to an HTTP request. More...

#include <MuHttpServer.h>

List of all members.

Public Types
enum	CharacterEncodingTypeEnum { ASCII, UTF8, OCTET }
typedef EnumWrapper < CharacterEncodingTypeEnum >	CharacterEncodingType
Public Member Functions
	Response ()
Public Attributes
QString	mBody
QByteArray	mOctets
QMap< QString, QString >	mHeaders
ResponseCode	mCode
CharacterEncodingType	mEncoding

---

Detailed Description

This structure contains information used to send a response to an HTTP request.

Definition at line 37 of file MuHttpServer.h.

---

Member Typedef Documentation

typedef EnumWrapper<CharacterEncodingTypeEnum> MuHttpServer::Response::CharacterEncodingType

The EnumWrapper contains a given enum value and provides a isValid() method which returns true if the contained enum value is valid.

Please see How To Use EnumWrapper for more information. The wrapped enum values are MuHttpServer::Response::CharacterEncodingTypeEnum.

Definition at line 75 of file MuHttpServer.h.

---

Member Enumeration Documentation

enum MuHttpServer::Response::CharacterEncodingTypeEnum

Enumerator:

ASCII	The response body is ASCII encoded and contained in the mBody member.
UTF8	The response body is UTF-8 encoded and contained in the mBody member.
OCTET	The response body consists of raw octets and is contained in the mOctets member.

Definition at line 65 of file MuHttpServer.h.

---

Constructor & Destructor Documentation

MuHttpServer::Response::Response

(

)

Create an uninitialized Response with a default encoding type of ASCII.

Definition at line 85 of file MuHttpServer.h.

---

Member Data Documentation

QString MuHttpServer::Response::mBody

The body of the response message if the response is 8-bit safe.

(i.e. ASCII)

Definition at line 42 of file MuHttpServer.h.

QByteArray MuHttpServer::Response::mOctets

The body of the response message if the response is not 8-bit safe.

(i.e. a raw image)

Definition at line 47 of file MuHttpServer.h.

QMap<QString,QString> MuHttpServer::Response::mHeaders

Additional HTTP headers to attach to the response message.

The key is the name of the header and the value is the header data.

Definition at line 54 of file MuHttpServer.h.

ResponseCode MuHttpServer::Response::mCode

The type of response.

This can be the numeric code defined by the HTTP RFCs or a convenience enum value as defined by the EHS library. (for example, HTTPRESPONSE_200_OK)

Definition at line 62 of file MuHttpServer.h.

CharacterEncodingType MuHttpServer::Response::mEncoding

What character encoding is the response body?

Definition at line 80 of file MuHttpServer.h.