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

   1 <?php
   2 // Own namespace
   3 namespace CoreFramework\Handler\Protocol;
   4
   5 // Import framework stuff
   6 use CoreFramework\Handler\Handleable;
   7
   8 /**
   9  * An interface for protocol handlers
  10  *
  11  * @author              Roland Haeder <webmaster@shipsimu.org>
  12  * @version             0.0.0
  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
  16  *
  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.
  21  *
  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.
  26  *
  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/>.
  29  */
  30 interface HandleableProtocol extends Handleable {
  31         /**
  32          * Getter for port number to satify HandleableProtocol
  33          *
  34          * @return      $port   The port number
  35          */
  36         function getPort ();
  37
  38         /**
  39          * Getter for protocol name
  40          *
  41          * @return      $protocol       Name of used protocol
  42          */
  43         function getProtocolName ();
  44
  45         /**
  46          * Validates given 'recipient' if it is a valid UNL. This means that the UNL
  47          * can be parsed by the protocol handler.
  48          *
  49          * @param       $packageData    Valid raw package data
  50          * @return      $isValid                Whether the UNL can be validated
  51          */
  52         function isValidUniversalNodeLocatorByPackageData (array $packageData);
  53
  54         /**
  55          * If the found UNL (address) matches own external or internal address
  56          *
  57          * @param       $unl            UNL to test
  58          * @return      $ifMatches      Whether the found UNL matches own addresss
  59          */
  60         function isOwnAddress ($unl);
  61
  62 }