3 * Handleable chunks interface
5 * @author Roland Haeder <webmaster@ship-simu.org>
7 * @copyright Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2012 Hub Developer Team
8 * @license GNU GPL 3.0 or any newer version
9 * @link http://www.ship-simu.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 interface HandleableChunks extends Handleable {
26 * Adds all chunks if the last one verifies as a 'final chunk'.
28 * @param $chunks An array with chunks, the last one should be a 'final'
30 * @throws FinalChunkVerificationException If the final chunk does not start with 'EOP:'
32 function addAllChunksWithFinal (array $chunks);
35 * Adds all chunks and wait for more (e.g. incomplete transmission)
37 * @param $chunks An array with chunks, the last one should be a 'final'
40 function addAllChunksWait (array $chunks);
43 * Checks whether unhandled chunks are available
45 * @return $unhandledChunks Whether unhandled chunks are left
47 function ifUnhandledChunksWithFinalAvailable ();
50 * Handles available chunks by processing one-by-one (not all together,
51 * this would slow-down the whole application) with the help of an
56 function handleAvailableChunksWithFinal ();
59 * Checks whether unassembled chunks are available (ready) in final array
61 * @return $unassembledChunksAvailable Whether unassembled chunks are available
63 function ifUnassembledChunksAvailable ();
66 * Assembles all chunks (except EOP and "hash chunk") back together to the original package data.
68 * This is done by the following steps:
70 * 1) Sort the final array with ksort(). This will bring the "hash
71 * chunk" up to the last array index and the EOP chunk to the
72 * pre-last array index
73 * 2) Assemble all chunks except two last (see above step)
74 * 3) While so, do the final check on all hashes
75 * 4) If the package is assembled back together, hash it again for
76 * the very final verification.
80 function assembleChunksFromFinalArray ();
83 * Checks whether the raw package data has been assembled back together.
84 * This can be safely assumed when rawPackageData is not empty and the
85 * collection of all chunks is false (because initHandler() will reset it).
87 * @return $isRawPackageDataAvailable Whether raw package data is available
89 function ifRawPackageDataIsAvailable ();
92 * Handles the finally assembled raw package data by feeding it into another
93 * stacker for further decoding/processing.
97 function handledAssembledRawPackageData ();