PHTTPServiceProcess Class Reference

#include <httpsvc.h>

Inheritance diagram for PHTTPServiceProcess:

List of all members.

Public Types
enum	{ MaxSecuredKeys = 10 }
Public Member Functions
	PHTTPServiceProcess (const Info &inf)
	~PHTTPServiceProcess ()
BOOL	OnStart ()
void	OnStop ()
BOOL	OnPause ()
void	OnContinue ()
const char *	GetServiceDependencies () const
virtual void	OnConfigChanged ()=0
virtual BOOL	Initialise (const char *initMsg)=0
BOOL	ListenForHTTP (WORD port, PSocket::Reusability reuse=PSocket::CanReuseAddress, PINDEX stackSize=0x4000)
BOOL	ListenForHTTP (PSocket *listener, PSocket::Reusability reuse=PSocket::CanReuseAddress, PINDEX stackSize=0x4000)
virtual PString	GetPageGraphic ()
void	GetPageHeader (PHTML &)
void	GetPageHeader (PHTML &, const PString &title)
virtual PString	GetCopyrightText ()
const PString &	GetMacroKeyword () const
const PTime &	GetCompilationDate () const
const PString &	GetHomePage () const
const PString &	GetEMailAddress () const
const PString &	GetProductName () const
const PTEACypher::Key &	GetProductKey () const
const PStringArray &	GetSecuredKeys () const
const PTEACypher::Key &	GetSignatureKey () const
BOOL	ShouldIgnoreSignatures () const
void	SetIgnoreSignatures (BOOL ig)
virtual void	AddRegisteredText (PHTML &html)
virtual void	AddUnregisteredText (PHTML &html)
virtual BOOL	SubstituteEquivalSequence (PHTTPRequest &request, const PString &, PString &)
virtual PHTTPServer *	CreateHTTPServer (PTCPSocket &socket)
virtual PHTTPServer *	OnCreateHTTPServer (const PHTTPSpace &urlSpace)
PTCPSocket *	AcceptHTTP ()
BOOL	ProcessHTTP (PTCPSocket &socket)
Static Public Member Functions
static PHTTPServiceProcess &	Current ()
Protected Member Functions
void	ShutdownListener ()
void	BeginRestartSystem ()
void	CompleteRestartSystem ()
	PLIST (ThreadList, PHTTPServiceThread)
Protected Attributes
PSocket *	httpListeningSocket
PHTTPSpace	httpNameSpace
PString	macroKeyword
PTEACypher::Key	productKey
PStringArray	securedKeys
PTEACypher::Key	signatureKey
BOOL	ignoreSignatures
PTime	compilationDate
PString	manufacturersHomePage
PString	manufacturersEmail
PString	productNameHTML
PString	gifHTML
PString	copyrightHolder
PString	copyrightHomePage
PString	copyrightEmail
PThread *	restartThread
ThreadList	httpThreads
PMutex	httpThreadsMutex
Friends
class	PConfigPage
class	PConfigSectionsPage
class	PHTTPServiceThread
Classes
struct	Info

---

Member Enumeration Documentation

anonymous enum

Enumerator:

MaxSecuredKeys

---

Constructor & Destructor Documentation

PHTTPServiceProcess::PHTTPServiceProcess

(

const Info &

inf

)

PHTTPServiceProcess::~PHTTPServiceProcess

(

)

---

Member Function Documentation

BOOL PHTTPServiceProcess::OnStart

(

)

[virtual]

Called when the service is started. This typically initialises the service and returns TRUE if the service is ready to run. The Main()# function is then executed.

Returns:

TRUE if service may start, FALSE if an initialisation failure occurred.

Implements PServiceProcess.

void PHTTPServiceProcess::OnStop

(

)

[virtual]

Called by the system when the service is stopped. One return from this function there is no guarentee that any more user code will be executed. Any cleaning up or closing of resource must be done in here.

Reimplemented from PServiceProcess.

BOOL PHTTPServiceProcess::OnPause

(

)

[virtual]

Called by the system when the service is to be paused. This will suspend any actions that the service may be executing. Usually this is less expensive in resource allocation etc than stopping and starting the service.

Returns:

TRUE if the service was successfully paused.

Reimplemented from PServiceProcess.

void PHTTPServiceProcess::OnContinue

(

)

[virtual]

Resume after the service was paused.

Reimplemented from PServiceProcess.

const char* PHTTPServiceProcess::GetServiceDependencies

(

)

const

virtual void PHTTPServiceProcess::OnConfigChanged

(

)

[pure virtual]

virtual BOOL PHTTPServiceProcess::Initialise

(

const char *

initMsg

)

[pure virtual]

