[Process] clarify idle timeout

Tobion · Tobion · commit 9f07b4db2543 · 2014-01-21T10:48:43.000+01:00
diff --git a/src/Symfony/Component/Process/Process.php b/src/Symfony/Component/Process/Process.php
@@ -730,7 +730,7 @@ public function setCommandLine($commandline)
     }
 
     /**
-     * Gets the process timeout.
+     * Gets the process timeout (max. runtime).
      *
      * @return float|null The timeout in seconds or null if it's disabled
      */
@@ -740,17 +740,17 @@ public function getTimeout()
     }
 
     /**
-     * Gets the process idle timeout.
+     * Gets the process idle timeout (max. time since last output).
      *
-     * @return float|null
+     * @return float|null The timeout in seconds or null if it's disabled
      */
     public function getIdleTimeout()
     {
         return $this->idleTimeout;
     }
 
     /**
-     * Sets the process timeout.
+     * Sets the process timeout (max. runtime).
      *
      * To disable the timeout, set this value to null.
      *
@@ -768,9 +768,11 @@ public function setTimeout($timeout)
     }
 
     /**
-     * Sets the process idle timeout.
+     * Sets the process idle timeout (max. time since last output).
      *
-     * @param integer|float|null $timeout
+     * To disable the timeout, set this value to null.
+     *
+     * @param integer|float|null $timeout The timeout in seconds
      *
      * @return self The current Process instance.
      *
@@ -991,7 +993,7 @@ public function checkTimeout()
             throw new ProcessTimedOutException($this, ProcessTimedOutException::TYPE_GENERAL);
         }
 
-        if (0 < $this->idleTimeout && $this->idleTimeout < microtime(true) - $this->lastOutputTime) {
+        if (null !== $this->idleTimeout && $this->idleTimeout < microtime(true) - $this->lastOutputTime) {
             $this->stop(0);
 
             throw new ProcessTimedOutException($this, ProcessTimedOutException::TYPE_IDLE);

Original file line number	Diff line number	Diff line change
`@@ -730,7 +730,7 @@ public function setCommandLine($commandline)`
`730`	`730`	`}`
`731`	`731`
`732`	`732`	`/**`
`733`		`- * Gets the process timeout.`
	`733`	`+ * Gets the process timeout (max. runtime).`
`734`	`734`	`*`
`735`	`735`	`* @return float\|null The timeout in seconds or null if it's disabled`
`736`	`736`	`*/`
`@@ -740,17 +740,17 @@ public function getTimeout()`
`740`	`740`	`}`
`741`	`741`
`742`	`742`	`/**`
`743`		`- * Gets the process idle timeout.`
	`743`	`+ * Gets the process idle timeout (max. time since last output).`
`744`	`744`	`*`
`745`		`- * @return float\|null`
	`745`	`+ * @return float\|null The timeout in seconds or null if it's disabled`
`746`	`746`	`*/`
`747`	`747`	`public function getIdleTimeout()`
`748`	`748`	`{`
`749`	`749`	`return $this->idleTimeout;`
`750`	`750`	`}`
`751`	`751`
`752`	`752`	`/**`
`753`		`- * Sets the process timeout.`
	`753`	`+ * Sets the process timeout (max. runtime).`
`754`	`754`	`*`
`755`	`755`	`* To disable the timeout, set this value to null.`
`756`	`756`	`*`
`@@ -768,9 +768,11 @@ public function setTimeout($timeout)`
`768`	`768`	`}`
`769`	`769`
`770`	`770`	`/**`
`771`		`- * Sets the process idle timeout.`
	`771`	`+ * Sets the process idle timeout (max. time since last output).`
`772`	`772`	`*`
`773`		`- * @param integer\|float\|null $timeout`
	`773`	`+ * To disable the timeout, set this value to null.`
	`774`	`+ *`
	`775`	`+ * @param integer\|float\|null $timeout The timeout in seconds`
`774`	`776`	`*`
`775`	`777`	`* @return self The current Process instance.`
`776`	`778`	`*`
`@@ -991,7 +993,7 @@ public function checkTimeout()`
`991`	`993`	`throw new ProcessTimedOutException($this, ProcessTimedOutException::TYPE_GENERAL);`
`992`	`994`	`}`
`993`	`995`
`994`		`- if (0 < $this->idleTimeout && $this->idleTimeout < microtime(true) - $this->lastOutputTime) {`
	`996`	`+ if (null !== $this->idleTimeout && $this->idleTimeout < microtime(true) - $this->lastOutputTime) {`
`995`	`997`	`$this->stop(0);`
`996`	`998`
`997`	`999`	`throw new ProcessTimedOutException($this, ProcessTimedOutException::TYPE_IDLE);`