application/hub/main/discovery/socket/class_PackageSocketDiscovery.php

   1 <?php
   2 /**
   3  * A socket discovery class
   4  *
   5  * @author              Roland Haeder <webmaster@ship-simu.org>
   6  * @version             0.0.0
   7  * @copyright   Copyright (c) 2007, 2008 Roland Haeder, 2009, 2010 Core 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 PackageSocketDiscovery extends BaseDiscovery implements DiscoverableSocket, 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          * Create an instance of this class
  37          *
  38          * @return      $discoveryInstance      An instance of this discovery class
  39          */
  40         public final static function createPackageSocketDiscovery () {
  41                 // Get an instance of this class
  42                 $discoveryInstance = new PackageSocketDiscovery();
  43
  44                 // Output debug message
  45                 $discoveryInstance->debugOutput('SOCKET-DISCOVERY: Initialized.');
  46
  47                 // Return the prepared instance
  48                 return $discoveryInstance;
  49         }
  50
  51         /**
  52          * Tries to discover the right socket for given package data and returns a
  53          * matching socket resource for that protocol.
  54          *
  55          * @param       $packageData            Raw package data array
  56          * @return      $socketResource         A valid socket resource
  57          */
  58         public function discoverSocket (array $packageData) {
  59                 // First we need a tags instance
  60                 $tagsInstance = PackageTagsFactory::createPackageTagsInstance();
  61
  62                 /*
  63                  * We need to decide here which socket (TCP or UDP) should be used for
  64                  * the actual data transmission. In this process we will find out if
  65                  * the recipient of this package has already a known (registered) socket
  66                  * and if so we can re-use it. If there is no socket registered, we try
  67                  * to make a new connection (TCP or UDP) to the given IP:port.
  68                  */
  69                 $protocolName = $tagsInstance->chooseProtocolFromPackageData($packageData);
  70
  71                 // Abort here
  72                 die(__METHOD__ . ':' . $protocolName . "\n");
  73         }
  74 }
  75
  76 // [EOF]
  77 ?>