PHTTPConnectionInfo Class Reference

This object describes the connectiono associated with a HyperText Transport Protocol request. More...

#include <http.h>

Inheritance diagram for PHTTPConnectionInfo:

List of all members.

Public Member Functions
	PHTTPConnectionInfo ()
PHTTP::Commands	GetCommandCode () const
const PString &	GetCommandName () const
const PURL &	GetURL () const
const PMIMEInfo &	GetMIME () const
void	SetMIME (const PString &tag, const PString &value)
PBoolean	IsCompatible (int major, int minor) const
bool	IsPersistent () const
bool	WasPersistent () const
bool	IsProxyConnection () const
int	GetMajorVersion () const
int	GetMinorVersion () const
long	GetEntityBodyLength () const
PTimeInterval	GetPersistenceTimeout () const
	Get the maximum time a persistent connection may persist.
void	SetPersistenceTimeout (const PTimeInterval &t)
	Set the maximum time a persistent connection may persist.
unsigned	GetPersistenceMaximumTransations () const
	Get the maximum number of transations (GET/POST etc) for persistent connection.
void	SetPersistenceMaximumTransations (unsigned m)
	Set the maximum number of transations (GET/POST etc) for persistent connection.
const PMultiPartList &	GetMultipartFormInfo () const
void	ResetMultipartFormInfo ()
PString	GetEntityBody () const
Protected Member Functions
PBoolean	Initialise (PHTTPServer &server, PString &args)
bool	DecodeMultipartFormInfo ()
Protected Attributes
PHTTP::Commands	commandCode
PString	commandName
PURL	url
PMIMEInfo	mimeInfo
bool	isPersistent
bool	wasPersistent
bool	isProxyConnection
int	majorVersion
int	minorVersion
PString	entityBody
long	entityBodyLength
PTimeInterval	persistenceTimeout
unsigned	persistenceMaximum
PMultiPartList	m_multipartFormInfo

---

Detailed Description

This object describes the connectiono associated with a HyperText Transport Protocol request.

This information is required by handler functions on PHTTPResource descendant classes to manage the connection correctly.

---

Constructor & Destructor Documentation

PHTTPConnectionInfo::PHTTPConnectionInfo

(

)

---

Member Function Documentation

bool PHTTPConnectionInfo::DecodeMultipartFormInfo

(

)

[inline, protected]

References PMIMEInfo::DecodeMultiPartList(), entityBody, m_multipartFormInfo, and mimeInfo.

PHTTP::Commands PHTTPConnectionInfo::GetCommandCode

(

)

const [inline]

References commandCode.

const PString& PHTTPConnectionInfo::GetCommandName

(

)

const [inline]

References commandName.

PString PHTTPConnectionInfo::GetEntityBody

(

)

const [inline]

References entityBody.

long PHTTPConnectionInfo::GetEntityBodyLength

(

)

const [inline]

References entityBodyLength.

int PHTTPConnectionInfo::GetMajorVersion

(

)

const [inline]

References majorVersion.

const PMIMEInfo& PHTTPConnectionInfo::GetMIME

(

)

const [inline]

References mimeInfo.

int PHTTPConnectionInfo::GetMinorVersion

(

)

const [inline]

References minorVersion.

const PMultiPartList& PHTTPConnectionInfo::GetMultipartFormInfo

(

)

const [inline]

References m_multipartFormInfo.

unsigned PHTTPConnectionInfo::GetPersistenceMaximumTransations

(

)

const [inline]

Get the maximum number of transations (GET/POST etc) for persistent connection.

If this is zero then there is no maximum.

References persistenceMaximum.

PTimeInterval PHTTPConnectionInfo::GetPersistenceTimeout

(

)

const [inline]

Get the maximum time a persistent connection may persist.

References persistenceTimeout.

const PURL& PHTTPConnectionInfo::GetURL

(

)

const [inline]

References url.

PBoolean PHTTPConnectionInfo::Initialise	(	PHTTPServer &	server,
		PString &	args
	)		[protected]

PBoolean PHTTPConnectionInfo::IsCompatible	(	int	major,
		int	minor
	)		const

bool PHTTPConnectionInfo::IsPersistent

(

)

const [inline]

References isPersistent.

bool PHTTPConnectionInfo::IsProxyConnection

(

)

const [inline]

References isProxyConnection.

void PHTTPConnectionInfo::ResetMultipartFormInfo

(

)

[inline]

References m_multipartFormInfo, and PCollection::RemoveAll().

void PHTTPConnectionInfo::SetMIME	(	const PString &	tag,
		const PString &	value
	)

void PHTTPConnectionInfo::SetPersistenceMaximumTransations

(

unsigned

m

)

[inline]

Set the maximum number of transations (GET/POST etc) for persistent connection.

If this is zero then there is no maximum.

References persistenceMaximum.

void PHTTPConnectionInfo::SetPersistenceTimeout

(

const PTimeInterval &

t

)

[inline]

Set the maximum time a persistent connection may persist.

References persistenceTimeout.

bool PHTTPConnectionInfo::WasPersistent

(

)

const [inline]

References wasPersistent.

---

Member Data Documentation

PHTTP::Commands PHTTPConnectionInfo::commandCode [protected]

Referenced by GetCommandCode().

PString PHTTPConnectionInfo::commandName [protected]

Referenced by GetCommandName().

PString PHTTPConnectionInfo::entityBody [protected]

Referenced by DecodeMultipartFormInfo(), and GetEntityBody().

long PHTTPConnectionInfo::entityBodyLength [protected]

Referenced by GetEntityBodyLength().

bool PHTTPConnectionInfo::isPersistent [protected]

Referenced by IsPersistent().

bool PHTTPConnectionInfo::isProxyConnection [protected]

Referenced by IsProxyConnection().

PMultiPartList PHTTPConnectionInfo::m_multipartFormInfo [protected]

Referenced by DecodeMultipartFormInfo(), GetMultipartFormInfo(), and ResetMultipartFormInfo().

int PHTTPConnectionInfo::majorVersion [protected]

Referenced by GetMajorVersion().

PMIMEInfo PHTTPConnectionInfo::mimeInfo [protected]

Referenced by DecodeMultipartFormInfo(), and GetMIME().

int PHTTPConnectionInfo::minorVersion [protected]

Referenced by GetMinorVersion().

unsigned PHTTPConnectionInfo::persistenceMaximum [protected]

Referenced by GetPersistenceMaximumTransations(), and SetPersistenceMaximumTransations().

PTimeInterval PHTTPConnectionInfo::persistenceTimeout [protected]

Referenced by GetPersistenceTimeout(), and SetPersistenceTimeout().

PURL PHTTPConnectionInfo::url [protected]

Referenced by GetURL().

bool PHTTPConnectionInfo::wasPersistent [protected]

Referenced by WasPersistent().

---

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

• http.h