3 * An interface for protocol handlers
5 * @author Roland Haeder <webmaster@shipsimu.org>
7 * @copyright Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2016 Core 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 HandleableProtocol extends Handleable {
26 * Getter for port number to satify HandleableProtocol
28 * @return $port The port number
33 * Getter for protocol name
35 * @return $protocol Name of used protocol
37 function getProtocolName ();
40 * Validates given 'recipient' if it is a valid UNL. This means that the UNL
41 * can be parsed by the protocol handler.
43 * @param $packageData Valid raw package data
44 * @return $isValid Whether the UNL can be validated
46 function isValidUniversalNodeLocatorByPackageData (array $packageData);
49 * If the found UNL (address) matches own external or internal address
51 * @param $unl UNL to test
52 * @return $ifMatches Whether the found UNL matches own addresss
54 function isOwnAddress ($unl);