application/hub/main/database/wrapper/node/class_NodeDistributedHashTableDatabaseWrapper.php

   1 <?php
   2 /**
   3  * A database wrapper for distributed hash tables
   4  *
   5  * @author              Roland Haeder <webmaster@ship-simu.org>
   6  * @version             0.0.0
   7  * @copyright   Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2012 Hub 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 NodeDistributedHashTableDatabaseWrapper extends BaseDatabaseWrapper implements NodeDhtWrapper, Registerable {
  25         // Constants for database table names
  26         const DB_TABLE_NODE_DHT = 'node_dht';
  27
  28         // Constants for database column names
  29         const DB_COLUMN_NODE_ID    = 'node_id';
  30         const DB_COLUMN_SESSION_ID = 'session_id';
  31         const DB_COLUMN_IP_PORT    = 'ip_port';
  32
  33         /**
  34          * Protected constructor
  35          *
  36          * @return      void
  37          */
  38         protected function __construct () {
  39                 // Call parent constructor
  40                 parent::__construct(__CLASS__);
  41         }
  42
  43         /**
  44          * Creates an instance of this database wrapper by a provided user class
  45          *
  46          * @return      $wrapperInstance        An instance of the created wrapper class
  47          */
  48         public static final function createNodeDistributedHashTableDatabaseWrapper () {
  49                 // Get a new instance
  50                 $wrapperInstance = new NodeDistributedHashTableDatabaseWrapper();
  51
  52                 // Set (primary!) table name
  53                 $wrapperInstance->setTableName(self::DB_TABLE_NODE_DHT);
  54
  55                 // Return the instance
  56                 return $wrapperInstance;
  57         }
  58
  59         /**
  60          * Checks whether the local (*this*) node is registered in the DHT by
  61          * checking if the external ip/port is found.
  62          *
  63          * @return      $isRegistered   Whether *this* node is registered in the DHT
  64          */
  65         public function isLocalNodeRegistered () {
  66                 // Get a search criteria instance
  67                 $searchInstance = ObjectFactory::createObjectByConfiguredName('search_criteria_class');
  68
  69                 // Get node instance
  70                 $nodeInstance = Registry::getRegistry()->getInstance('node');
  71
  72                 // Add ip:port as criteria
  73                 $searchInstance->addCriteria(self::DB_COLUMN_IP_PORT, $nodeInstance->getAddressPort());
  74                 $searchInstance->setLimit(1);
  75
  76                 // Query database and get a result instance back
  77                 $resultInstance = $this->doSelectByCriteria($searchInstance);
  78
  79                 // Is there an entry?
  80                 $isRegistered = $resultInstance->next();
  81
  82                 // Return result
  83                 return $isRegistered;
  84         }
  85
  86         /**
  87          * Registeres the local (*this*) node with its data in the DHT.
  88          *
  89          * @return      void
  90          */
  91         public function registerLocalNode () {
  92                 $this->partialStub('Not implemented yet.');
  93         }
  94
  95         /**
  96          * Updates local (*this*) node data in DHT, this is but not limited to the
  97          * session id, ip number (and/or hostname) and port number.
  98          *
  99          * @return      void
 100          */
 101         public function updateLocalNode () {
 102                 $this->partialStub('Not implemented yet.');
 103         }
 104 }
 105
 106 // [EOF]
 107 ?>