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_LEVEL_CHECK_OKAY        = 'checked_package';
  32
  33         /**
  34          * Error code from socket
  35          */
  36         private $errorCode = -1;
  37
  38         /**
  39          * Protected constructor
  40          *
  41          * @param       $className      Name of the class
  42          * @return      void
  43          */
  44         protected function __construct ($className) {
  45                 // Call parent constructor
  46                 parent::__construct($className);
  47         }
  48
  49         /**
  50          * Setter for error code
  51          *
  52          * @param       $errorCode      The error code we shall set
  53          * @return      void
  54          */
  55         protected final function setErrorCode ($errorCode) {
  56                 $this->errorCode = $errorCode;
  57         }
  58
  59         /**
  60          * Getter for error code
  61          *
  62          * @return      $errorCode      The error code
  63          */
  64         public final function getErrorCode () {
  65                 return $this->errorCode;
  66         }
  67 }
  68
  69 // [EOF]
  70 ?>