zeus::THTTPRequest Class Reference

#include <HTTPRequest.h>

Inheritance diagram for zeus::THTTPRequest:

List of all members.

Public Types
enum	ERequestProperty {   etAuthorization = 0, etFrom = 1, etIfModifiedSince = 2, etReferer = 3,   etUserAgent = 4, etAccept = 5, etAcceptCharset = 6, etAcceptEncoding = 7,   etAcceptLanguage = 8 }
Public Member Functions
	THTTPRequest (THTTProtocol::EHTTPVersion eVersion=THTTProtocol::etVersion_1_0)
virtual void	reset ()
virtual Retval	setRequestProperty (ERequestProperty eType, const IString &rValue)
virtual void	setData (const IString &rData, bool bAddContentProperties=false)
THTTProtocol::ERequestMethod	getMethod () const
TString	getRessource () const
void	setMethod (THTTProtocol::ERequestMethod eMethod)
void	setRessource (const IString &rRessource)
TString	toString () const
Static Public Member Functions
static Retval	parse (const IString &rIn, THTTPRequest *&rpRequest)
Protected Member Functions
virtual	~THTTPRequest ()

---

Detailed Description

This class wrapps a HTTP Request object. It implements fully the HTTP 1.0 protocol (RFC1945)

---

Member Enumeration Documentation

enum zeus::THTTPRequest::ERequestProperty

This type defines request header fields (properties)

Enumerator:

etAuthorization
etFrom	Authorization field.
etIfModifiedSince	From field.
etReferer	If-Modified-Since field.
etUserAgent	Referer field.
etAccept	User-Agent field.
etAcceptCharset	Accept field.
etAcceptEncoding	Accept-Charset field.
etAcceptLanguage	Accept-Encoding field.

---

Constructor & Destructor Documentation

THTTPRequest::THTTPRequest

(

THTTProtocol::EHTTPVersion

eVersion = THTTProtocol::etVersion_1_0 )

Creates a HTTP Request Object

Parameters:

eVersion

: Protocol version of the HTML request

THTTPRequest::~THTTPRequest

(

)

[protected, virtual]

Destroys the HTTP Request Object

---

Member Function Documentation

THTTProtocol::ERequestMethod zeus::THTTPRequest::getMethod

(

)

const [inline]

Returns the method of the HTTP

TString zeus::THTTPRequest::getRessource

(

)

const [inline]

Returns the uri of a ressource

Retval THTTPRequest::parse	(	const IString &	rIn,
		THTTPRequest *&	rpRequest
	)		[static]

This Method parses a incomming request

Parameters:

rIn	: Input data
rpRequest	: Return value

Return values:

RET_NOERROR	: Parsing ok
RET_REQUEST_FAILED	: wrong format

void THTTPRequest::reset

(

)

[virtual]

Resets the request to default

Reimplemented from zeus::TAbstractHTTPData.

void zeus::THTTPRequest::setData	(	const IString &	rData,
		bool	bAddContentProperties = false
	)		[inline, virtual]

See also:

TAbstractHTTPData::setData

Reimplemented from zeus::TAbstractHTTPData.

void THTTPRequest::setMethod

(

THTTProtocol::ERequestMethod

eMethod )

Sets a method of the HTTP

Parameters:

eMethod

: method of the request

Retval THTTPRequest::setRequestProperty	(	ERequestProperty	eType,
		const IString &	rValue
	)		[virtual]

Sets the request property values

Parameters:

eType	: Type of the request property
rValue	: Value of the property

void THTTPRequest::setRessource

(

const IString &

rRessource )

Sets an uri of a ressource

Parameters:

rRessource

: Ressource of the request

TString THTTPRequest::toString

(

)

const

Returns a string which contains the HTTP Request

Reimplemented from zeus::TZObject.

---

The documentation for this class was generated from the following files:

• HTTPRequest.h
• HTTPRequest.cpp