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

   1 <?php
   2 /**
   3  * A socket factory class
   4  *
   5  * @author              Roland Haeder <webmaster@ship-simu.org>
   6  * @version             0.0.0
   7  * @copyright   Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2011 Core Developer Team
   8  * @license             GNU GPL 3.0 or any newer version
   9  * @link                http://www.ship-simu.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 BaseHubHelper {
  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       $protocolName           Protocol name (TCP/UDP)
  41          * @return      $socketResource         Socket resource
  42          */
  43         public static function createSocketFromPackageData (array $packageData, $protocolName) {
  44                 // Construct registry key
  45                 $registryKey = 'socket_' . $protocolName . '_' . $packageData[NetworkPackage::PACKAGE_DATA_RECIPIENT];
  46
  47                 // Is the key there?
  48                 if (Registry::getRegistry()->instanceExists($registryKey)) {
  49                         // Get container instance
  50                         $containerInstance = Registry::getRegistry()->getInstance($registryKey);
  51
  52                         // Get socket back
  53                         $socketResource = $containerInstance->getSocketResource();
  54                 } else {
  55                         // Construct configuration entry for object factory and get it
  56                         $className = FrameworkConfiguration::getInstance()->getConfigEntry($protocolName . '_connection_helper_class');
  57
  58                         // And call the static method
  59                         $socketResource = call_user_func($className . '::createConnectionFromPackageData', $packageData);
  60
  61                         // Construct container class, this won't be reached if an exception is thrown
  62                         $containerInstance = ObjectFactory::CreateObjectByConfiguredName('socket_container_class', array($socketResource, NULL, $packageData));
  63
  64                         // Register it with the registry
  65                         Registry::getRegistry()->addInstance($registryKey, $containerInstance);
  66                 }
  67
  68                 // Return the resource
  69                 return $socketResource;
  70         }
  71 }
  72
  73 // [EOF]
  74 ?>