3 namespace CoreFramework\Handler\Protocol;
5 // Import framework stuff
6 use CoreFramework\Handler\Handleable;
9 * An interface for protocol handlers
11 * @author Roland Haeder <webmaster@shipsimu.org>
13 * @copyright Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2017 Core Developer Team
14 * @license GNU GPL 3.0 or any newer version
15 * @link http://www.shipsimu.org
17 * This program is free software: you can redistribute it and/or modify
18 * it under the terms of the GNU General Public License as published by
19 * the Free Software Foundation, either version 3 of the License, or
20 * (at your option) any later version.
22 * This program is distributed in the hope that it will be useful,
23 * but WITHOUT ANY WARRANTY; without even the implied warranty of
24 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
25 * GNU General Public License for more details.
27 * You should have received a copy of the GNU General Public License
28 * along with this program. If not, see <http://www.gnu.org/licenses/>.
30 interface HandleableProtocol extends Handleable {
32 * Getter for port number to satify HandleableProtocol
34 * @return $port The port number
39 * Getter for protocol name
41 * @return $protocol Name of used protocol
43 function getProtocolName ();
46 * Validates given 'recipient' if it is a valid UNL. This means that the UNL
47 * can be parsed by the protocol handler.
49 * @param $packageData Valid raw package data
50 * @return $isValid Whether the UNL can be validated
52 function isValidUniversalNodeLocatorByPackageData (array $packageData);
55 * If the found UNL (address) matches own external or internal address
57 * @param $unl UNL to test
58 * @return $ifMatches Whether the found UNL matches own addresss
60 function isOwnAddress ($unl);