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 / Connection.php next >
Encoding:
PHP Script  |  2008-07-02  |  9.1 KB  |  368 lines
  1. <?php
  2. // +----------------------------------------------------------------------+
  3. // | PEAR :: System :: Socket :: Connection                               |
  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: Connection.php,v 1.1 2004/04/29 15:55:38 mike Exp $
  15.  
  16. /**
  17. * System::Socket::Connection
  18. * 
  19. * @author       Michael Wallner <mike@php.net>
  20. * @package      System_Socket
  21. * @category     System
  22. * @example      simple-debugger.php     Simple example for a HTTP connection
  23. */
  24.  
  25. if (!defined('SYSTEM_SOCKET_ROOT')) {
  26.     define('SYSTEM_SOCKET_ROOT', dirname(__FILE__) . '/..');
  27. }
  28.  
  29. require_once SYSTEM_SOCKET_ROOT . '/Socket/Manager.php';
  30.  
  31. /** 
  32. * System_Socket_Connection
  33. *
  34. * @author   Michael Wallner <mike@php.net>
  35. * @version  $Revision: 1.1 $
  36. * @access   public
  37. */
  38. class System_Socket_Connection extends System_Socket_Manager
  39. {
  40.     /**
  41.     * Connection ID
  42.     * @access   protected
  43.     * @var      string
  44.     */
  45.     var $ID = null;
  46.     
  47.     /**
  48.     * Peer host
  49.     * @access public
  50.     * @readonly
  51.     */
  52.     var $peerHost = '';
  53.     
  54.     /**
  55.     * Peer port
  56.     * @access public
  57.     * @readonly
  58.     */
  59.     var $peerPort = 0;
  60.     
  61.     /**
  62.     * Constructor
  63.     * 
  64.     * Instantiate a new System_Socket_Connection object with the underlying
  65.     * System_Socket object $socket.
  66.     *
  67.     * @access public
  68.     * @return object  System_Socket_Connection
  69.     * @param  object  $socket System_Socekt object
  70.     */
  71.     function System_Socket_Connection(&$socket)
  72.     {
  73.         System_Socket_Connection::__construct($socket);
  74.     }
  75.     
  76.     /**
  77.     * ZE2 Constructor
  78.     * @ignore
  79.     */
  80.     function __construct(&$socket)
  81.     {
  82.         parent::__construct($socket);
  83.         
  84.         if ($this->hasSocket) {
  85.             @socket_getPeername(
  86.                 $this->Socket->getResource(), 
  87.                 $this->peerHost, 
  88.                 $this->peerPort
  89.             );
  90.             
  91.             $this->ID = md5($this->peerHost . $this->peerPort . $this->Socket->getResource());
  92.         }
  93.     }
  94.     
  95.     /**
  96.     * Get connection ID
  97.     * 
  98.     * Each connection is represented by a unique id.
  99.     *
  100.     * @access   public
  101.     * @return   string
  102.     */
  103.     function getID()
  104.     {
  105.         return $this->ID;
  106.     }
  107.     
  108.     /**
  109.     * Check if wer're connected
  110.     * 
  111.     * Check if the System_Socket_Connection is still connected.  Actually we
  112.     * check if the underlying socket resource handle is still valid.
  113.     *
  114.     * @access   public
  115.     * @return   bool
  116.     */
  117.     function isConnected()
  118.     {
  119.         return ($this->hasSocket && $this->Socket->hasResource());
  120.     }
  121.     
  122.     /**
  123.     * Set socket blocking
  124.     * 
  125.     * Set the blocking mode of the underlying System_Socket.
  126.     * 
  127.     * @access   public
  128.     * @return   bool
  129.     */
  130.     function setBlocking($blocking)
  131.     {
  132.         return $this->notify(__FUNCTION__, 
  133.             $this->Socket->setBlocking($blocking), $blocking);
  134.     }
  135.     
  136.     /**
  137.     * Get socket blocking
  138.     * 
  139.     * Get the blocking mode of the underlying System_Socket.
  140.     * 
  141.     * @access   public
  142.     * @return   bool
  143.     */
  144.     function getBlocking()
  145.     {
  146.         return $this->notify(__FUNCTION__, $this->Socket->getBlocking());
  147.     }
  148.     
  149.     /**
  150.     * Write through connection
  151.     *
  152.     * Write data through the socket connection.
  153.     *
  154.     * @access public
  155.     * @return mixed  int bytes written or false
  156.     * @param  string $data
  157.     */
  158.     function write($data)
  159.     {
  160.         return $this->notify(__FUNCTION__, 
  161.             @socket_write($this->Socket->getResource(), $data), $data);
  162.     }
  163.     
  164.     /**
  165.     * Write char (chr(byte))
  166.     * 
  167.     * @access   public
  168.     * @return   mixed
  169.     * @param    string  $char
  170.     */
  171.     function writeChar($char)
  172.     {
  173.         $this->notify(__FUNCTION__, $this->write($char), $char);
  174.     }
  175.     
  176.     /**
  177.     * Write byte
  178.     * 
  179.     * @access   public
  180.     * @return   mixed
  181.     * @param    int     $byte
  182.     */
  183.     function writeByte($byte)
  184.     {
  185.         return $this->notify(__FUNCTION__, $this->write(chr($byte)), $byte);
  186.     }
  187.     
  188.     /**
  189.     * Write data with ending delimter
  190.     * 
  191.     * Write a string terminated by the specified delimiter
  192.     * 
  193.     * @access   public
  194.     * @return   mixed
  195.     * @oaram    string  $data   data to write
  196.     * @param    string  $delim  delimiter to append
  197.     * @param    bool    $escape whether to escape all delimiter characters
  198.     *                           ($delim) conatained in $data
  199.     */
  200.     function writeDelim($data, $delim, $escape = true)
  201.     {
  202.         if ($escape) {
  203.             $data = addCSlashes($data, $delim);
  204.         }
  205.         return $this->notify(__FUNCTION__, 
  206.             $this->write($data . $delim), $data, $delim, $escape);
  207.     }
  208.     
  209.     /**
  210.     * Write a line
  211.     * 
  212.     * Write a line of data terminated with the specified linefeed character.
  213.     * 
  214.     * @access   public
  215.     * @return   mixed
  216.     * @param    string  $line   line of data
  217.     * @param    string  $LF     linefeed character
  218.     * @param    bool    $escape whether to escape all linefeed
  219.     *                           characters ($LF) contained in $line
  220.     */
  221.     function writeLine($line = '', $LF = "\n", $escape = true)
  222.     {
  223.         return $this->notify(__FUNCTION__, 
  224.             $this->writeDelim($line, $LF, $escape), $line, $LF, $escape);
  225.     }
  226.     
  227.     /**
  228.     * Write integer
  229.     * 
  230.     * Write an 32 bit network byte order integer (4 bytes).
  231.     * 
  232.     * @access   public
  233.     * @return   mixed
  234.     * @param    int     $int
  235.     */
  236.     function writeInt($int)
  237.     {
  238.         return $this->notify(__FUNCTION__, 
  239.             $this->write(pack('V', $int)), $int);
  240.     }
  241.     
  242.     /**
  243.     * Write string terminated by NUL
  244.     * 
  245.     * Write a string which will be terminated by a NUL byte.
  246.     * 
  247.     * @access   public
  248.     * @return   mixed
  249.     * @param    string  $string the string to write
  250.     * @param    bool    $escape wheter to escape all NULs in $string
  251.     */
  252.     function writeString($string, $escape = true)
  253.     {
  254.         return $this->notify(__FUNCTION__, 
  255.             $this->writeDelim($string, "\0", $escape), $string, $escape);
  256.     }
  257.     
  258.     /**
  259.     * Read through connection
  260.     *
  261.     * Attempts to read $length length of data through the socket connection.
  262.     * 
  263.     * @access public
  264.     * @return mixed read data or false
  265.     * @param  int   bytes to read
  266.     */
  267.     function read($length = 4096)
  268.     {
  269.         return $this->notify(__FUNCTION__, 
  270.             @socket_read($this->Socket->getResource(), abs($length)), $length);
  271.     }
  272.     
  273.     /**
  274.     * Read char
  275.     * 
  276.     * Reads a single character from the socket resource.
  277.     * 
  278.     * @access   public
  279.     * @return   string
  280.     */
  281.     function readChar()
  282.     {
  283.         return $this->notify(__FUNCTION__, $this->read(1));
  284.     }
  285.     
  286.     /**
  287.     * Read byte
  288.     * 
  289.     * Reads a byte from the socket and returns its integer representation.
  290.     * 
  291.     * @access   public
  292.     * @return   int
  293.     */
  294.     function readByte()
  295.     {
  296.         return $this->notify(__FUNCTION__, ord($this->readChar()));
  297.     }
  298.     
  299.     /**
  300.     * Read until delimiter
  301.     * 
  302.     * Reads from the socket until the first occurence of the delimiter $delim.
  303.     * Be aware that the delimiter is part of the returned string.
  304.     * 
  305.     * @access   public
  306.     * @return   string
  307.     * @param    string  $delim  1 character string
  308.     * @param    string  $escape escape character
  309.     */
  310.     function readDelim($delim, $escape = '\\')
  311.     {
  312.         $escape = $escape{0};
  313.         $delim  = $delim{0};
  314.         $buffer = '';
  315.         $char   = null;
  316.  
  317.         do {
  318.             $last = $char;
  319.             $char = $this->readChar();
  320.             $buffer .= $char;
  321.         } while ($delim !== $char && $last !== $escape);
  322.         
  323.         return $this->notify(__FUNCTION__, $buffer, $delim);
  324.     }
  325.     
  326.     /**
  327.     * Read line
  328.     * 
  329.     * Be aware, that the linefeed character doesn't get truncated.
  330.     * 
  331.     * @access   public
  332.     * @return   string
  333.     * @param    string  $LF
  334.     */
  335.     function readLine($LF = "\n")
  336.     {
  337.         return $this->notify(__FUNCTION__, $this->readDelim($LF));
  338.     }
  339.     
  340.     /**
  341.     * Read integer
  342.     * 
  343.     * Read a 32 bit network byte order integer (4 bytes).
  344.     * 
  345.     * @access   public
  346.     * @return   int
  347.     */
  348.     function readInt()
  349.     {
  350.         return $this->notify(__FUNCTION__, 
  351.             array_shift(unpack('V', $this->read(4))));
  352.     }
  353.     
  354.     /**
  355.     * Read NUL terminated string
  356.     * 
  357.     * Reads a string terminated wit a NUL byte from the socket resource.
  358.     * Be aware, that the NUL byte will *NOT* be truncated.
  359.     * 
  360.     * @access   public
  361.     * @return   string
  362.     */
  363.     function readString()
  364.     {
  365.         return $this->notify(__FUNCTION__, $this->readDelim("\0"));
  366.     }
  367. }
  368. ?>