PHTTPForm Class Reference

#include <httpform.h>

Inheritance diagram for PHTTPForm:

Collaboration diagram for PHTTPForm:

Public Types
enum	BuildOptions { CompleteHTML, InsertIntoForm, InsertIntoHTML }

Public Member Functions
	PHTTPForm (const PURL &url)
	PHTTPForm (const PURL &url, const PHTTPAuthority &auth)
	PHTTPForm (const PURL &url, const PString &html)
	PHTTPForm (const PURL &url, const PString &html, const PHTTPAuthority &auth)
virtual void	OnLoadedText (PHTTPRequest &request, PString &text)
	This is called after the text has been loaded and may be used to customise or otherwise mangle a loaded piece of text. More...
virtual PBoolean	Post (PHTTPRequest &request, const PStringToString &data, PHTML &replyMessage)
	Get a block of data (eg HTML) that the resource contains. More...
PHTTPField *	Add (PHTTPField *fld)
void	RemoveAllFields ()
void	BuildHTML (const char *heading)
void	BuildHTML (const PString &heading)
void	BuildHTML (PHTML &html, BuildOptions option=CompleteHTML)
Public Member Functions inherited from PHTTPString
	PHTTPString (const PURL &url)
	Contruct a new simple string resource for the HTTP space. More...
	PHTTPString (const PURL &url, const PHTTPAuthority &auth)
	PHTTPString (const PURL &url, const PString &str)
	PHTTPString (const PURL &url, const PString &str, const PString &contentType)
	PHTTPString (const PURL &url, const PString &str, const PHTTPAuthority &auth)
	PHTTPString (const PURL &url, const PString &str, const PString &contentType, const PHTTPAuthority &auth)
virtual PBoolean	LoadHeaders (PHTTPRequest &request)
	Get the headers for block of data (eg HTML) that the resource contains. More...
virtual PString	LoadText (PHTTPRequest &request)
	Get a block of text data (eg HTML) that the resource contains. More...
const PString &	GetString ()
	Get the string for this resource. More...
void	SetString (const PString &str)
	Set the string to be returned by this resource. More...
Public Member Functions inherited from PHTTPResource
virtual	~PHTTPResource ()
const PURL &	GetURL () const
	Get the URL for this resource. More...
PString	GetHotLink () const
	Get relative hot link for this resouce. More...
const PString &	GetContentType () const
	Get the current content type for the resource. More...
PHTTPAuthority *	GetAuthority () const
	Get the current authority for the resource. More...
void	SetAuthority (const PHTTPAuthority &auth)
	Set the current authority for the resource. More...
void	ClearAuthority ()
	Set the current authority for the resource to unrestricted. More...
DWORD	GetHitCount () const
	Get the current hit count for the resource. More...
void	ClearHitCount ()
	Clear the hit count for the resource. More...
virtual bool	OnWebSocket (PHTTPServer &server, PHTTPConnectionInfo &connectInfo)
	Called when a request indicates a swtch to WebSocket protocol. More...
virtual PBoolean	OnGET (PHTTPServer &server, const PURL &url, const PMIMEInfo &info, const PHTTPConnectionInfo &conInfo)
	Handle the GET command passed from the HTTP socket. More...
virtual PBoolean	OnGETData (PHTTPServer &server, const PURL &url, const PHTTPConnectionInfo &connectInfo, PHTTPRequest &request)
	Send the data associated with a GET command. More...
virtual PBoolean	OnHEAD (PHTTPServer &server, const PURL &url, const PMIMEInfo &info, const PHTTPConnectionInfo &conInfo)
	Handle the HEAD command passed from the HTTP socket. More...
virtual PBoolean	OnPOST (PHTTPServer &server, const PURL &url, const PMIMEInfo &info, const PStringToString &data, const PHTTPConnectionInfo &conInfo)
	Handle the POST command passed from the HTTP socket. More...
virtual PBoolean	OnPOSTData (PHTTPRequest &request, const PStringToString &data)
	Send the data associated with a POST command. More...
virtual PBoolean	IsModifiedSince (const PTime &when)
	Check to see if the resource has been modified since the date specified. More...
virtual PBoolean	GetExpirationDate (PTime &when)
	Get a block of data (eg HTML) that the resource contains. More...
virtual PHTTPRequest *	CreateRequest (const PURL &url, const PMIMEInfo &inMIME, const PMultiPartList &multipartFormInfo, PHTTPServer &socket)
	Create a new request block for this type of resource. More...
virtual void	SendData (PHTTPRequest &request)
	Send the data associated with a command. More...
virtual PBoolean	LoadData (PHTTPRequest &request, PCharArray &data)
	Get a block of data that the resource contains. More...
Public Member Functions inherited from PObject
unsigned	GetTraceContextIdentifier () const
	Get PTRACE context identifier. More...
