CRM/Utils/Network.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 4.6                                                |
   5  +--------------------------------------------------------------------+
   6  | Copyright CiviCRM LLC (c) 2004-2015                                |
   7  +--------------------------------------------------------------------+
   8  | This file is a part of CiviCRM.                                    |
   9  |                                                                    |
  10  | CiviCRM is free software; you can copy, modify, and distribute it  |
  11  | under the terms of the GNU Affero General Public License           |
  12  | Version 3, 19 November 2007 and the CiviCRM Licensing Exception.   |
  13  |                                                                    |
  14  | CiviCRM is distributed in the hope that it will be useful, but     |
  15  | WITHOUT ANY WARRANTY; without even the implied warranty of         |
  16  | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.               |
  17  | See the GNU Affero General Public License for more details.        |
  18  |                                                                    |
  19  | You should have received a copy of the GNU Affero General Public   |
  20  | License and the CiviCRM Licensing Exception along                  |
  21  | with this program; if not, contact CiviCRM LLC                     |
  22  | at info[AT]civicrm[DOT]org. If you have questions about the        |
  23  | GNU Affero General Public License or the licensing of CiviCRM,     |
  24  | see the CiviCRM license FAQ at http://civicrm.org/licensing        |
  25  +--------------------------------------------------------------------+
  26  */
  27
  28 /**
  29  *
  30  * @package CRM
  31  * @copyright CiviCRM LLC (c) 2004-2015
  32  * $Id: $
  33  *
  34  */
  35
  36 /**
  37  * Simple static helpers for network operations
  38  */
  39 class CRM_Utils_Network {
  40   /**
  41    * Try connecting to a TCP service; if it fails, retry. Repeat until serverStartupTimeOut elapses.
  42    *
  43    * @param $host
  44    * @param $port
  45    * @param int $serverStartupTimeOut
  46    *   Seconds.
  47    * @param float $interval
  48    *   Seconds to wait in between pollings.
  49    *
  50    * @return bool
  51    *   TRUE if service is online
  52    */
  53   public static function waitForServiceStartup($host, $port, $serverStartupTimeOut, $interval = 0.333) {
  54     $start = time();
  55     $end = $start + $serverStartupTimeOut;
  56     $found = FALSE;
  57     $interval_usec = (int) 1000000 * $interval;
  58
  59     while (!$found && $end >= time()) {
  60       $found = self::checkService($host, $port, $end - time());
  61       if ($found) {
  62         return TRUE;
  63       }
  64       usleep($interval_usec);
  65     }
  66     return FALSE;
  67   }
  68
  69   /**
  70    * Check whether a TCP service is available on $host and $port
  71    */
  72   public static function checkService($host, $port, $serverConnectionTimeOut) {
  73     $old_error_reporting = error_reporting();
  74     error_reporting($old_error_reporting & ~E_WARNING);
  75     try {
  76       $fh = fsockopen($host, $port, $errno, $errstr, $serverConnectionTimeOut);
  77       if ($fh) {
  78         fclose($fh);
  79         error_reporting($old_error_reporting);
  80         return TRUE;
  81       }
  82     }
  83     catch (Exception $e) {
  84     }
  85     error_reporting($old_error_reporting);
  86     return FALSE;
  87   }
  88
  89 }