application/hub/interfaces/cruncher/class_CruncherHelper.php

   1 <?php
   2 /**
   3  * An interface for "node-helper" classes
   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  * @todo                We need to find a better name for this interface
  11  *
  12  * This program is free software: you can redistribute it and/or modify
  13  * it under the terms of the GNU General Public License as published by
  14  * the Free Software Foundation, either version 3 of the License, or
  15  * (at your option) any later version.
  16  *
  17  * This program is distributed in the hope that it will be useful,
  18  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  19  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  20  * GNU General Public License for more details.
  21  *
  22  * You should have received a copy of the GNU General Public License
  23  * along with this program. If not, see <http://www.gnu.org/licenses/>.
  24  */
  25 interface CruncherHelper extends FrameworkInterface {
  26         /**
  27          * Method to "bootstrap" the cruncher. This step does also apply provided
  28          * command-line arguments stored in the request instance. You should now
  29          * get it from calling $this->getRequestInstance().
  30          *
  31          * @return      void
  32          */
  33         function doBootstrapping ();
  34
  35         /**
  36          * This method determines if the in-buffer is going to depleted and if so,
  37          * it fetches more WUs from the network. If no WU can be fetched from the
  38          * network and if enabled, a random test WU is being generated.
  39          *
  40          * @return      void
  41          */
  42         function doFetchWorkUnits ();
  43
  44         /**
  45          * Outputs the console teaser. This should only be executed on startup or
  46          * full restarts. This method generates some space around the teaser.
  47          *
  48          * @return      void
  49          */
  50         function outputConsoleTeaser ();
  51
  52         /**
  53          * Add some cruncher-specific filters
  54          *
  55          * @param       $controllerInstance             An object of a Controller instance
  56          * @param       $responseInstance               An object of a Responseable instance
  57          * @return      void
  58          */
  59         function addExtraFilters (Controller $controllerInstance, Responseable $responseInstance);
  60
  61         /**
  62          * Enables/disables the cruncher (just sets a flag)
  63          *
  64          * @param       $version        Version number of this cruncher
  65          * @return      void
  66          */
  67         function enableIsActive ($isActive = true);
  68
  69         /**
  70          * Determines whether the cruncher is active
  71          *
  72          * @return      $isActive       Whether the cruncher is active
  73          */
  74         function isActive ();
  75
  76         /**
  77          * Initializes all buffer queues (mostly in/out)
  78          *
  79          * @return      void
  80          */
  81         function initBufferQueues ();
  82 }
  83
  84 // [EOF]
  85 ?>