application/hub/interfaces/producer/work_units/class_UnitProducer.php

   1 <?php
   2 /**
   3  * An interface for the producer/consumer implementation, especially for work/
   4  * test unit producers.
   5  *
   6  * @author              Roland Haeder <webmaster@shipsimu.org>
   7  * @version             0.0.0
   8  * @copyright   Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2014 Hub Developer Team
   9  * @license             GNU GPL 3.0 or any newer version
  10  * @link                http://www.shipsimu.org
  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 UnitProducer extends Producer, Executor {
  26         /**
  27          * Prepares the produces of some work/test units and pushes them onto the queue
  28          *
  29          * @param       $stateInstance  An instance of a Stateable instance
  30          * @return      void
  31          */
  32         function initUnitProduction (Stateable $stateInstance);
  33 }
  34
  35 // [EOF]
  36 ?>