PServiceProcess Class Reference

#include <svcproc.h>

Inheritance diagram for PServiceProcess:


Miscellaneous functions
void	SetLogLevel (PSystemLog::Level level)
PSystemLog::Level	GetLogLevel () const
static PServiceProcess &	Current ()
Public Member Functions
virtual int	_main (void *arg=NULL)
	Main function for process, called from real main after initialisation.
	~PServiceProcess ()
virtual void	Terminate ()
Callback functions
virtual PBoolean	OnStart ()=0
virtual void	OnStop ()
virtual PBoolean	OnPause ()
virtual void	OnContinue ()
virtual void	OnControl ()=0
Protected Member Functions
int	InitialiseService ()
void	_PXShowSystemWarning (PINDEX num, const PString &str)
void	PXOnSignal (int)
void	PXOnAsyncSignal (int)
Protected Attributes
PBoolean	debugMode
	Flag to indicate service is run in simulation mode.
PSystemLog::Level	currentLogLevel
	Current log level for PSYSTEMLOG# calls.
PString	systemLogFileName
PString	pidFileToRemove
PBoolean	isTerminating
Friends
void	PSystemLog::Output (PSystemLog::Level, const char *)

Detailed Description

A process type that runs as a "background" service. This may be a service under the Windows NT operating system, or a "daemon" under Unix, or a hidden application under Windows.

Constructor & Destructor Documentation

PServiceProcess::PServiceProcess	(	const char *	manuf,
		const char *	name,
		WORD	majorVersion,
		WORD	minorVersion,
		CodeStatus	status,
		WORD	buildNumber
	)

Create a new service process.

Parameters:

manuf	Name of manufacturer
name	Name of product
majorVersion	Major version number of the product
minorVersion	Minor version number of the product
status	Development status of the product
buildNumber	Build number of the product

PServiceProcess::~PServiceProcess ( )

PServiceProcess::PServiceProcess	(	const char *	manuf,
		const char *	name,
		WORD	majorVersion,
		WORD	minorVersion,
		CodeStatus	status,
		WORD	buildNumber
	)

Create a new service process.

Parameters:

manuf	Name of manufacturer
name	Name of product
majorVersion	Major version number of the product
minorVersion	Minor version number of the product
status	Development status of the product
buildNumber	Build number of the product

Member Function Documentation

virtual PBoolean PServiceProcess::OnStart ( ) [pure virtual]

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

Returns:: PTrue if service may start, PFalse if an initialisation failure occurred.

Implemented in PHTTPServiceProcess.

virtual void PServiceProcess::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 in PHTTPServiceProcess.

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