application/hub/main/handler/network/class_BaseNetworkPackageHandler.php

   1 <?php
   2 /**
   3  * A general Handler
   4  *
   5  * @author              Roland Haeder <webmaster@ship-simu.org>
   6  * @version             0.0.0
   7  * @copyright   Copyright (c) 2007, 2008 Roland Haeder, 2009, 2010 Hub Developer Team
   8  * @license             GNU GPL 3.0 or any newer version
   9  * @link                http://www.ship-simu.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 class BaseNetworkPackageHandler extends BaseHandler {
  25         // Error codes
  26         const SOCKET_ERROR_UNKNOWN             = 'unknown_error';
  27         const SOCKET_ERROR_TRANSPORT_ENDPOINT  = 'transport_endpoint';
  28         const SOCKET_ERROR_UNHANDLED           = 'unhandled_package';
  29         const SOCKET_ERROR_EMPTY_DATA          = 'empty_data';
  30         const PACKAGE_ERROR_INVALID_DATA       = 'invalid_data';
  31         const PACKAGE_ERROR_INCOMPLETE_DATA    = 'incomplete_data';
  32         const PACKAGE_ERROR_INVALID_CONTENT    = 'invalid_content';
  33         const PACKAGE_ERROR_RECIPIENT_MISMATCH = 'recipient_error';
  34         const PACKAGE_LEVEL_CHECK_OKAY         = 'checked_package';
  35
  36         /**
  37          * Error code from socket
  38          */
  39         private $errorCode = -1;
  40
  41         /**
  42          * Protected constructor
  43          *
  44          * @param       $className      Name of the class
  45          * @return      void
  46          */
  47         protected function __construct ($className) {
  48                 // Call parent constructor
  49                 parent::__construct($className);
  50         }
  51
  52         /**
  53          * Checks wether the 'recipient' field matches our own address:port
  54          * combination.
  55          *
  56          * @param       $packageData    Raw package data
  57          * @return      $matches                Wether it matches
  58          */
  59         protected function ifRecipientMatchesOwnAddress (array $packageData) {
  60                 // Construct own address first,
  61                 $ownAddress = Registry::getRegistry()->getInstance('node')->getAddressPort($this);
  62
  63                 // Does it match?
  64                 $matches = ($ownAddress === $packageData[NetworkPackage::INDEX_PACKAGE_RECIPIENT]);
  65
  66                 // Return result
  67                 return $matches;
  68         }
  69
  70         /**
  71          * Setter for error code
  72          *
  73          * @param       $errorCode      The error code we shall set
  74          * @return      void
  75          */
  76         protected final function setErrorCode ($errorCode) {
  77                 $this->errorCode = $errorCode;
  78         }
  79
  80         /**
  81          * Getter for error code
  82          *
  83          * @return      $errorCode      The error code
  84          */
  85         public final function getErrorCode () {
  86                 return $this->errorCode;
  87         }
  88 }
  89
  90 // [EOF]
  91 ?>