#include <httpsvc.h>

Inheritance diagram for PConfigPage:

Collaboration diagram for PConfigPage:

Public Member Functions
	PConfigPage (PHTTPServiceProcess &app, const PString &section, const PHTTPAuthority &auth)

	PConfigPage (PHTTPServiceProcess &app, const PString &url, const PString &section, const PHTTPAuthority &auth)

void	OnLoadedText (PHTTPRequest &, 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...

PBoolean	OnPOST (PHTTPServer &server, const PURL &url, const PMIMEInfo &info, const PStringToString &data, const PHTTPConnectionInfo &connectInfo)
	Handle the POST command passed from the HTTP socket. More...

virtual PBoolean	Post (PHTTPRequest &request, const PStringToString &data, PHTML &replyMessage)
	Get a block of data (eg HTML) that the resource contains. More...

Public Member Functions inherited from PHTTPConfig
	PHTTPConfig (const PURL &url, const PString &section)

	PHTTPConfig (const PURL &url, const PString &section, const PHTTPAuthority &auth)

	PHTTPConfig (const PURL &url, const PString &section, const PString &html)

	PHTTPConfig (const PURL &url, const PString &section, const PString &html, const PHTTPAuthority &auth)

bool	LoadFromConfig ()
	Load all of the values for the resource from the configuration. More...

const PString &	GetConfigSection () const
	Get the configuration file section that the page will alter. More...

void	SetConfigSection (const PString &sect)

PHTTPField *	AddSectionField (PHTTPField sectionFld, const char prefix=NULL, const char *suffix=NULL)
	Add a field that will determine the name opf the secontion into which the other fields are to be added as keys. More...

void	AddNewKeyFields (PHTTPField keyFld, PHTTPField valFld)
	Add fields to the HTTP form for adding a new key to the config file section. More...

bool	AddBooleanField (const char name, bool defaultValue=false, const char help=NULL)
	Add a boolean field. More...

int	AddIntegerField (const char name, int low, int high, int defaultValue=0, const char units=NULL, const char *help=NULL)
	Add an integer field. More...

PString	AddStringField (const char name, PINDEX maxLength, const char defaultValue=NULL, const char *help=NULL, int rows=0, int columns=0)
	Add a string field. More...

PStringArray	AddStringArrayField (const char name, bool sorted, PINDEX maxLength, const PStringArray &defaultValues, const char help=NULL, int rows=0, int columns=0)
	Add a string array field. More...

PString	AddSelectField (const char name, const PStringArray &valueArray, const char defaultValue=NULL, const char *help=NULL, bool enumeration=false)
	Add a string field. More...

PStringArray	AddSelectArrayField (const char name, bool sorted, const PStringArray &defaultValues, const PStringArray &possibleValues, const char help=NULL, bool enumeration=false)
	Add a string array field. More...

Public Member Functions inherited from PHTTPForm
	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)

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	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 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 Member Functions
virtual PBoolean	GetExpirationDate (PTime &when)
	Get a block of data (eg HTML) that the resource contains. More...

Protected Attributes
PHTTPServiceProcess &	process

Protected Attributes inherited from PHTTPConfig
PString	section

PString	sectionPrefix

PString	sectionSuffix

PHTTPField *	sectionField

PHTTPField *	keyField

PHTTPField *	valField

Protected Attributes inherited from PHTTPForm
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
Public Types inherited from PHTTPForm
enum	BuildOptions { CompleteHTML, InsertIntoForm, InsertIntoHTML }

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)

Static Protected Member Functions inherited from PHTTPResource
static PBoolean	CheckAuthority (PHTTPAuthority &authority, PHTTPServer &server, const PHTTPRequest &request, const PHTTPConnectionInfo &connectInfo)

Friends inherited from PObject

Constructor & Destructor Documentation

PConfigPage::PConfigPage	(	PHTTPServiceProcess &	app,
		const PString &	section,
		const PHTTPAuthority &	auth
	)

PConfigPage::PConfigPage	(	PHTTPServiceProcess &	app,
		const PString &	url,
		const PString &	section,
		const PHTTPAuthority &	auth
	)

Member Function Documentation

virtual PBoolean PConfigPage::GetExpirationDate ( PTime & when )

protectedvirtual

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

Returns: Status of load operation.

Parameters

when	Time that the resource expires

Reimplemented from PHTTPResource.

void PConfigPage::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.

Reimplemented from PHTTPConfig.

Reimplemented in PRegisterPage.

PBoolean PConfigPage::OnPOST	(	PHTTPServer &	server,
		const PURL &	url,
		const PMIMEInfo &	info,
		const PStringToString &	data,
		const PHTTPConnectionInfo &	conInfo
	)

virtual

Handle the POST command passed from the HTTP socket.

The default action is to check the authorisation for the resource and call the virtual Post() function to handle the data being received.

Returns: true if the connection may persist, false if the connection must close If there is no ContentLength field in the response, this value must be false for correct operation.

Reimplemented from PHTTPResource.

virtual PBoolean PConfigPage::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 PHTTPConfig.

Reimplemented in PRegisterPage.

Member Data Documentation

PHTTPServiceProcess& PConfigPage::process

protected

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

httpsvc.h

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation