]> git.mxchange.org Git - hub.git/blob - application/hub/classes/miner/chash/class_HubCoinMiner.php
Updated 'core' + renamed 'main' -> 'classes'.
[hub.git] / application / hub / classes / miner / chash / class_HubCoinMiner.php
1 <?php
2 /**
3  * A hub-mcrypt miner class
4  *
5  * @author              Roland Haeder <webmaster@shipsimu.org>
6  * @version             0.0.0
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  *
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 HubCoinMiner extends BaseHubMiner implements MinerHelper, Registerable {
25         /**
26          * Protected constructor
27          *
28          * @return      void
29          */
30         protected function __construct () {
31                 // Call parent constructor
32                 parent::__construct(__CLASS__);
33
34                 // Set version number
35                 $this->setVersion('0.0.0');
36         }
37
38         /**
39          * Creates an instance of this hub-miner class
40          *
41          * @return      $minerInstance  An instance of this hub-miner class
42          */
43         public final static function createHubCoinMiner () {
44                 // Get a new instance
45                 $minerInstance = new HubCoinMiner();
46
47                 // Return the instance
48                 return $minerInstance;
49         }
50
51         /**
52          * This method fills the in-buffer with (a) test unit(s) which are mainly
53          * used for development of the crunching part. They must be enabled in
54          * configuration, or else your miner runs out of WUs and waits for more
55          * to show up.
56          *
57          * In this method we already know that the in-buffer is going depleted so
58          * no need to double-check it here.
59          *
60          * @return      void
61          */
62         protected function fillInBufferQueueWithTestUnits () {
63                 // Are test units enabled?
64                 if ($this->getConfigInstance()->getConfigEntry('miner_test_units_enabled') == 'N') {
65                         // They are disabled, so skip any further steps
66                         return;
67                 } elseif ($this->getStateInstance()->isMinerStateVirgin()) {
68                         // No virgin miners please, because they usually have no test units ready for crunching
69                         return;
70                 }
71
72                 // Get a test-unit generator instance
73                 $generatorInstance = ObjectFactory::createObjectByConfiguredName('miner_test_unit_generator_class');
74
75                 // We don't need an iterator here because we just need to generate some test units
76                 for ($idx = 0; $idx < $this->getConfigInstance()->getConfigEntry('miner_max_text_unit_amount'); $idx++) {
77                         // Get a test unit from it
78                         $unitInstance = $generatorInstance->generateNextUnitInstance();
79
80                         // ... and finally queue it to the in-buffer queue
81                         $this->queueUnitInstanceToInBuffer($unitInstance);
82                 } // END - for
83         }
84
85         /**
86          * This method fills the in-buffer with (real) WUs which will be crunched
87          * and the result be sent back to the key producer instance.
88          *
89          * @return      void
90          */
91         protected function fillInBufferQueueWithWorkUnits () {
92                 // This miner's state must not be one of these: 'virgin'
93                 if ($this->getStateInstance()->isMinerStateVirgin()) {
94                         // We can silently skip here, until the generation is finished
95                         return;
96                 } // END - if
97
98                 // @TODO Implement this method
99                 $this->partialStub('Please implement this method.');
100         }
101
102         /**
103          * Method to "bootstrap" the miner. This step does also apply provided
104          * command-line arguments stored in the request instance. No buffer queue
105          * will be initialized here, we only do "general" things here.
106          *
107          * @return      void
108          * @todo        Implement this method
109          */
110         public function doBootstrapping () {
111                 $this->partialStub('Please implement this method.');
112         }
113
114         /**
115          * Outputs the console teaser. This should only be executed on startup or
116          * full restarts. This method generates some space around the teaser.
117          *
118          * @return      void
119          */
120         public function outputConsoleTeaser () {
121                 // Output all lines
122                 self::createDebugInstance(__CLASS__)->debugOutput(' ');
123                 self::createDebugInstance(__CLASS__)->debugOutput('Hubcoin miner v' . $this->getVersion() . ' is starting ...');
124                 self::createDebugInstance(__CLASS__)->debugOutput('Copyright (c) 2014 Miner Developer Team');
125                 self::createDebugInstance(__CLASS__)->debugOutput(' ');
126                 self::createDebugInstance(__CLASS__)->debugOutput('This program comes with ABSOLUTELY NO WARRANTY; for details see docs/COPYING.');
127                 self::createDebugInstance(__CLASS__)->debugOutput('This is free software, and you are welcome to redistribute it under certain');
128                 self::createDebugInstance(__CLASS__)->debugOutput('conditions; see docs/COPYING for details.');
129                 self::createDebugInstance(__CLASS__)->debugOutput(' ');
130         }
131
132         /**
133          * Add some miner-specific filters
134          *
135          * @param       $controllerInstance     An object of a Controller instance
136          * @param       $responseInstance       An object of a Responseable instance
137          * @return      void
138          * @todo        0% done
139          */
140         public function addExtraFilters (Controller $controllerInstance, Responseable $responseInstance) {
141                 // Add some filters here
142                 $this->partialStub('Please add some miner-specific filters, if required.');
143         }
144 }
145
146 // [EOF]
147 ?>