f40df1006f076608dbee4eda585fa91e425def90
[core.git] / inc / classes / interfaces / handler / protocol / class_HandleableProtocol.php
1 <?php
2 /**
3  * An interface for protocol handlers
4  *
5  * @author              Roland Haeder <webmaster@shipsimu.org>
6  * @version             0.0.0
7  * @copyright   Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2015 Core Developer Team
8  * @license             GNU GPL 3.0 or any newer version
9  * @link                http://www.shipsimu.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 HandleableProtocol extends Handleable {
25         /**
26          * Getter for port number to satify HandleableProtocol
27          *
28          * @return      $port   The port number
29          */
30         function getPort ();
31
32         /**
33          * Getter for protocol name
34          *
35          * @return      $protocol       Name of used protocol
36          */
37         function getProtocolName ();
38
39         /**
40          * Validates given 'recipient' if it is a valid UNL. This means that the UNL
41          * can be parsed by the protocol handler.
42          *
43          * @param       $packageData    Valid raw package data
44          * @return      $isValid                Whether the UNL can be validated
45          */
46         function isValidUniversalNodeLocatorByPackageData (array $packageData);
47
48         /**
49          * If the found UNL (address) matches own external or internal address
50          *
51          * @return      $ifMatches      Whether the found UNL matches own addresss
52          */
53         function isOwnAddress ();
54 }
55
56 // [EOF]
57 ?>