nanoserv
[ class tree: nanoserv ] [ index: nanoserv ] [ all elements ]
Packages:
nanoserv

Source for file NS_Telnet_Line_Input_Handler.php

Documentation is available at NS_Telnet_Line_Input_Handler.php

  1. <?php
  2.  
  3. /**
  4.  *
  5.  * nanoserv handlers - Telnet with line based input protocol handler
  6.  * 
  7.  * Copyright (C) 2004-2010 Vincent Negrier aka. sIX <six@aegis-corp.org>
  8.  * 
  9.  * This library is free software; you can redistribute it and/or
  10.  * modify it under the terms of the GNU Lesser General Public
  11.  * License as published by the Free Software Foundation; either
  12.  * version 2.1 of the License, or (at your option) any later version.
  13.  * 
  14.  * This library is distributed in the hope that it will be useful,
  15.  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  16.  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  17.  * Lesser General Public License for more details.
  18.  * 
  19.  * You should have received a copy of the GNU Lesser General Public
  20.  * License along with this library; if not, write to the Free Software
  21.  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA *
  22.  *
  23.  * @package nanoserv
  24.  * @subpackage Handlers
  25.  */
  26.  
  27. /**
  28.  * Require the Telnet protocol handler
  29.  */
  30. require_once "nanoserv-compat/handlers/NS_Telnet_Handler.php";
  31.  
  32. /**
  33.  * Telnet with line input protocol handler handler class
  34.  *
  35.  * @package nanoserv
  36.  * @subpackage Handlers
  37.  */
  38. abstract class NS_Telnet_Line_Input_Connection extends NS_Telnet_Handler {
  39.  
  40.     /**
  41.      * Maximum line length
  42.      */
  43.     const MAX_LENGTH = 16384;
  44.     
  45.     /**
  46.      * Line separator
  47.      */
  48.     const EOL_SEPARATOR = "\n";
  49.     
  50.     /**
  51.      * Line buffer
  52.      * @var string 
  53.      */
  54.     private $line_buffer = "";
  55.     
  56.     /**
  57.      * Telnet read event
  58.      *
  59.      * This event is called every time there is data received
  60.      * The behavior of on_Telnet_Read() is to buffer data until a complete line in available
  61.      * and then pass it to on_Telnet_Read_Line().
  62.      *
  63.      * @param string $s 
  64.      */
  65.     public function on_Telnet_Read($data) {
  66.  
  67.         $this->line_buffer .= $data;
  68.  
  69.         while (($p = strrpos($this->line_buffer, self::EOL_SEPARATOR)) !== false) {
  70.  
  71.             $lines = explode(self::EOL_SEPARATOR, substr($this->line_buffer, 0, $p));
  72.             $this->line_buffer = substr($this->line_buffer, $p + strlen(self::EOL_SEPARATOR));
  73.  
  74.             foreach ($lines as $line) $this->on_Telnet_Read_Line(rtrim($line, "\r\n").self::EOL_SEPARATOR);
  75.         
  76.         }
  77.     
  78.         if (strlen($this->line_buffer) > self::MAX_LENGTH) {
  79.  
  80.             $this->on_Telnet_Read_Line($this->line_buffer);
  81.             $this->line_buffer = "";
  82.         
  83.         }
  84.     
  85.     }
  86.  
  87.     /**
  88.      * Telnet line read event
  89.      *
  90.      * This event is called every time there is a line of data received
  91.      *
  92.      * @param string $s 
  93.      */
  94.     abstract public function on_Telnet_Read_Line($s);
  95.  
  96. }
  97.  
  98. ?>
Documentation generated on Wed, 30 Nov 2011 22:03:26 +0100 by phpDocumentor 1.4.3