application/hub/classes/visitor/pool/monitor/class_RawDataPoolMonitorVisitor.php

   1 <?php
   2 /**
   3  * A RawDataMonitor visitor
   4  *
   5  * @author              Roland Haeder <webmaster@shipsimu.org>
   6  * @version             0.0.0
   7  * @copyright   Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2015 Hub Developer Team
   8  * @license             GNU GPL 3.0 or any newer version
   9  * @link                http://www.shipsimu.org
  10  *
  11  * This program is free software: you can redistribute it and/or modify
  12  * it under the terms of the GNU General Public License as published by
  13  * the Free Software Foundation, either version 3 of the License, or
  14  * (at your option) any later version.
  15  *
  16  * This program is distributed in the hope that it will be useful,
  17  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  19  * GNU General Public License for more details.
  20  *
  21  * You should have received a copy of the GNU General Public License
  22  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  23  */
  24 class RawDataPoolMonitorVisitor extends BaseVisitor implements PoolVisitor, ListenerVisitor {
  25         /**
  26          * Protected constructor
  27          *
  28          * @return      void
  29          */
  30         protected function __construct () {
  31                 // Call parent constructor
  32                 parent::__construct(__CLASS__);
  33
  34                 // Set visitor mode
  35                 $this->setVisitorMode('monitor');
  36         }
  37
  38         /**
  39          * Creates an instance of this class
  40          *
  41          * @param       $receiverInstance       An instance of a Receivable class
  42          * @return      $visitorInstance        An instance of a Visitorable class
  43          */
  44         public final static function createRawDataPoolMonitorVisitor () {
  45                 // Get new instance
  46                 $visitorInstance = new RawDataPoolMonitorVisitor();
  47
  48                 // Return the prepared instance
  49                 return $visitorInstance;
  50         }
  51
  52         /**
  53          * Visits the given pool instance
  54          *
  55          * @param       $poolInstance   A Poolable instance
  56          * @return      void
  57          */
  58         public function visitPool (Poolable $poolInstance) {
  59                 // A pool doesn't normally have any raw data waiting
  60                 //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('[' . __METHOD__ . ':' . __LINE__ . ' ]: poolInstance=' . $poolInstance->__toString() . ' - CALLED!');
  61         }
  62
  63         /**
  64          * Visits the given listener instance
  65          *
  66          * @param       $listenerInstance       A Listenable instance
  67          * @return      void
  68          */
  69         public function visitListener (Listenable $listenerInstance) {
  70                 /*
  71                  * The listener itself cannot distinguish between node and client
  72                  * traffic. This is why we don't call its monitorIncomingRawData()
  73                  * method.
  74                  */
  75                 //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('[' . __METHOD__ . ':' . __LINE__ . ' ]: listenerInstance=' . $listenerInstance->__toString() . ' - CALLED!');
  76         }
  77
  78         /**
  79          * Visits the given decorator instance
  80          *
  81          * @param       $decoratorInstance      A decorator instance
  82          * @return      void
  83          */
  84         public function visitDecorator (BaseDecorator $decoratorInstance) {
  85                 // Do monitor here
  86                 //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('[' . __METHOD__ . ':' . __LINE__ . ' ]: Visiting ' . $listenerInstance->__toString() . ' - CALLED!');
  87                 $decoratorInstance->monitorIncomingRawData();
  88                 //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('[' . __METHOD__ . ':' . __LINE__ . ' ]: Visiting ' . $listenerInstance->__toString() . ' - FINISH');
  89         }
  90 }
  91
  92 // [EOF]
  93 ?>