3 * A ChunkAssembler node-task
5 * @author Roland Haeder <webmaster@shipsimu.org>
7 * @copyright Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2015 Hub Developer Team
8 * @license GNU GPL 3.0 or any newer version
9 * @link http://www.shipsimu.org
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.
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.
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/>.
24 class NodeChunkAssemblerTask extends BaseTask implements Taskable, Visitable {
26 * Protected constructor
30 protected function __construct () {
31 // Call parent constructor
32 parent::__construct(__CLASS__);
36 * Creates an instance of this class
38 * @return $taskInstance An instance of a Visitable class
40 public final static function createNodeChunkAssemblerTask () {
42 $taskInstance = new NodeChunkAssemblerTask();
44 // Get a chunk handler instance
45 $handlerInstance = ChunkHandlerFactory::createChunkHandlerInstance();
47 // And add it to this task instance
48 $taskInstance->setHandlerInstance($handlerInstance);
50 // Return the prepared instance
55 * Accepts the visitor to process the visitor
57 * @param $visitorInstance An instance of a Visitor class
59 * @todo Also visit some sub-objects?
61 public function accept (Visitor $visitorInstance) {
63 $visitorInstance->visitTask($this);
71 public function executeTask () {
72 // "Cache" handler instance
73 $handlerInstance = $this->getHandlerInstance();
75 // Are there chunks to handle or a final array to assemble?
76 if ($handlerInstance->ifUnassembledChunksAvailable()) {
78 * Then do the final steps:
80 * 1) Sort the final array with ksort(). This will bring the "hash
81 * chunk" up to the last array index and the EOP chunk to the
82 * pre-last array index
83 * 2) Assemble all chunks except two last (see above step)
84 * 3) While so, do the final check on all hashes
85 * 4) If the package is assembled back together, hash it again for
86 * the very final verification.
88 $handlerInstance->assembleChunksFromFinalArray();
89 } elseif ($handlerInstance->ifUnhandledChunksWithFinalAvailable()) {
91 * Then handle them (not all!). This should push all chunks into a
92 * 'final array' for last verification.
94 $handlerInstance->handleAvailableChunksWithFinal();
95 } elseif ($handlerInstance->ifRawPackageDataIsAvailable()) {
97 * The final raw package data is back together again. So feed it
98 * into the next stack for further decoding/processing
100 $handlerInstance->handledAssembledRawPackageData();