3 * An interface for connection helper classes
5 * @author Roland Haeder <webmaster@shipsimu.org>
7 * @copyright Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2014 Hub Developer Team
8 * @license GNU GPL 3.0 or any newer version
9 * @link http://www.shipsimu.org
10 * @todo Please find another name for this interface
12 * This program is free software: you can redistribute it and/or modify
13 * it under the terms of the GNU General Public License as published by
14 * the Free Software Foundation, either version 3 of the License, or
15 * (at your option) any later version.
17 * This program is distributed in the hope that it will be useful,
18 * but WITHOUT ANY WARRANTY; without even the implied warranty of
19 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
20 * GNU General Public License for more details.
22 * You should have received a copy of the GNU General Public License
23 * along with this program. If not, see <http://www.gnu.org/licenses/>.
25 interface ConnectionHelper extends Helper {
27 * Sends raw package data to the recipient
29 * @param $packageData Raw package data
31 * @throws InvalidSocketException If we got a problem with this socket
33 function sendRawPackageData (array $packageData);
36 * Do the shutdown sequence for this connection helper
38 * @todo We may want to implement a filter for ease notification of other objects like our pool
40 * @throws SocketShutdownException If the current socket could not be shut down
42 function doShutdown ();
45 * Getter for port number to satify ProtocolHandler
47 * @return $port The port number
52 * Getter for IP address
54 * @return $address The IP address
56 function getAddress ();
59 * Static "getter" for this connection class' name
61 * @param $address IP address
62 * @param $port Port number
63 * @param $className Original class name
64 * @return $class Expanded class name
66 static function getConnectionClassName ($address, $port, $className);
69 * Getter for shuttedDown
71 * @return $shuttedDown Whether this connection is shutted down
73 function isShuttedDown ();