Add Client::getHost() and Client::wait_for_response_data()

Author: adoy

src/Adoy/FastCGI/Client.php

@@ -31,7 +31,7 @@ class ForbiddenException extends \Exception {}
  * Handles communication with a FastCGI application
  *
  * @author      Pierrick Charron <pierrick@adoy.net>
- * @version     1.0.0
+ * @version     1.0
  */
 class Client
 {
@@ -74,25 +74,25 @@ class Client
 
     /**
      * Socket
-     * @var Resource
+     * @var resource
      */
     private $_sock = null;
 
     /**
      * Host
-     * @var String
+     * @var string
      */
     private $_host = null;
 
     /**
      * Port
-     * @var Integer
+     * @var int
      */
     private $_port = null;
 
     /**
      * Keep Alive
-     * @var Boolean
+     * @var bool
      */
     private $_keepAlive = false;
 
@@ -112,43 +112,53 @@ class Client
 
     /**
      * Use persistent sockets to connect to backend
-     * @var Boolean
+     * @var bool
      */
     private $_persistentSocket = false;
 
     /**
      * Connect timeout in milliseconds
-     * @var Integer
+     * @var int
      */
     private $_connectTimeout = 5000;
 
     /**
      * Read/Write timeout in milliseconds
-     * @var Integer
+     * @var int
      */
     private $_readWriteTimeout = 5000;
 
     /**
      * Constructor
      *
-     * @param String $host Host of the FastCGI application
-     * @param Integer $port Port of the FastCGI application
+     * @param string $host Host of the FastCGI application
+     * @param int $port Port of the FastCGI application
      */
     public function __construct($host, $port)
     {
         $this->_host = $host;
         $this->_port = $port;
     }
 
+    /**
+     * Get host.
+     *
+     * @return string
+     */
+    public function getHost()
+    {
+        return $this->_host;
+    }
+
     /**
      * Define whether or not the FastCGI application should keep the connection
      * alive at the end of a request
      *
-     * @param Boolean $b true if the connection should stay alive, false otherwise
+     * @param bool $b true if the connection should stay alive, false otherwise
      */
     public function setKeepAlive($b)
     {
-        $this->_keepAlive = (boolean)$b;
+        $this->_keepAlive = (bool)$b;
         if (!$this->_keepAlive && $this->_sock) {
             fclose($this->_sock);
         }
@@ -157,7 +167,7 @@ public function setKeepAlive($b)
     /**
      * Get the keep alive status
      *
-     * @return Boolean true if the connection should stay alive, false otherwise
+     * @return bool true if the connection should stay alive, false otherwise
      */
     public function getKeepAlive()
     {
@@ -168,12 +178,12 @@ public function getKeepAlive()
      * Define whether or not PHP should attempt to re-use sockets opened by previous
      * request for efficiency
      *
-     * @param Boolean $b true if persistent socket should be used, false otherwise
+     * @param bool $b true if persistent socket should be used, false otherwise
      */
     public function setPersistentSocket($b)
     {
         $was_persistent = ($this->_sock && $this->_persistentSocket);
-        $this->_persistentSocket = (boolean)$b;
+        $this->_persistentSocket = (bool)$b;
         if (!$this->_persistentSocket && $was_persistent) {
             fclose($this->_sock);
         }
@@ -182,7 +192,7 @@ public function setPersistentSocket($b)
     /**
      * Get the pesistent socket status
      *
-     * @return Boolean true if the socket should be persistent, false otherwise
+     * @return bool true if the socket should be persistent, false otherwise
      */
     public function getPersistentSocket()
     {
@@ -193,7 +203,7 @@ public function getPersistentSocket()
     /**
      * Set the connect timeout
      *
-     * @param Integer  number of milliseconds before connect will timeout
+     * @param int  number of milliseconds before connect will timeout
      */
     public function setConnectTimeout($timeoutMs)
     {
@@ -203,7 +213,7 @@ public function setConnectTimeout($timeoutMs)
     /**
      * Get the connect timeout
      *
-     * @return Integer  number of milliseconds before connect will timeout
+     * @return int  number of milliseconds before connect will timeout
      */
     public function getConnectTimeout()
     {
@@ -213,7 +223,7 @@ public function getConnectTimeout()
     /**
      * Set the read/write timeout
      *
-     * @param Integer  number of milliseconds before read or write call will timeout
+     * @param int  number of milliseconds before read or write call will timeout
      */
     public function setReadWriteTimeout($timeoutMs)
     {
@@ -224,7 +234,7 @@ public function setReadWriteTimeout($timeoutMs)
     /**
      * Get the read timeout
      *
-     * @return Integer  number of milliseconds before read will timeout
+     * @return int  number of milliseconds before read will timeout
      */
     public function getReadWriteTimeout()
     {
@@ -234,8 +244,8 @@ public function getReadWriteTimeout()
     /**
      * Helper to avoid duplicating milliseconds to secs/usecs in a few places
      *
-     * @param Integer millisecond timeout
-     * @return Boolean
+     * @param int millisecond timeout
+     * @return bool
      */
     private function set_ms_timeout($timeoutMs) {
         if (!$this->_sock) {
@@ -270,9 +280,10 @@ private function connect()
     /**
      * Build a FastCGI packet
      *
-     * @param Integer $type Type of the packet
-     * @param String $content Content of the packet
-     * @param Integer $requestId RequestId
+     * @param int $type Type of the packet
+     * @param string $content Content of the packet
+     * @param int $requestId RequestId
+     * @return string
      */
     private function buildPacket($type, $content, $requestId = 1)
     {
@@ -291,9 +302,9 @@ private function buildPacket($type, $content, $requestId = 1)
     /**
      * Build an FastCGI Name value pair
      *
-     * @param String $name Name
-     * @param String $value Value
-     * @return String FastCGI Name value pair
+     * @param string $name Name
+     * @param string $value Value
+     * @return string FastCGI Name value pair
      */
     private function buildNvpair($name, $value)
     {
@@ -320,7 +331,7 @@ private function buildNvpair($name, $value)
     /**
      * Read a set of FastCGI Name value pairs
      *
-     * @param String $data Data containing the set of FastCGI NVPair
+     * @param string $data Data containing the set of FastCGI NVPair
      * @return array of NVPair
      */
     private function readNvpair($data, $length = null)
@@ -359,7 +370,7 @@ private function readNvpair($data, $length = null)
     /**
      * Decode a FastCGI Packet
      *
-     * @param String $data String containing all the packet
+     * @param string $data string containing all the packet
      * @return array
      */
     private function decodePacketHeader($data)
@@ -401,10 +412,11 @@ private function readPacket()
     }
 
     /**
-     * Get Informations on the FastCGI application
+     * Get Information on the FastCGI application
      *
      * @param array $requestedInfo information to retrieve
      * @return array
+     * @throws \Exception
      */
     public function getValues(array $requestedInfo)
     {
@@ -428,8 +440,11 @@ public function getValues(array $requestedInfo)
      * Execute a request to the FastCGI application
      *
      * @param array $params Array of parameters
-     * @param String $stdin Content
-     * @return String
+     * @param string $stdin Content
+     * @return string
+     * @throws ForbiddenException
+     * @throws TimedOutException
+     * @throws \Exception
      */
     public function request(array $params, $stdin)
     {
@@ -439,18 +454,20 @@ public function request(array $params, $stdin)
 
     /**
      * Execute a request to the FastCGI application asyncronously
-     * 
+     *
      * This sends request to application and returns the assigned ID for that request.
      *
      * You should keep this id for later use with wait_for_response(). Ids are chosen randomly
-     * rather than seqentially to guard against false-positives when using persistent sockets.
-     * In that case it is possible that a delayed response to a request made by a previous script 
-     * invocation comes back on this socket and is mistaken for response to request made with same ID
-     * during this request.
+     * rather than sequentially to guard against false-positives when using persistent sockets.
+     * In that case it is possible that a delayed response to a request made by a previous script
+     * invocation comes back on this socket and is mistaken for response to request made with same
+     * ID during this request.
      *
      * @param array $params Array of parameters
-     * @param String $stdin Content
-     * @return Integer
+     * @param string $stdin Content
+     * @return int
+     * @throws TimedOutException
+     * @throws \Exception
      */
     public function async_request(array $params, $stdin)
     {
@@ -508,14 +525,17 @@ public function async_request(array $params, $stdin)
     }
 
     /**
-     * Blocking call that waits for response to specific request
-     * 
-     * @param Integer $requestId
-     * @param Integer $timeoutMs [optional] the number of milliseconds to wait. Defaults to the ReadWriteTimeout value set.
-     * @return string  response body
+     * Blocking call that waits for response data of the specific request
+     *
+     * @param int $requestId
+     * @param int $timeoutMs [optional] the number of milliseconds to wait. Defaults to the ReadWriteTimeout value set.
+     * @return array response data
+     * @throws ForbiddenException
+     * @throws TimedOutException
+     * @throws \Exception
      */
-    public function wait_for_response($requestId, $timeoutMs = 0) {
-
+    public function wait_for_response_data($requestId, $timeoutMs = 0)
+    {
         if (!isset($this->_requests[$requestId])) {
             throw new \Exception('Invalid request id given');
         }
@@ -524,7 +544,7 @@ public function wait_for_response($requestId, $timeoutMs = 0) {
         if ($this->_requests[$requestId]['state'] == self::REQ_STATE_OK
             || $this->_requests[$requestId]['state'] == self::REQ_STATE_ERR
             ) {
-            return $this->_requests[$requestId]['response'];
+            return $this->_requests[$requestId];
         }
 
         if ($timeoutMs > 0) {
@@ -591,7 +611,22 @@ public function wait_for_response($requestId, $timeoutMs = 0) {
                 throw new \Exception('Role value not known [UNKNOWN_ROLE]');
                 break;
             case self::REQUEST_COMPLETE:
-                return $this->_requests[$requestId]['response'];
+                return $this->_requests[$requestId];
         }
     }
+
+    /**
+     * Blocking call that waits for response to specific request
+     *
+     * @param int $requestId
+     * @param int $timeoutMs [optional] the number of milliseconds to wait. Defaults to the ReadWriteTimeout value set.
+     * @return string The response content.
+     * @throws ForbiddenException
+     * @throws TimedOutException
+     * @throws \Exception
+     */
+    public function wait_for_response($requestId, $timeoutMs = 0)
+    {
+        return $this->wait_for_response_data($requestId, $timeoutMs)['response'];
+    }
 }