3 * An interface for a package assembler
5 * @author Roland Haeder <webmaster@shipsimu.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.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 interface Assembler extends FrameworkInterface {
26 * Chunks the content from $packageContent and feeds it into another queue
27 * for verification and possible re-requesting.
29 * @param $packageContent An array with two elements: 'raw_data' and 'error_code'
32 function chunkPackageContent (array $packageContent);
35 * Checks whether the assembler's pending data is empty which means it has
36 * no pending data left for handling ... ;-)
38 * @return $ifPendingDataIsEmpty Whether pending data is empty
40 function isPendingDataEmpty ();
43 * Handles the assembler's pending data
47 function handlePendingData ();
50 * Checks whether the assembler has multiple messages pending
52 * @return $isPending Whether the assembler has multiple messages pending
54 function ifMultipleMessagesPending ();
57 * Handles multiple messages.
61 function handleMultipleMessages ();