Permalink
Browse files

Added documentation to remaining four undocumented methods in the Phe…

…anstalk class.
  • Loading branch information...
1 parent ea2ccc3 commit d1a004210216afddd58180b6f043d9fa26fc2a71 @pda pda committed Jan 27, 2010
Showing with 13 additions and 0 deletions.
  1. +13 −0 classes/Pheanstalk.php
View
@@ -298,6 +298,8 @@ public function reserve($timeout = null)
}
/**
+ * Gives statistical information about the specified job if it exists.
+ *
* @param Pheanstalk_Job or int $job
* @return object
*/
@@ -307,6 +309,8 @@ public function statsJob($job)
}
/**
+ * Gives statistical information about the specified tube if it exists.
+ *
* @param string $tube
* @return object
*/
@@ -316,6 +320,8 @@ public function statsTube($tube)
}
/**
+ * Gives statistical information about the beanstalkd system as a whole.
+ *
* @return object
*/
public function stats()
@@ -324,6 +330,13 @@ public function stats()
}
/**
+ * Allows a worker to request more time to work on a job.
+ *
+ * This is useful for jobs that potentially take a long time, but you still want
+ * the benefits of a TTR pulling a job away from an unresponsive worker. A worker
+ * may periodically tell the server that it's still alive and processing a job
+ * (e.g. it may do this on DEADLINE_SOON).
+ *
* @param Pheanstalk_Job $job
* @chainable
*/

0 comments on commit d1a0042

Please sign in to comment.