inc/main/classes/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 - 2015 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_HASH]);
  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/helper from info class
  57                         $listenerInstance = $infoInstance->getListenerInstance();
  58                         $helperInstance = $infoInstance->getHelperInstance();
  59
  60                         // Debug message
  61                         //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('SOCKET-CONTAINER[' . __METHOD__ . ':' . __LINE__ . ']: listenerInstance[]=' . gettype($listenerInstance));
  62
  63                         // Is there a listener instance set?
  64                         if ($listenerInstance instanceof Listenable) {
  65                                 // Debug message
  66                                 //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('SOCKET-CONTAINER[' . __METHOD__ . ':' . __LINE__ . ']: Setting listenerInstance=' . $listenerInstance->__toString() . ' ...');
  67
  68                                 // Set it here for later usage
  69                                 $containerInstance->setListenerInstance($listenerInstance);
  70                         } elseif ($helperInstance instanceof ConnectionHelper) {
  71                                 // Debug message
  72                                 //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('SOCKET-CONTAINER[' . __METHOD__ . ':' . __LINE__ . ']: Setting helperInstance=' . $helperInstance->__toString() . ' ...');
  73
  74                                 // Set it here for later usage
  75                                 $containerInstance->setHelperInstance($helperInstance);
  76                         }
  77                 } // END - if
  78
  79                 // Set the resource ...
  80                 $containerInstance->setSocketResource($socketResource);
  81
  82                 // ... and package data
  83                 $containerInstance->setPackageData($packageData);
  84
  85                 // Return the prepared instance
  86                 return $containerInstance;
  87         }
  88
  89         /**
  90          * Checks whether the given Universal Node Locator matches with the one from package data
  91          *
  92          * @param       $unl            A Universal Node Locator
  93          * @return      $matches        Whether $address matches with the one from package data
  94          */
  95         public final function ifAddressMatches ($unl) {
  96                 // Get current package data
  97                 $packageData = $this->getPackageData();
  98
  99                 // Debug message
 100                 //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('SOCKET-CONTAINER[' . __METHOD__ . ':' . __LINE__ . ']: unl=' . $unl . ',packageData=' . print_r($packageData, TRUE));
 101
 102                 // So, does both match?
 103                 $matches = ((isset($packageData[NetworkPackage::PACKAGE_DATA_RECIPIENT])) && ($packageData[NetworkPackage::PACKAGE_DATA_RECIPIENT] === $unl));
 104
 105                 // Return result
 106                 return $matches;
 107         }
 108
 109         /**
 110          * Checks whether the given socket matches with stored
 111          *
 112          * @param       $socketResource         A valid socket resource
 113          * @return      $matches                        Whether given socket matches
 114          */
 115         public final function ifSocketResourceMatches ($socketResource) {
 116                 // Debug message
 117                 /* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('SOCKET-CONTAINER[' . __METHOD__ . ':' . __LINE__ . ']: socketResource[' . gettype($socketResource) . ']=' .$socketResource . ',storedResource[' . gettype($this->getSocketResource()) . ']=' . $this->getSocketResource());
 118
 119                 // So, does both match?
 120                 $matches = ((is_resource($socketResource)) && ($socketResource === $this->getSocketResource()));
 121
 122                 // Return result
 123                 return $matches;
 124         }
 125 }
 126
 127 // [EOF]
 128 ?>