3 * An interface for "node-helper" classes
5 * @author Roland Haeder <webmaster@shipsimu.org>
7 * @copyright Copyright (c) 2014 Miner Developer Team
8 * @license GNU GPL 3.0 or any newer version
9 * @link http://www.shipsimu.org
10 * @todo We need to find a better name for this interface
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.
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.
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/>.
25 interface MinerHelper extends FrameworkInterface {
27 * Method to "bootstrap" the miner. 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().
33 function doBootstrapping ();
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.
42 function doFetchWorkUnits ();
45 * Outputs the console teaser. This should only be executed on startup or
46 * full restarts. This method generates some space around the teaser.
50 function outputConsoleTeaser ();
53 * Add some miner-specific filters
55 * @param $controllerInstance An object of a Controller instance
56 * @param $responseInstance An object of a Responseable instance
59 function addExtraFilters (Controller $controllerInstance, Responseable $responseInstance);
62 * Enables/disables the miner (just sets a flag)
64 * @param $version Version number of this miner
67 function enableIsActive ($isActive = TRUE);
70 * Determines whether the miner is active
72 * @return $isActive Whether the miner is active
77 * Initializes all buffer queues (mostly in/out)
81 function initBufferQueues ();