home *** CD-ROM | disk | FTP | other *** search
/ Cricao de Sites - 650 Layouts Prontos / WebMasters.iso / Servidores / xampp-win32-1.6.7-installer.exe / php / PEAR / System / Socket.php < prev   
Encoding:
PHP Script  |  2008-07-02  |  8.5 KB  |  370 lines
  1. <?php
  2. // +----------------------------------------------------------------------+
  3. // | PEAR :: System :: Socket                                             |
  4. // +----------------------------------------------------------------------+
  5. // | This source file is subject to version 3.0 of the PHP license,       |
  6. // | that is available at http://www.php.net/license/3_0.txt              |
  7. // | If you did not receive a copy of the PHP license and are unable      |
  8. // | to obtain it through the world-wide-web, please send a note to       |
  9. // | license@php.net so we can mail you a copy immediately.               |
  10. // +----------------------------------------------------------------------+
  11. // | Copyright (c) 2004 Michael Wallner <mike@iworks.at>                  |
  12. // +----------------------------------------------------------------------+
  13. //
  14. // $Id: Socket.php,v 1.2 2004/04/29 16:07:03 mike Exp $
  15.  
  16. /**
  17. * System::Socket
  18. * 
  19. * @author       Michael Wallner <mike@php.net>
  20. * @package      System_Socket
  21. * @category     System
  22. */
  23.  
  24. if (!defined('SYSTEM_SOCKET_ROOT')) {
  25.     define('SYSTEM_SOCKET_ROOT', dirname(__FILE__));
  26. }
  27.  
  28. require_once 'PEAR.php';
  29.  
  30. /** 
  31. * System_Socket
  32. *
  33. * The System_Socket class represents a socket resource and aims to provide a
  34. * thight ad robust API for handling those.  Beside that it implements a creator
  35. * for System_Socket_Connection and System_Socket_Listener.  You'd most probably
  36. * never use this class or an object of it directly, but the creator pattern.
  37. * However this doesn't mean that you do not need to know about its socket 
  38. * configuration options.
  39. * 
  40. * Example: Simple HTTP request to localhost
  41. * <code>
  42. *   require_once 'System/Socket/Creator.php';
  43. * 
  44. *   $conn = &System_Socket_Creator::createConnection(
  45. *       array('address' => '127.0.0.1')
  46. *   );
  47. *   if (PEAR::isError($conn)) {
  48. *       die($conn->getMessage());
  49. *   }
  50. * 
  51. *   $conn->writeLine('GET / HTTP/1.0');
  52. *   $conn->writeLine('Connection: close');
  53. *   $conn->writeLine();
  54. * 
  55. *   while ($data = $conn->read()) {
  56. *       echo $data;
  57. *   }
  58. * </code>
  59. * 
  60. * @author   Michael Wallner <mike@php.net>
  61. * @version  $Revision: 1.2 $
  62. * @access   public
  63. */
  64. class System_Socket
  65. {
  66.     /**
  67.     * Socket resource
  68.     * @access private
  69.     */
  70.     var $_rsrc = null;
  71.     
  72.     /**
  73.     * Blocking mode
  74.     * @access private
  75.     */
  76.     var $_blocking = true;
  77.     
  78.     /**
  79.     * Socket domain/family
  80.     * 
  81.     * AF_INET | AF_UNIX
  82.     * 
  83.     * @access   public
  84.     * @var      int
  85.     */
  86.     var $domain = AF_INET;
  87.     
  88.     /**
  89.     * Socket type
  90.     * 
  91.     * SOCK_DGRAM | SOCK_RAW | SOCK_RDM | SOCK_SEQPACKET | SOCK_STREAM
  92.     * 
  93.     * @access   public
  94.     * @var      int
  95.     */
  96.     var $type = SOCK_STREAM;
  97.     
  98.     /**
  99.     * Socket layer
  100.     * 
  101.     * SOL_SOCKET | SOL_TCP | SOL_UDP
  102.     * 
  103.     * @access   public
  104.     * @var      int
  105.     */
  106.     var $proto = SOL_TCP;
  107.     
  108.     /**
  109.     * Network address (IP) or file path for unix sockets
  110.     * 
  111.     * @access   public
  112.     * @var      string
  113.     */
  114.     var $address = '127.0.0.1';
  115.     
  116.     /**
  117.     * Port
  118.     * 
  119.     * @access   public
  120.     * @var      int
  121.     */
  122.     var $port = 80;
  123.     
  124.     /**
  125.     * Queuelength
  126.     * 
  127.     * @access   public
  128.     * @var      int
  129.     */
  130.     var $queueLength = SOMAXCONN;
  131.     
  132.     /**
  133.     * Constructor
  134.     * 
  135.     * @access   public
  136.     * @return   object  System_Socket
  137.     * @param    int     $resource       socket resource handle
  138.     */
  139.     function System_Socket($resource = null)
  140.     {
  141.         System_Socket::__construct($resource);
  142.     }
  143.     
  144.     /**
  145.     * ZE2 Constructor
  146.     * @ignore
  147.     */
  148.     function __construct($resource = null)
  149.     {
  150.         if (System_Socket::isResource($resource)) {
  151.             $this->_rsrc = $resource;
  152.             socket_getSockname($resource, $this->address, $this->port);
  153.         }
  154.     }
  155.     
  156.     /**
  157.     * Retrieve last socket error
  158.     * 
  159.     * See include/WinSock.h (Win32) and include/sys/errno.h (Un*x) for the 
  160.     * values of the error codes.  See also (win32|unix)_socket_constants.h 
  161.     * located in ext/sockets for all available SOCKET_E* constants.
  162.     *
  163.     * @static
  164.     * @access   public
  165.     * @return   object  PEAR_Error
  166.     */
  167.     function &lastError()
  168.     {
  169.         $error_code = socket_last_error();
  170.         return PEAR::raiseError(socket_strerror($error_code), $error_code);
  171.     }
  172.     
  173.     /**
  174.     * Get socket resource handle
  175.     *
  176.     * @access public
  177.     * @return int        resource handle
  178.     */
  179.     function getResource()
  180.     {
  181.         return $this->_rsrc;
  182.     }
  183.  
  184.     /**
  185.     * Create a socket resource
  186.     *
  187.     * Create the socket resource with the objects properties as parameters.
  188.     *
  189.     * @access public
  190.     * @return bool
  191.     */
  192.     function create()
  193.     {
  194.         if (!System_Socket::isResource($this->_rsrc)) {
  195.             if (!System_Socket::isResource(   
  196.                 $this->_rsrc = @socket_create(
  197.                     $this->domain, $this->type, $this->proto))) {
  198.                 //
  199.                 return false;
  200.             }
  201.         }
  202.         return true;
  203.     }
  204.     
  205.     /**
  206.     * Bind the socket resource
  207.     *
  208.     * Bind the socket resource to System_Socket::address at System_Socket::port.
  209.     *
  210.     * @access public
  211.     * @return bool
  212.     */
  213.     function bind()
  214.     {
  215.         return (bool) @socket_bind($this->_rsrc, $this->address, $this->port);
  216.     }
  217.     
  218.     /**
  219.     * Close the socket
  220.     *
  221.     * Close the socket resource handle.
  222.     *
  223.     * @access public
  224.     * @return void
  225.     */
  226.     function close()
  227.     {
  228.         @socket_close($this->_rsrc);
  229.         $this->_rsrc = null;
  230.     }
  231.     
  232.     /**
  233.     * @access public
  234.     */
  235.     function listen()
  236.     {
  237.         return @socket_listen($this->_rsrc, $this->queueLength);
  238.     }
  239.     
  240.     /**
  241.     * Accept a socket connection
  242.     *
  243.     * Accept a socket connection from a prior created socket resource handle.
  244.     *
  245.     * @access public
  246.     * @return mixed     new socket resource handle or false
  247.     */
  248.     function accept()
  249.     {
  250.         return @socket_accept($this->_rsrc);
  251.     }
  252.     
  253.     /**
  254.     * Connect the socket
  255.     *
  256.     * Connect the socket resource handle to System_Socket::address 
  257.     * at System_Socket::port.
  258.     *
  259.     * @access public
  260.     * @return bool
  261.     */
  262.     function connect()
  263.     {
  264.         return (bool) @socket_connect($this->_rsrc, $this->address, $this->port);
  265.     }
  266.     
  267.     /**
  268.     * Set socket option
  269.     *
  270.     * Set a socket option after you have created a socket resource handle.
  271.     *
  272.     * @access public
  273.     * @return bool
  274.     * @param  string $option
  275.     * @param  mixed  $value
  276.     * @param  int    $level
  277.     */
  278.     function setOption($option, $value, $level = SOL_SOCKET)
  279.     {
  280.         return socket_set_option($this->_rsrc, $level, $option, $value);
  281.     }
  282.     
  283.     /**
  284.     * Get socket option
  285.     *
  286.     * Retrieve a socket option after you have created the socket resource handle.
  287.     * 
  288.     * @access public
  289.     * @return mixed
  290.     * @param  string  $option
  291.     * @param  int     $level
  292.     */
  293.     function getOption($option, $level = SOL_SOCKET)
  294.     {
  295.         return socket_get_option($this->_rsrc, $level, $option);
  296.     }
  297.     
  298.     /**
  299.     * Get socket status
  300.     * 
  301.     * @access   public
  302.     * @return   mixed
  303.     * @param    string  $part
  304.     */
  305.     function getStatus($part = null)
  306.     {
  307.         $status = socket_get_status($this->_rsrc);
  308.         return isset($part) ? @$status[$part] : $status;
  309.     }
  310.     
  311.     /**
  312.     * Set socket blocking
  313.     * 
  314.     * @access   public
  315.     * @return   bool
  316.     * @param    bool    $blocking
  317.     */
  318.     function setBlocking($blocking)
  319.     {
  320.         if ($blocking) {
  321.             $rs = socket_set_block($this->_rsrc);
  322.             $this->_blocking = $rs;
  323.         } else {
  324.             $rs = socket_set_nonblock($this->_rsrc);
  325.             $this->_blocking = !$rs;
  326.         }
  327.         return $rs;
  328.     }
  329.     
  330.     /**
  331.     * Get socket blocking
  332.     * 
  333.     * @access public
  334.     * @return bool
  335.     */
  336.     function getBlocking()
  337.     {
  338.         return $this->_blocking;
  339.     }
  340.     
  341.     /**
  342.     * Check if a resource is still valid
  343.     * 
  344.     * Due to a nasty bug in PHP < 4.3.6 and 5.0.0 is_resource() would return
  345.     * true for a already closed socket, too.  So we check the resource type
  346.     * additionally to be really sure we have still a valid socket resource.
  347.     *
  348.     * @static
  349.     * @access   public
  350.     * @return   bool
  351.     * @param    resource    $rsrc
  352.     */
  353.     function isResource($rsrc)
  354.     {
  355.         return (is_resource($rsrc) && get_resource_type($rsrc) == 'Socket');
  356.     }
  357.     
  358.     /**
  359.     * Check if the we have still a valid socket resource
  360.     *
  361.     * @see      System_Socket::isResource()
  362.     * @access   public
  363.     * @return   bool
  364.     */
  365.     function hasResource()
  366.     {
  367.         return System_Socket::isResource($this->_rsrc);
  368.     }
  369. }
  370. ?>