Some added documentation

This commit is contained in:
Michael 2016-11-27 01:11:22 +00:00
parent e856ab9a09
commit d71321c834

View file

@ -311,6 +311,11 @@ function poller_kill_stale_workers() {
} }
} }
/**
* @brief Checks if the number of active workers exceeds the given limits
*
* @return bool Are there too much workers running?
*/
function poller_too_much_workers() { function poller_too_much_workers() {
@ -389,6 +394,11 @@ function poller_too_much_workers() {
return($active >= $queues); return($active >= $queues);
} }
/**
* @brief Returns the number of active poller processes
*
* @return integer Number of active poller processes
*/
function poller_active_workers() { function poller_active_workers() {
$workers = q("SELECT COUNT(*) AS `processes` FROM `process` WHERE `command` = 'poller.php'"); $workers = q("SELECT COUNT(*) AS `processes` FROM `process` WHERE `command` = 'poller.php'");
@ -478,6 +488,9 @@ function poller_worker_process() {
return $r; return $r;
} }
/**
* @brief Call the front end worker
*/
function call_worker() { function call_worker() {
if (!get_config("system", "frontend_worker")) { if (!get_config("system", "frontend_worker")) {
return; return;
@ -487,6 +500,9 @@ function call_worker() {
fetch_url($url, false, $redirects, 1); fetch_url($url, false, $redirects, 1);
} }
/**
* @brief Call the front end worker if there aren't any active
*/
function call_worker_if_idle() { function call_worker_if_idle() {
if (!get_config("system", "frontend_worker")) { if (!get_config("system", "frontend_worker")) {
return; return;
@ -503,11 +519,19 @@ function call_worker_if_idle() {
} }
} }
/**
* @brief Removes long running worker processes
*/
function clear_worker_processes() { function clear_worker_processes() {
/// @todo the 10 minutes needs to be configurable
/// Additionally we should clean up the corresponding workerqueue entries as well
q("DELETE FROM `process` WHERE `created` < '%s' AND `command` = 'worker.php'", q("DELETE FROM `process` WHERE `created` < '%s' AND `command` = 'worker.php'",
dbesc(datetime_convert('UTC','UTC',"now - 10 minutes"))); dbesc(datetime_convert('UTC','UTC',"now - 10 minutes")));
} }
/**
* @brief Runs the cron processes
*/
function poller_run_cron() { function poller_run_cron() {
// Run the cron job that calls all other jobs // Run the cron job that calls all other jobs
proc_run(PRIORITY_MEDIUM, "include/cron.php"); proc_run(PRIORITY_MEDIUM, "include/cron.php");