application/hub/main/factories/socket/class_SocketFactory.php

   1 <?php
   2 /**
   3  * A socket factory class
   4  *
   5  * @author              Roland Haeder <webmaster@shipsimu.org>
   6  * @version             0.0.0
   7  * @copyright   Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2015 Hub Developer Team
   8  * @license             GNU GPL 3.0 or any newer version
   9  * @link                http://www.shipsimu.org
  10  * @todo                Find an interface for hub helper
  11  *
  12  * This program is free software: you can redistribute it and/or modify
  13  * it under the terms of the GNU General Public License as published by
  14  * the Free Software Foundation, either version 3 of the License, or
  15  * (at your option) any later version.
  16  *
  17  * This program is distributed in the hope that it will be useful,
  18  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  19  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  20  * GNU General Public License for more details.
  21  *
  22  * You should have received a copy of the GNU General Public License
  23  * along with this program. If not, see <http://www.gnu.org/licenses/>.
  24  */
  25 class SocketFactory extends ObjectFactory {
  26         /**
  27          * Protected constructor
  28          *
  29          * @return      void
  30          */
  31         protected function __construct () {
  32                 // Call parent constructor
  33                 parent::__construct(__CLASS__);
  34         }
  35
  36         /**
  37          * Creates a valid socket resource from given packae data and protocol
  38          *
  39          * @param       $packageData            Raw package data
  40          * @param       $protocolInstance       An instance of a HandleableProtocol class
  41          * @return      $socketResource         Socket resource
  42          */
  43         public static function createSocketFromPackageData (array $packageData, HandleableProtocol $protocolInstance) {
  44                 // Get an instance
  45                 $factoryInstance = new SocketFactory();
  46
  47                 // Construct registry key
  48                 $registryKey = 'socket_' . $protocolInstance->getProtocolName() . '_' . $packageData[NetworkPackage::PACKAGE_DATA_RECIPIENT];
  49
  50                 // Debug message
  51                 //*NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('SOCKET-FACTORY[' . __METHOD__ . ':' . __LINE__ . ']: Trying to find a socket with registryKey=' . $registryKey);
  52
  53                 // Is the key there?
  54                 if (Registry::getRegistry()->instanceExists($registryKey)) {
  55                         // Get container instance
  56                         $containerInstance = Registry::getRegistry()->getInstance($registryKey);
  57
  58                         // Get socket back
  59                         $socketResource = $containerInstance->getSocketResource();
  60
  61                         // Debug message
  62                         //*NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('SOCKET-FACTORY[' . __METHOD__ . ':' . __LINE__ . ']: Using socket ' . $socketResource . '(' . gettype($socketResource) . ') from registry.');
  63                 } else {
  64                         // Construct configuration entry for object factory and get it
  65                         $className = FrameworkConfiguration::getSelfInstance()->getConfigEntry($protocolInstance->getProtocolName() . '_connection_helper_class');
  66
  67                         // Debug message
  68                         //*NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('SOCKET-FACTORY[' . __METHOD__ . ':' . __LINE__ . ']: Going to use class ' . $className . ' for creating a socket resource ...');
  69
  70                         // And call the static method
  71                         $socketResource = call_user_func($className . '::createConnectionFromPackageData', $packageData);
  72
  73                         // Debug message
  74                         //*NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('SOCKET-FACTORY[' . __METHOD__ . ':' . __LINE__ . ']: Created socket ' . $socketResource . '(' . gettype($socketResource) . ') from class ' . $className . '.');
  75
  76                         // Construct container class, this won't be reached if an exception is thrown
  77                         $containerInstance = self::CreateObjectByConfiguredName('socket_container_class', array($socketResource, NULL, $packageData));
  78
  79                         // Register it with the registry
  80                         Registry::getRegistry()->addInstance($registryKey, $containerInstance);
  81
  82                         // Debug message
  83                         //*NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('SOCKET-FACTORY[' . __METHOD__ . ':' . __LINE__ . ']: Socket is now registered in registry.');
  84                 }
  85
  86                 // Return the resource
  87                 return $socketResource;
  88         }
  89 }
  90
  91 // [EOF]
  92 ?>