Inheritance diagram for OMVRpcBgStatus:

Public Member Functions
	__construct ($status)

	getPid ()

	isRunning ()

	hasError ()

	getError ()

	hasOutputFilename ()

	getOutputFilename ()

	get ($key)

	set ($key, $value)

Public Member Functions inherited from OMVObject
	__construct ()

	getLastError ()

Additional Inherited Members
Protected Member Functions inherited from OMVObject
	setLastError ($error)

	debug ()

Detailed Description

Helper class to handle the background process status.

Constructor & Destructor Documentation

OMVRpcBgStatus::__construct ( $status )

Constructor

Parameters

status An array of status informations.

OMVRpcBgStatus::get ( $key )

Helper method to access the status fields.

Parameters

key	The name of the status field.

OMVRpcBgStatus::getError ( )

Get the error object.

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

OMVRpcBgStatus::getOutputFilename ( )

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

OMVRpcBgStatus::getPid ( )

Get the PID of the background process.

OMVRpcBgStatus::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.

OMVRpcBgStatus::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.

OMVRpcBgStatus::isRunning ( )

Check whether the background process is running.

Helper method to set the status fields.

Parameters

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

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