3 * An interface for package receivers
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 Receivable extends FrameworkInterface {
26 * Checks whether new raw data from the socket has arrived
28 * @param $poolInstance An instance of a PoolableListener class
29 * @return $hasArrived Whether raw package data has arrived at a socket
31 function isNewRawDataPending (PoolableListener $poolInstance);
34 * Handles the incoming decoded raw data. This method does not "convert" the
35 * decoded data back into a package array, it just "handles" it and pushs it
40 function handleIncomingDecodedData ();
43 * Checks whether incoming decoded data is handled.
45 * @return $isHandled Whether incoming decoded data is handled
47 function isIncomingDecodedDataHandled ();
50 * Assembles incoming decoded data so it will become an abstract network
55 function assembleDecodedDataToPackage ();
58 * Checks whether a new message has arrived
60 * @return $hasArrived Whether a new message has arrived for processing
62 function isNewMessageArrived ();
65 * Handle newly arrived message
69 function handleNewlyArrivedMessage ();
72 * Checks whether a processed message is pending for "interpretation"
74 * @return $isPending Whether a processed message is pending
76 function isProcessedMessagePending ();
79 * Handle processed messages by "interpreting" the 'message_type' element
83 function handleProcessedMessage ();
86 * Adds raw decoded data from the given handler instance to this receiver
88 * @param $handlerInstance An instance of a Networkable class
91 function addDecodedDataToIncomingStack (Networkable $handlerInstance);
94 * "Decode" the package content. This method does also verify the attached hash
95 * against the real raw package data (that what the sender has sent).
97 * @param $rawPackageContent The raw package content to be "decoded"
98 * @return $decodedData The real package data that the sender has sent
100 function decodeRawContent ($rawPackageContent);
103 * Checks whether the assembler has pending data left
105 * @return $isHandled Whether the assembler has pending data left
107 function ifAssemblerHasPendingDataLeft ();
110 * Handles the attached assemler's pending data queue to be finally
111 * assembled to the raw package data back.
115 function handleAssemblerPendingData ();
118 * Handles decoded data for this node
120 * @param $decodedData An array with decoded raw package data
123 function handleDecodedData (array $decodedData);