]> git.mxchange.org Git - hub.git/blob - application/hub/main/handler/chunks/class_ChunkHandler.php
06573bd812863ccb81fa9bdd577852c11feacbd6
[hub.git] / application / hub / main / handler / chunks / class_ChunkHandler.php
1 <?php
2 /**
3  * A Chunk handler
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  *
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 ChunkHandler extends BaseHandler implements HandleableChunks, Registerable {
25         /**
26          * Stacker for chunks with final EOP
27          */
28         const STACKER_NAME_CHUNKS_WITH_FINAL_EOP = 'final_chunks';
29
30         /**
31          * Protected constructor
32          *
33          * @return      void
34          */
35         protected function __construct () {
36                 // Call parent constructor
37                 parent::__construct(__CLASS__);
38
39                 // Set handler name
40                 $this->setHandlerName('chunk');
41         }
42
43         /**
44          * Creates an instance of this class
45          *
46          * @return      $handlerInstance        An instance of a chunk Handler class
47          */
48         public final static function createChunkHandler () {
49                 // Get new instance
50                 $handlerInstance = new ChunkHandler();
51
52                 // Get a FIFO stacker
53                 $stackerInstance = ObjectFactory::createObjectByConfiguredName('chunk_handler_stacker_class');
54
55                 // Init all stacker
56                 $stackerInstance->initStacker(self::STACKER_NAME_CHUNKS_WITH_FINAL_EOP);
57
58                 // Set the stacker in this handler
59                 $handlerInstance->setStackerInstance($stackerInstance);
60
61                 // Return the prepared instance
62                 return $handlerInstance;
63         }
64
65         /**
66          * Adds all chunks if the last one verifies as a 'final chunk'.
67          *
68          * @param       $chunks         An array with chunks, the last one should be a 'final'
69          * @return      void
70          * @throws      FinalChunkVerificationException         If the final chunk does not start with 'EOP:'
71          */
72         public function addAllChunksWithFinal (array $chunks) {
73                 // Validate final chunk
74                 if (!$this->isValidFinalChunk($chunks)) {
75                         // Last chunk is not valid
76                         throw new FinalChunkVerificationException(array($this, $chunks), BaseListener::EXCEPTION_FINAL_CHUNK_VERIFICATION);
77                 } // END - if
78
79                 // Add all chunks to the FIFO stacker
80                 foreach ($chunks as $chunk) {
81                         // Add the chunk
82                         $this->getStackerInstance()->pushNamed(self::STACKER_NAME_CHUNKS_WITH_FINAL_EOP, $chunk);
83                 } // END - foreach
84         }
85
86         /**
87          * Checks whether unhandled chunks are available
88          *
89          * @return      $unhandledChunks        Whether unhandled chunks are left
90          */
91         public function ifUnhandledChunksAvailable () {
92                 // Simply check if the stacker is not empty
93                 $unhandledChunks = $this->getStackerInstance()->isStackEmpty(self::STACKER_NAME_CHUNKS_WITH_FINAL_EOP) === false;
94
95                 // Return result
96                 return $unhandledChunks;
97         }
98
99         /**
100          * Handles available chunks by processing one-by-one (not all together,
101          * this would slow-down the whole application) with the help of an
102          * iterator.
103          *
104          * @return      void
105          */
106         public function handleAvailableChunks () {
107                 // First check if there are undhandled chunks available
108                 assert($this->ifUnhandledChunksAvailable());
109
110                 // Get an entry from the stacker
111                 $chunk = $this->getStackerInstance()->getNamed(self::STACKER_NAME_CHUNKS_WITH_FINAL_EOP);
112                 die('chunk=' . $chunk . chr(10));
113         }
114 }
115
116 // [EOF]
117 ?>