PHTTPConnectionInfo Class Reference

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

#include <http.h>

Inheritance diagram for PHTTPConnectionInfo:

Collaboration diagram for PHTTPConnectionInfo:

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
void	DisablePersistence ()
	Do not persist. More...
PTimeInterval	GetPersistenceTimeout () const
	Get the maximum time a persistent connection may persist. More...
void	SetPersistenceTimeout (const PTimeInterval &t)
	Set the maximum time a persistent connection may persist. More...
unsigned	GetPersistenceMaximumTransations () const
	Get the maximum number of transations (GET/POST etc) for persistent connection. More...
void	SetPersistenceMaximumTransations (unsigned m)
	Set the maximum number of transations (GET/POST etc) for persistent connection. More...
const PMultiPartList &	GetMultipartFormInfo () const
void	ResetMultipartFormInfo ()
PString	GetEntityBody () const
bool	IsWebSocket () const
void	ClearWebSocket ()
Public Member Functions inherited from PObject
__inline unsigned	GetTraceContextIdentifier () const
	Get PTRACE context identifier. More...
__inline void	SetTraceContextIdentifier (unsigned id)
__inline void	SetTraceContextIdentifier (const PObject &obj)
__inline void	SetTraceContextIdentifier (const PObject *obj)
__inline void	CopyTraceContextIdentifier (PObject &obj) const
__inline void	CopyTraceContextIdentifier (PObject *obj) const
virtual	~PObject ()
__inline const char *	GetClass () const
__inline bool	IsClass (const char *name) const
__inline const PObject *	PTraceObjectInstance () const
virtual PObject *	Clone () const
	Create a copy of the class on the heap. More...
template<class CLS >
CLS *	CloneAs () const
	As for Clone() but converts to specified type. More...
virtual PINDEX	HashFunction () const
	This function yields a hash value required by the PDictionary class. More...
virtual Comparison	Compare (const PObject &obj) const
	Compare the two objects and return their relative rank. More...
virtual Comparison	CompareObjectMemoryDirect (const PObject &obj) const
	Determine the byte wise comparison of two objects. More...
bool	operator== (const PObject &obj) const
	Compare the two objects. More...
bool	operator!= (const PObject &obj) const
	Compare the two objects. More...
bool	operator< (const PObject &obj) const
	Compare the two objects. More...
bool	operator> (const PObject &obj) const
	Compare the two objects. More...
bool	operator<= (const PObject &obj) const
	Compare the two objects. More...
bool	operator>= (const PObject &obj) const
	Compare the two objects. More...
virtual void	PrintOn (ostream &strm) const
	Output the contents of the object to the stream. More...
virtual void	ReadFrom (istream &strm)
	Input the contents of the object from the stream. More...

Protected Member Functions
PBoolean	Initialise (PHTTPServer &server, PString &args)
bool	DecodeMultipartFormInfo ()
Protected Member Functions inherited from PObject
	PObject ()
	Constructor for PObject, made protected so cannot ever create one on its own. More...

Protected Attributes
PHTTP::Commands	commandCode
PString	commandName
PURL	url
PMIMEInfo	mimeInfo
bool	isPersistent
bool	wasPersistent
bool	isProxyConnection
bool	m_isWebSocket
int	majorVersion
int	minorVersion
PString	entityBody
long	entityBodyLength
unsigned	persistenceSeconds
unsigned	persistenceMaximum
PMultiPartList	m_multipartFormInfo
Protected Attributes inherited from PObject
unsigned	m_traceContextIdentifier

Additional Inherited Members
Public Types inherited from PObject
enum	Comparison { LessThan = -1, EqualTo = 0, GreaterThan = 1 }
	Result of the comparison operation performed by the Compare() function. More...
Static Public Member Functions inherited from PObject
static __inline void	CopyTraceContextIdentifier (PObject &to, const PObject &from)
static __inline void	CopyTraceContextIdentifier (PObject &to, const PObject *from)
static __inline void	CopyTraceContextIdentifier (PObject *to, const PObject &from)
static __inline void	CopyTraceContextIdentifier (PObject *to, const PObject *from)
static __inline const char *	Class ()
static __inline const PObject *	PTraceObjectInstance (const char *)
static __inline const PObject *	PTraceObjectInstance (const PObject *obj)
template<typename T >
static Comparison	Compare2 (T v1, T v2)
	Compare two types, returning Comparison type. More...
static Comparison	InternalCompareObjectMemoryDirect (const PObject *obj1, const PObject *obj2, PINDEX size)
	Internal function caled from CompareObjectMemoryDirect() More...

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

void PHTTPConnectionInfo::ClearWebSocket ( )

inline

References m_isWebSocket.

bool PHTTPConnectionInfo::DecodeMultipartFormInfo ( )

inlineprotected

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

void PHTTPConnectionInfo::DisablePersistence ( )

inline

Do not persist.

References isPersistent.

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 persistenceSeconds.

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.

bool PHTTPConnectionInfo::IsWebSocket ( ) const

inline

References m_isWebSocket.

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 PTimeInterval::GetSeconds(), and persistenceSeconds.

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 DisablePersistence(), and IsPersistent().

bool PHTTPConnectionInfo::isProxyConnection

protected

Referenced by IsProxyConnection().

bool PHTTPConnectionInfo::m_isWebSocket

protected

Referenced by ClearWebSocket(), and IsWebSocket().

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().

unsigned PHTTPConnectionInfo::persistenceSeconds

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