framework/main/interfaces/handler/protocol/class_HandleableProtocol.php

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