]> git.mxchange.org Git - hub.git/blob - application/hub/interfaces/package/class_Receivable.php
'hub' project continued:
[hub.git] / application / hub / interfaces / package / class_Receivable.php
1 <?php
2 /**
3  * An interface for package receivers
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 interface Receivable extends FrameworkInterface {
25         /**
26          * Checks whether new raw data from the socket has arrived
27          *
28          * @param       $poolInstance   An instance of a PoolableListener class
29          * @return      $hasArrived             Whether raw package data has arrived at a socket
30          */
31         function isNewRawDataPending (PoolableListener $poolInstance);
32
33         /**
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
36          * on the next stack.
37          *
38          * @return      void
39          */
40         function handleIncomingDecodedData ();
41
42         /**
43          * Checks whether incoming decoded data is handled.
44          *
45          * @return      $isHandled      Whether incoming decoded data is handled
46          */
47         function isIncomingDecodedDataHandled ();
48
49         /**
50          * Assembles incoming decoded data so it will become an abstract network
51          * package again.
52          *
53          * @return      void
54          */
55         function assembleDecodedDataToPackage ();
56
57         /**
58          * Checks whether a new package has arrived
59          *
60          * @return      $hasArrived             Whether a new package has arrived for processing
61          */
62         function isNewPackageArrived ();
63
64         /**
65          * Adds raw decoded data from the given handler instance to this receiver
66          *
67          * @param       $handlerInstance        An instance of a Networkable class
68          * @return      void
69          */
70         function addDecodedDataToIncomingStack (Networkable $handlerInstance);
71
72         /**
73          * "Decode" the package content. This method does also verify the attached hash
74          * against the real raw package data (that what the sender has sent).
75          *
76          * @param       $rawPackageContent      The raw package content to be "decoded"
77          * @return      $decodedData            The real package data that the sender has sent
78          */
79         function decodeRawContent ($rawPackageContent);
80 }
81
82 // [EOF]
83 ?>