OMV\Rpc\BgStatusFile Class Reference

Public Member Functions
	__construct ($status)
	getPid ()
	isRunning ()
	hasError ()
	getError ()
	hasOutputFilename ()
	getOutputFilename ()
	get ($key)
	set ($key, $value)

Detailed Description

Helper class to handle the background process status.

Constructor & Destructor Documentation

__construct()

OMV\Rpc\BgStatusFile::__construct

(

$status

)

Constructor

Parameters

status

An array of status informations.

Member Function Documentation

get()

OMV\Rpc\BgStatusFile::get

(

$key

)

Helper method to access the status fields.

Parameters

key	The name of the status field.

Returns

The value of the given status field.

getError()

OMV\Rpc\BgStatusFile::getError

(

)

Get the error object.

Returns

The error object containing the fields code, message and trace.

getOutputFilename()

OMV\Rpc\BgStatusFile::getOutputFilename

(

)

Get the name of the temporary file that contains the output of the background job.

Returns

Returns the name of the temporary file.

getPid()

OMV\Rpc\BgStatusFile::getPid

(

)

Get the PID of the background process.

Returns

The PID of the background process.

hasError()

OMV\Rpc\BgStatusFile::hasError

(

)

Check whether the background process is has thrown an error.

Returns

Returns TRUE if the background process has been thrown an error, otherwise FALSE.

hasOutputFilename()

OMV\Rpc\BgStatusFile::hasOutputFilename

(

)

Check whether the background process output is written to a temporary file.

Returns

Returns TRUE if the background process writes his output to a temporary file, otherwise FALSE.

isRunning()

OMV\Rpc\BgStatusFile::isRunning

(

)

Check whether the background process is running.

Returns

Returns TRUE if the background process is runnig, otherwise FALSE.

set()

OMV\Rpc\BgStatusFile::set	(		$key,
			$value
	)

Helper method to set the status fields.

Parameters

key	The name of the status field.
value	The value of the status field.

Returns

The value of the given status field.

---

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

• bgstatusfile.inc