inc/classes/main/container/socket/class_SocketContainer.php

   1 <?php
   2 /**
   3  * A Socket Container class
   4  *
   5  * @author              Roland Haeder <webmaster@shipsimu.org>
   6  * @version             0.0.0
   7  * @copyright   Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2014 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 class SocketContainer extends BaseContainer implements Registerable {
  25         /**
  26          * Protected constructor
  27          *
  28          * @return      void
  29          */
  30         protected function __construct () {
  31                 // Call parent constructor
  32                 parent::__construct(__CLASS__);
  33         }
  34
  35         /**
  36          * Creates an instance of this Container class and prepares it for usage
  37          *
  38          * @param       $socketResource         A valid socket resource
  39          * @param       $infoInstance           An instance of a  ShareableInfo class
  40          * @param       $packageData            Raw package data
  41          * @return      $containerInstance      An instance of this Container class
  42          */
  43         public static final function createSocketContainer ($socketResource, ShareableInfo $infoInstance = NULL, array $packageData = array()) {
  44                 // Get a new instance
  45                 $containerInstance = new SocketContainer();
  46
  47                 // Remove unneeded entries
  48                 unset($packageData[NetworkPackage::PACKAGE_DATA_CONTENT]);
  49                 unset($packageData[NetworkPackage::PACKAGE_DATA_SIGNATURE]);
  50
  51                 // Debug message
  52                 //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('SOCKET-CONTAINER[' . __METHOD__ . ':' . __LINE__ . ']:socketResource=' . $socketResource . ',packageData='.print_r($packageData, TRUE));
  53
  54                 // Is the info instance set?
  55                 if ($infoInstance instanceof ShareableInfo) {
  56                         // Get listener from info class
  57                         $listenerInstance = $infoInstance->getListenerInstance();
  58
  59                         // Is there a listener instance set?
  60                         if ($listenerInstance instanceof Listenable) {
  61                                 // Set it here for later usage
  62                                 $containerInstance->setListenerInstance($listenerInstance);
  63                         } // END - if
  64                 } // END - if
  65
  66                 // Set the resource ...
  67                 $containerInstance->setSocketResource($socketResource);
  68
  69                 // ... and package data
  70                 $containerInstance->setPackageData($packageData);
  71
  72                 // Return the prepared instance
  73                 return $containerInstance;
  74         }
  75
  76         /**
  77          * Checks whether the given Universal Node Locator matches with the one from package data
  78          *
  79          * @param       $unl            A Universal Node Locator
  80          * @return      $matches        Whether $address matches with the one from package data
  81          */
  82         public final function ifAddressMatches ($unl) {
  83                 // Get current package data
  84                 $packageData = $this->getPackageData();
  85
  86                 // Debug message
  87                 /* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('SOCKET-CONTAINER: unl=' . $unl . ',packageData=' . print_r($packageData, TRUE));
  88
  89                 // So, does both match?
  90                 $matches = ((isset($packageData[NetworkPackage::PACKAGE_DATA_RECIPIENT])) && ($packageData[NetworkPackage::PACKAGE_DATA_RECIPIENT] === $unl));
  91
  92                 // Return result
  93                 return $matches;
  94         }
  95
  96         /**
  97          * Checks whether the given socket matches with stored
  98          *
  99          * @param       $socketResource         A valid socket resource
 100          * @return      $matches                        Whether given socket matches
 101          */
 102         public final function ifSocketResourceMatches ($socketResource) {
 103                 // Debug message
 104                 /* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('SOCKET-CONTAINER: socketResource[' . gettype($socketResource) . ']=' .$socketResource . ',storedResource[' . gettype($this->getSocketResource()) . ']=' . $this->getSocketResource());
 105
 106                 // So, does both match?
 107                 $matches = ((is_resource($socketResource)) && ($socketResource === $this->getSocketResource()));
 108
 109                 // Return result
 110                 return $matches;
 111         }
 112 }
 113
 114 // [EOF]
 115 ?>