Cleanup phpdoc comments
[civicrm-core.git] / CRM / Utils / Network.php
1 <?php
2 /*
3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.5 |
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2014 |
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-2014
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 seconds
46 * @param float $interval seconds to wait in between pollings
47 *
48 * @return bool TRUE if service is online
49 */
50 public static function waitForServiceStartup($host, $port, $serverStartupTimeOut, $interval = 0.333) {
51 $start = time();
52 $end = $start + $serverStartupTimeOut;
53 $found = FALSE;
54 $interval_usec = (int) 1000000 * $interval;
55
56 while (!$found && $end >= time()) {
57 $found = self::checkService($host, $port, $end - time());
58 if ($found) {
59 return TRUE;
60 }
61 usleep($interval_usec);
62 }
63 return FALSE;
64 }
65
66 /**
67 * Check whether a TCP service is available on $host and $port
68 */
69 public static function checkService($host, $port, $serverConnectionTimeOut) {
70 $old_error_reporting = error_reporting();
71 error_reporting($old_error_reporting & ~E_WARNING);
72 try {
73 $fh = fsockopen($host, $port, $errno, $errstr, $serverConnectionTimeOut);
74 if ($fh) {
75 fclose($fh);
76 error_reporting($old_error_reporting);
77 return TRUE;
78 }
79 } catch (Exception $e) {
80 }
81 error_reporting($old_error_reporting);
82 return FALSE;
83 }
84 }