BOOL PHTTPServiceProcess::ListenForHTTP	(	WORD	port,
		PSocket::Reusability	reuse = PSocket::CanReuseAddress,
		PINDEX	stackSize = 0x4000
	)

BOOL PHTTPServiceProcess::ListenForHTTP	(	PSocket *	listener,
		PSocket::Reusability	reuse = PSocket::CanReuseAddress,
		PINDEX	stackSize = 0x4000
	)

virtual PString PHTTPServiceProcess::GetPageGraphic

(

)

[virtual]

void PHTTPServiceProcess::GetPageHeader

(

PHTML &

)

void PHTTPServiceProcess::GetPageHeader	(	PHTML &	,
		const PString &	title
	)

virtual PString PHTTPServiceProcess::GetCopyrightText

(

)

[virtual]

const PString& PHTTPServiceProcess::GetMacroKeyword

(

)

const [inline]

const PTime& PHTTPServiceProcess::GetCompilationDate

(

)

const [inline]

const PString& PHTTPServiceProcess::GetHomePage

(

)

const [inline]

const PString& PHTTPServiceProcess::GetEMailAddress

(

)

const [inline]

const PString& PHTTPServiceProcess::GetProductName

(

)

const [inline]

const PTEACypher::Key& PHTTPServiceProcess::GetProductKey

(

)

const [inline]

const PStringArray& PHTTPServiceProcess::GetSecuredKeys

(

)

const [inline]

const PTEACypher::Key& PHTTPServiceProcess::GetSignatureKey

(

)

const [inline]

BOOL PHTTPServiceProcess::ShouldIgnoreSignatures

(

)

const [inline]

void PHTTPServiceProcess::SetIgnoreSignatures

(

BOOL

ig

)

[inline]

static PHTTPServiceProcess& PHTTPServiceProcess::Current

(

)

[static]

Get the current service process object.

Returns:

Pointer to service process.

Reimplemented from PServiceProcess.

virtual void PHTTPServiceProcess::AddRegisteredText

(

PHTML &

html

)

[virtual]

virtual void PHTTPServiceProcess::AddUnregisteredText

(

PHTML &

html

)

[virtual]

virtual BOOL PHTTPServiceProcess::SubstituteEquivalSequence	(	PHTTPRequest &	request,
		const PString &	,
		PString &
	)			[virtual]

virtual PHTTPServer* PHTTPServiceProcess::CreateHTTPServer

(

PTCPSocket &

socket

)

[virtual]

Reimplemented in PSecureHTTPServiceProcess.

virtual PHTTPServer* PHTTPServiceProcess::OnCreateHTTPServer

(

const PHTTPSpace &

urlSpace

)

[virtual]

PTCPSocket* PHTTPServiceProcess::AcceptHTTP

(

)

BOOL PHTTPServiceProcess::ProcessHTTP

(

PTCPSocket &

socket

)

void PHTTPServiceProcess::ShutdownListener

(

)

[protected]

void PHTTPServiceProcess::BeginRestartSystem

(

)

[protected]

void PHTTPServiceProcess::CompleteRestartSystem

(

)

[protected]

PHTTPServiceProcess::PLIST	(	ThreadList	,
		PHTTPServiceThread
	)			[protected]

---

Friends And Related Function Documentation

friend class PConfigPage [friend]

friend class PConfigSectionsPage [friend]

friend class PHTTPServiceThread [friend]

---

Member Data Documentation

PSocket* PHTTPServiceProcess::httpListeningSocket [protected]

PHTTPSpace PHTTPServiceProcess::httpNameSpace [protected]

PString PHTTPServiceProcess::macroKeyword [protected]

PTEACypher::Key PHTTPServiceProcess::productKey [protected]

PStringArray PHTTPServiceProcess::securedKeys [protected]

PTEACypher::Key PHTTPServiceProcess::signatureKey [protected]

BOOL PHTTPServiceProcess::ignoreSignatures [protected]

PTime PHTTPServiceProcess::compilationDate [protected]

PString PHTTPServiceProcess::manufacturersHomePage [protected]

PString PHTTPServiceProcess::manufacturersEmail [protected]

PString PHTTPServiceProcess::productNameHTML [protected]

PString PHTTPServiceProcess::gifHTML [protected]

PString PHTTPServiceProcess::copyrightHolder [protected]

PString PHTTPServiceProcess::copyrightHomePage [protected]

PString PHTTPServiceProcess::copyrightEmail [protected]

PThread* PHTTPServiceProcess::restartThread [protected]

ThreadList PHTTPServiceProcess::httpThreads [protected]

PMutex PHTTPServiceProcess::httpThreadsMutex [protected]

---

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

• httpsvc.h

---