void	SetTraceContextIdentifier (unsigned id)
void	GetTraceContextIdentifier (PObject &obj)
void	GetTraceContextIdentifier (PObject *obj)
void	SetTraceContextIdentifier (const PObject &obj)
void	SetTraceContextIdentifier (const PObject *obj)
virtual	~PObject ()
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 const char *	GetClass (unsigned ancestor=0) const
	Get the current dynamic type of the object instance. More...
PBoolean	IsClass (const char *cls) const
virtual PBoolean	InternalIsDescendant (const char *clsName) const
	Determine if the dynamic type of the current instance is a descendent of the specified class. More...
__inline const PObject *	PTraceObjectInstance () const
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 Attributes
PHTTPCompositeField	fields
PStringSet	fieldNames
Protected Attributes inherited from PHTTPString
PString	string
Protected Attributes inherited from PHTTPResource
PURL	baseURL
	Base URL for the resource, may accept URLS with a longer hierarchy. More...
PString	contentType
	MIME content type for the resource. More...
PHTTPAuthority *	authority
	Authorisation method for the resource. More...
volatile DWORD	hitCount
	COunt of number of times resource was accessed. More...
Protected Attributes inherited from PObject
unsigned	m_traceContextIdentifier

Additional Inherited Members
Static Public Member Functions inherited from PObject
static Comparison	InternalCompareObjectMemoryDirect (const PObject *obj1, const PObject *obj2, PINDEX size)
	Internal function caled from CompareObjectMemoryDirect() More...
static const char *	Class ()
	Get the name of the class as a C string. More...
static __inline const PObject *	PTraceObjectInstance (const char *)
static __inline const PObject *	PTraceObjectInstance (const PObject *obj)
Protected Member Functions inherited from PHTTPResource
	PHTTPResource (const PURL &url)
	PHTTPResource (const PURL &url, const PHTTPAuthority &auth)
	PHTTPResource (const PURL &url, const PString &contentType)
	PHTTPResource (const PURL &url, const PString &contentType, const PHTTPAuthority &auth)
virtual PBoolean	CheckAuthority (PHTTPServer &server, const PHTTPRequest &request, const PHTTPConnectionInfo &conInfo)
	See if the resource is authorised given the mime info. More...
virtual PBoolean	OnGETOrHEAD (PHTTPServer &server, const PURL &url, const PMIMEInfo &info, const PHTTPConnectionInfo &conInfo, PBoolean isGet)
	common code for GET and HEAD commands More...
Static Protected Member Functions inherited from PHTTPResource
static PBoolean	CheckAuthority (PHTTPAuthority &authority, PHTTPServer &server, const PHTTPRequest &request, const PHTTPConnectionInfo &connectInfo)
Friends inherited from PObject

Member Enumeration Documentation

enum PHTTPForm::BuildOptions

Enumerator
CompleteHTML
InsertIntoForm
InsertIntoHTML

Constructor & Destructor Documentation

PHTTPForm::PHTTPForm

(

const PURL &

url

)

PHTTPForm::PHTTPForm	(	const PURL &	url,
		const PHTTPAuthority &	auth
	)

PHTTPForm::PHTTPForm	(	const PURL &	url,
		const PString &	html
	)

PHTTPForm::PHTTPForm	(	const PURL &	url,
		const PString &	html,
		const PHTTPAuthority &	auth
	)

Member Function Documentation

PHTTPField* PHTTPForm::Add

(

PHTTPField *

fld

)

void PHTTPForm::BuildHTML

(

const char *

heading

)

void PHTTPForm::BuildHTML

(

const PString &

heading

)

void PHTTPForm::BuildHTML	(	PHTML &	html,
		BuildOptions	option = CompleteHTML
	)

virtual void PHTTPForm::OnLoadedText ( PHTTPRequest &  request, PString &  text  )

virtual

This is called after the text has been loaded and may be used to customise or otherwise mangle a loaded piece of text.

Typically this is used with HTML responses.

The default action for this function is to do nothing.

Parameters

request	Information on this request.
text	Data used in reply.

Reimplemented from PHTTPResource.

Reimplemented in PHTTPConfig, PRegisterPage, and PConfigPage.

virtual PBoolean PHTTPForm::Post ( PHTTPRequest &  request, const PStringToString &  data, PHTML &  replyMessage  )

virtual

Get a block of data (eg HTML) that the resource contains.

The default action for this function is to do nothing and return success.

Returns

true if the connection may persist, false if the connection must close

Parameters

request	Information on this request.
data	Variables in the POST data.
replyMessage	Reply message for post.

Reimplemented from PHTTPResource.

Reimplemented in PHTTPConfig, PRegisterPage, and PConfigPage.

void PHTTPForm::RemoveAllFields ( )

inline

References fieldNames, fields, PHTTPCompositeField::RemoveAll(), and PCollection::RemoveAll().

Member Data Documentation

PStringSet PHTTPForm::fieldNames

protected

Referenced by RemoveAllFields().

PHTTPCompositeField PHTTPForm::fields

protected

Referenced by RemoveAllFields().

---

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

• httpform.h