3 * A database wrapper for distributed hash tables
5 * @author Roland Haeder <webmaster@ship-simu.org>
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
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.
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.
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/>.
24 class NodeDistributedHashTableDatabaseWrapper extends BaseDatabaseWrapper implements NodeDhtWrapper, Registerable {
25 // Constants for database table names
26 const DB_TABLE_NODE_DHT = 'node_dht';
28 // Constants for database column names
29 const DB_COLUMN_SESSION_ID = 'session_id';
30 const DB_COLUMN_IP_PORT = 'ip_port';
33 * Protected constructor
37 protected function __construct () {
38 // Call parent constructor
39 parent::__construct(__CLASS__);
43 * Creates an instance of this database wrapper by a provided user class
45 * @return $wrapperInstance An instance of the created wrapper class
47 public static final function createNodeDistributedHashTableDatabaseWrapper () {
49 $wrapperInstance = new NodeDistributedHashTableDatabaseWrapper();
51 // Set (primary!) table name
52 $wrapperInstance->setTableName(self::DB_TABLE_NODE_DHT);
54 // Return the instance
55 return $wrapperInstance;
59 * Checks whether the local (*this*) node is registered in the DHT by
60 * checking if the external ip/port is found.
62 * @return $isRegistered Whether *this* node is registered in the DHT
64 public function isLocalNodeRegistered () {
66 $nodeInstance = Registry::getRegistry()->getInstance('node');
68 // Get a dataset instance
69 $searchInstance = ObjectFactory::createObjectByConfiguredName('search_criteria_class');
71 // Add ip:port as criteria
72 $searchInstance->addCriteria(self::DB_COLUMN_IP_PORT, $nodeInstance->getAddressPort());
73 $searchInstance->setLimit(1);
75 // Query database and get a result instance back
76 $resultInstance = $this->doSelectByCriteria($searchInstance);
79 $isRegistered = $resultInstance->next();
86 * Updates local (*this*) node data in DHT, this is but not limited to the
87 * session id, ip number (and/or hostname) and port number.
91 public function updateLocalNode () {
92 $this->partialStub('Not implemented yet.');
96 * Registeres the local (*this*) node with its data in the DHT.
100 public function registerLocalNode () {
101 $this->partialStub('Not implemented yet.');