application/hub/main/cruncher/class_BaseHubCruncher.php

   1 <?php
   2 /**
   3  * A general hub cruncher class
   4  *
   5  * @author              Roland Haeder <webmaster@ship-simu.org>
   6  * @version             0.0.0
   7  * @copyright   Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2011 Hub Developer Team
   8  * @license             GNU GPL 3.0 or any newer version
   9  * @link                http://www.ship-simu.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 abstract class BaseHubCruncher extends BaseHubSystem implements Updateable {
  25         /**
  26          * Version information
  27          */
  28         private $version = 'x.x';
  29
  30         /**
  31          * By default no cruncher is active
  32          */
  33         private $isActive = false;
  34
  35         /**
  36          * All buffer queue instances (a FIFO)
  37          */
  38         private $bufferInstance = null;
  39
  40         /**
  41          * Protected constructor
  42          *
  43          * @param       $className      Name of the class
  44          * @return      void
  45          */
  46         protected function __construct ($className) {
  47                 // Call parent constructor
  48                 parent::__construct($className);
  49         }
  50
  51         /**
  52          * Getter for version
  53          *
  54          * @return      $version        Version number of this cruncher
  55          */
  56         protected final function getVersion () {
  57                 return $this->version;
  58         }
  59
  60         /**
  61          * Setter for version
  62          *
  63          * @param       $version        Version number of this cruncher
  64          * @return      void
  65          */
  66         protected final function setVersion ($version) {
  67                 $this->version = (string) $version;
  68         }
  69
  70         /**
  71          * Checks wether the in-buffer queue is filled by comparing it's current
  72          * amount of entries against a threshold.
  73          *
  74          * @return      $isFilled       Wether the in-buffer is filled
  75          */
  76         protected function isInBufferQueueFilled () {
  77                 // Determine it
  78                 $isFilled = ($this->bufferInstance->getStackCount('in_queue') > $this->getConfigInstance()->getConfigEntry('cruncher_in_buffer_min_threshold'));
  79
  80                 // And return the result
  81                 return $isFilled;
  82         }
  83
  84         /**
  85          * This method fills the in-buffer with (a) test unit(s) which are mainly
  86          * used for development of the crunching part. They must be enabled in
  87          * configuration, or else your cruncher runs out of WUs and waits for more
  88          * to show up.
  89          *
  90          * In this method we already know that the in-buffer is going depleted so
  91          * we don't need to double-check it here.
  92          *
  93          * @return      void
  94          */
  95         abstract protected function fillInBufferQueueWithTestUnits ();
  96
  97         /**
  98          * This method fills the in-buffer with (real) WUs which will be crunched
  99          * and the result be sent back to the key producer instance.
 100          *
 101          * @return      void
 102          */
 103         abstract protected function fillInBufferQueueWithWorkUnits ();
 104
 105         /**
 106          * Enables/disables the cruncher (just sets a flag)
 107          *
 108          * @param       $version        Version number of this cruncher
 109          * @return      void
 110          */
 111         public final function enableIsActive ($isActive = true) {
 112                 $this->isActive = (bool) $isActive;
 113         }
 114
 115         /**
 116          * Determines wether the cruncher is active
 117          *
 118          * @return      $isActive       Wether the cruncher is active
 119          */
 120         public final function isActive () {
 121                 return $this->isActive;
 122         }
 123
 124         /**
 125          * Initializes all buffer queues (mostly in/out). This method is demanded
 126          * by the CruncherHelper interface.
 127          *
 128          * @return      void
 129          */
 130         public function initBufferQueues () {
 131                 /*
 132                  * Initialize both buffer queues, we can use the FIFO class here
 133                  * directly and encapsulate its method calls with protected methods.
 134                  */
 135                 $this->bufferInstance = ObjectFactory::createObjectByConfiguredName('cruncher_buffer_stacker_class');
 136
 137                 // Initialize common stackers, like in/out
 138                 $this->bufferInstance->initStacker('in_queue');
 139                 $this->bufferInstance->initStacker('out_queue');
 140
 141                 // Output debug message
 142                 $this->debugOutput('CRUNCHER: All buffers are now initialized.');
 143         }
 144
 145         /**
 146          * This method determines if the in-buffer is going to depleted and if so,
 147          * it fetches more WUs from the network. If no WU can be fetched from the
 148          * network and if enabled, a random test WU is being generated.
 149          *
 150          * This method is demanded from the CruncherHelper interface.
 151          *
 152          * @return      void
 153          */
 154         public function doFetchWorkUnits () {
 155                 // Simply check if we have enough WUs left in the in-buffer queue (a FIFO)
 156                 if (!$this->isInBufferQueueFilled()) {
 157                         // The in-buffer queue needs filling, so head out and get some work
 158                         $this->fillInBufferQueueWithWorkUnits();
 159
 160                         // Is the buffer still not filled and are test-packages allowed?
 161                         if ((!$this->isInBufferQueueFilled()) && ($this->getConfigInstance()->getConfigEntry('cruncher_test_units_enabled') == 'Y')) {
 162                                 // Then fill the in-buffer with (one) test-unit(s)
 163                                 $this->fillInBufferQueueWithTestUnits();
 164                         } // END - if
 165                 } // END - if
 166         }
 167
 168         /**
 169          * Updates a given field with new value
 170          *
 171          * @param       $fieldName              Field to update
 172          * @param       $fieldValue             New value to store
 173          * @return      void
 174          * @throws      DatabaseUpdateSupportException  If this class does not support database updates
 175          * @todo        Try to make this method more generic so we can move it in BaseFrameworkSystem
 176          */
 177         public function updateDatabaseField ($fieldName, $fieldValue) {
 178                 // Unfinished
 179                 $this->partialStub('Unfinished!');
 180                 return;
 181         }
 182 }
 183
 184 // [EOF]
 185 ?>