* You should have received a copy of the GNU General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
-class BaseHubSystem extends BaseFrameworkSystem {
+class BaseHubSystem extends BaseFrameworkSystem implements HubInterface {
// Exception codes
const EXCEPTION_CHUNK_ALREADY_ASSEMBLED = 0x900;
const EXCEPTION_ANNOUNCEMENT_NOT_ACCEPTED = 0x901;
* @throws BadMethodCallException If socket_last_error() gives zero back
* @todo Move all this socket-related stuff into own class, most of it resides in BaseListener
*/
- protected final function handleSocketError ($method, $line, StorableSocket $socketInstance, array $socketData) {
+ public final function handleSocketError ($method, $line, StorableSocket $socketInstance, array $socketData) {
// Trace message
/* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugOutput('HUB-SYSTEM: CALLED!');
--- /dev/null
+Deny from all
--- /dev/null
+Deny from all
--- /dev/null
+
+ // First get a socket
+ // @TODO Add some DNS caching here
+
+ // Open connection
+ if ($helperInstance->isProxyUsed() === true) {
+ // Resolve hostname into IP address
+ $ip = ConsoleTools::resolveIpAddress($helperInstance->getConfigInstance()->getConfigEntry('proxy_host'));
+
+ // @TODO Handle $ip = false
+
+ // Connect to host through proxy connection
+ $socketResource = fsockopen($ip, $helperInstance->getConfigInstance()->getConfigEntry('proxy_port'), $errorNo, $errorStr, 30);
+ } else {
+ // Connect to host directly
+ $socketResource = fsockopen('188.138.90.169', 80, $errorNo, $errorStr, 30);
+ }
+
+ // Check if there was an error else
+ if ($errorNo > 0) {
+ // Then throw again
+ throw new InvalidSocketException(array($helperInstance, $socketResource, $errorNo, $errorStr), BaseListener::EXCEPTION_INVALID_SOCKET);
+ } // END - if
--- /dev/null
+
+ /**
+ * Determines own remote IP address (e.g. can be used to probe if we are
+ * reachable from outside by determining external address and then connect to it.
+ * This is accomblished by connecting to the IP of www.shipsimu.org which
+ * should default to 188.138.90.169 and requesting /ip.php which does only
+ * return the content of $_SERVER['REMOTE_ADDR']. Of course, this method
+ * requires a working Internet connection.
+ *
+ * This method is taken from a user comment on php.net and heavily rewritten.
+ * Compare to following link:
+ * http://de.php.net/manual/en/function.socket-create.php#49368
+ *
+ * @return $externalAddress The determined external address address
+ * @todo Make IP, host name, port and script name configurable
+ */
+ public static function determineExternalAddress () {
+ // Get helper instance
+ $helperInstance = new ConsoleTools();
+
+ // First get a socket
+ // @TODO Add some DNS caching here
+
+ // Open connection
+ if ($helperInstance->isProxyUsed() === true) {
+ // Resolve hostname into IP address
+ $ip = ConsoleTools::resolveIpAddress($helperInstance->getConfigInstance()->getConfigEntry('proxy_host'));
+
+ // @TODO Handle $ip = false
+
+ // Connect to host through proxy connection
+ $socketResource = fsockopen($ip, $helperInstance->getConfigInstance()->getConfigEntry('proxy_port'), $errorNo, $errorStr, 30);
+ } else {
+ // Connect to host directly
+ $socketResource = fsockopen('188.138.90.169', 80, $errorNo, $errorStr, 30);
+ }
+
+ // Check if there was an error else
+ if ($errorNo > 0) {
+ // Then throw again
+ throw new InvalidSocketException(array($helperInstance, $socketResource, $errorNo, $errorStr), BaseListener::EXCEPTION_INVALID_SOCKET);
+ } // END - if
+
+ // Prepare the GET request
+ $request = 'GET ' . ($helperInstance->isProxyUsed() === true ? 'http://shipsimu.org' : '') . '/ip.php HTTP/1.0' . self::HTTP_EOL;
+ $request .= 'Host: shipsimu.org' . self::HTTP_EOL;
+ $request .= 'User-Agent: ' . $this->getUserAgent() . self::HTTP_EOL;
+ $request .= 'Connection: close' . self::HTTP_EOL;
+
+ // Do we use proxy?
+ if ($helperInstance->isProxyUsed() === true) {
+ // CONNECT method?
+ if ($helperInstance->getConfigInstance()->getConfigEntry('proxy_connect_method') == 'Y') {
+ // Setup proxy tunnel
+ $response = $helperInstance->setupProxyTunnel('shipsimu.org', 80, $socketResource);
+
+ // If the response is invalid, abort
+ if ((count($response) == 3) && (empty($response[0])) && (empty($response[1])) && (empty($response[2]))) {
+ // Invalid response!
+ $helperInstance->debugBackTrace('Proxy tunnel not working: response=' . print_r($response, true));
+ } // END - if
+ } else {
+ // Add header for proxy
+ $request .= 'Proxy-Connection: Keep-Alive' . self::HTTP_EOL;
+ }
+ } // END - if
+
+ // Add last HTTP_EOL
+ $request .= self::HTTP_EOL;
+
+ // Send it to the socket
+ fwrite($socketResource, $request);
+
+ // Init IP (this will always be the last line)
+ $externalAddress = 'invalid';
+
+ // And read the reply
+ while (!feof($socketResource)) {
+ // Get line
+ $externalAddress = trim(fgets($socketResource, 128));
+
+ // Detect HTTP response
+ if ((substr($externalAddress, 0, 7) == 'HTTP/1.') && (substr($externalAddress, -6, 6) != '200 OK')) {
+ // Stop processing
+ break;
+ } // END - if
+ } // END - while
+
+ // Close socket
+ fclose($socketResource);
+
+
+ // Debug message
+ /* DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugOutput('CONSOLE-TOOLS: Resolved external address: ' . $externalAddress);
+
+ // Return determined external address
+ return $externalAddress;
+ }
--- /dev/null
+<?php
+// Own namespace
+namespace CoreFramework\Client\Http;
+
+/**
+ * A HTTP client class
+ *
+ * @author Roland Haeder <webmaster@ship-simu.org>
+ * @version 0.0.0
+ * @copyright Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2017 Core Developer Team
+ * @license GNU GPL 3.0 or any newer version
+ * @link http://www.ship-simu.org
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program. If not, see <http://www.gnu.org/licenses/>.
+ */
+class HttpClient extends BaseClient implements Client {
+ // Constants
+ const HTTP_EOL = "\r\n";
+ const HTTP_USER_AGENT = 'HttpClient-Core/1.0';
+
+ /**
+ * Protected constructor
+ *
+ * @return void
+ */
+ protected function __construct () {
+ // Set default user agent string (to allow other classes to override this)
+ $this->setUserAgent(self::HTTP_USER_AGENT);
+
+ // Call parent constructor
+ parent::__construct(__CLASS__);
+ }
+
+ /**
+ * Creates an instance of this Client class and prepares it for usage
+ *
+ * @return $clientInstance An instance of a Client class
+ */
+ public final static function createHttpClient () {
+ // Get a new instance
+ $clientInstance = new HttpClient();
+
+ // Return the prepared instance
+ return $clientInstance;
+ }
+
+ /**
+ * Checks wether proxy configuration is used
+ *
+ * @return $isUsed Wether proxy is used
+ */
+ protected function isProxyUsed () {
+ // Do we have cache?
+ if (!isset($GLOBALS[__METHOD__])) {
+ // Determine it
+ $GLOBALS[__METHOD__] = (($this->getConfigInstance()->getConfigEntry('proxy_host') != '') && ($this->getConfigInstance()->getConfigEntry('proxy_port') > 0));
+ } // END - if
+
+ // Return cache
+ return $GLOBALS[__METHOD__];
+ }
+
+ /**
+ * Sets up a proxy tunnel for given hostname and through resource
+ *
+ * @param $host Host to connect to
+ * @param $port Port number to connect to
+ * @return $response Response array
+ */
+ protected function setupProxyTunnel ($host, $port) {
+ // Initialize array
+ $response = array('', '', '');
+
+ // Do the connect
+ $respArray = $this->doConnectRequest($host, $port);
+
+ // Analyze first header line
+ if (((strtolower($respArray[0]) !== 'http/1.0') && (strtolower($respArray[0]) !== 'http/1.1')) || ($respArray[1] != '200')) {
+ // Response code is not 200
+ return $response;
+ } // END - if
+
+ // All fine!
+ return $respArray;
+ }
+
+ /**
+ * Sends a raw HTTP request out to given IP/host and port number
+ *
+ * @param $method Request method (GET, POST, HEAD, CONNECT, ...)
+ * @param $host Host to connect to
+ * @param $port Port number to connect to
+ * @return $responseArray Array with raw response
+ */
+ private function sendRawHttpRequest ($method, $host, $port, array $header = array()) {
+ // Minimum raw HTTP/1.1 request
+ $rawRequest = $method . ' ' . $host . ':' . $port . ' HTTP/1.1' . self::HTTP_EOL;
+ $rawRequest .= 'Host: ' . $host . ':' . $port . self::HTTP_EOL;
+
+ // Use login data to proxy? (username at least)
+ if ($this->getConfigInstance()->getConfigEntry('proxy_username') != '') {
+ // Add it as well
+ $encodedAuth = base64_encode($this->getConfigInstance()->getConfigEntry('proxy_username') . ':' . $this->getConfigInstance()->getConfigEntry('proxy_password'));
+ $rawRequest .= 'Proxy-Authorization: Basic ' . $encodedAuth . self::HTTP_EOL;
+ } // END - if
+
+ // Add last new-line
+ $rawRequest .= self::HTTP_EOL;
+ //* DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugOutput('HTTP-CLIENT: rawRequest=' . $rawRequest);
+
+ // Write request
+ fwrite($this->getSocketResource(), $rawRequest);
+
+ // Got response?
+ if (feof($this->getSocketResource())) {
+ // No response received
+ return $response;
+ } // END - if
+
+ // Read the first line
+ $resp = trim(fgets($this->getSocketResource(), 10240));
+
+ // "Explode" the string to an array
+ $responseArray = explode(' ', $resp);
+
+ // And return it
+ return $responseArray;
+ }
+
+ /**
+ * A HTTP/1.1 CONNECT request
+ *
+ * @param $host Host to connect to
+ * @param $port Port number to connect to
+ * @return $responseArray An array with the read response
+ */
+ public function doConnectRequest ($host, $port) {
+ // Prepare extra header(s)
+ $headers = array(
+ 'Proxy-Connection' => 'Keep-Alive'
+ );
+
+ // Prepare raw request
+ $responseArray = $this->sendRawHttpRequest('CONNECT', $host, $port, $headers);
+
+ // Return response array
+ return $responseArray;
+ }
+
+}
--- /dev/null
+Deny from all
--- /dev/null
+<?php
+// Own namespace
+namespace Hub\Factory\Client;
+
+// Import application-specific stuff
+use Hub\Container\Socket\StorableSocket;
+
+// Import framework stuff
+use CoreFramework\Factory\ObjectFactory;
+use CoreFramework\Registry\Registry;
+
+/**
+ * An object factory for clients
+ *
+ * @author Roland Haeder <webmaster@shipsimu.org>
+ * @version 0.0.0
+ * @copyright Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2017 Core Developer Team
+ * @license GNU GPL 3.0 or any newer version
+ * @link http://www.shipsimu.org
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program. If not, see <http://www.gnu.org/licenses/>.
+ */
+class ClientFactory extends ObjectFactory {
+ /**
+ * Protected constructor
+ *
+ * @return void
+ */
+ protected function __construct () {
+ // Call parent constructor
+ parent::__construct(__CLASS__);
+ }
+
+ /**
+ * Creates a client object for given protocol. This method uses the
+ * registry pattern to cache those instances.
+ *
+ * @param $protocolInstance An instance of a HandleableProtocol class to create a client object for (e.g. 'http' for a HTTP/1.1 client)
+ * @param $socketInstance An instance of a StorableSocket class (or NULL)
+ * @return $clientInstance An instance of the requested client
+ */
+ public static final function createClientByProtocolInstance (HandleableProtocol $protocolInstance, StorableSocket $socketInstance = NULL) {
+ // Default is NULL (to initialize variable)
+ $clientInstance = NULL;
+
+ // Generate registry key
+ $registryKey = strtolower($protocolInstance->getProtocolName()) . '_client';
+
+ // Is the key already in registry?
+ if (Registry::getRegistry()->instanceExists($registryKey)) {
+ // Then use that instance
+ $clientInstance = Registry::getRegistry()->getInstance($registryKey);
+
+ // Is socket instance given?
+ if ($socketInstance instanceof StorableSocket) {
+ // Set socket instance
+ $clientInstance->setSocketInstance($socketInstance);
+ } // END - if
+ } else {
+ // Generate object instance
+ $clientInstance = self::createObjectByConfiguredName($registryKey, array($socketInstance));
+
+ // Set it in registry for later re-use
+ Registry::getRegistry()->addInstance($registryKey, $clientInstance);
+ }
+
+ // Return the prepared instance
+ return $clientInstance;
+ }
+
+}
// Import application-specific stuff
use Hub\Container\Socket\StorableSocket;
use Hub\Factory\Information\Connection\ConnectionInfoFactory;
+use Hub\Generic\BaseHubSystem;
use Hub\Handler\RawData\BaseRawDataHandler;
use Hub\Helper\Connection\BaseConnectionHelper;
use Hub\Network\Package\NetworkPackage;
use CoreFramework\Factory\ObjectFactory;
use CoreFramework\Factory\Registry\Socket\SocketRegistryFactory;
use CoreFramework\Generic\UnsupportedOperationException;
-use CoreFramework\Object\BaseFrameworkSystem;
use CoreFramework\Visitor\Visitable;
use CoreFramework\Visitor\Visitor;
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
-class BaseListener extends BaseFrameworkSystem implements Visitable {
+class BaseListener extends BaseHubSystem implements Visitable {
// Exception code constants
const EXCEPTION_SOCKET_ALREADY_REGISTERED = 0xa01;
const EXCEPTION_SOCKET_CREATION_FAILED = 0xa02;
* @throws InvalidServerSocketException If the given resource is no server socket
* @throws SocketAlreadyRegisteredException If the given resource is already registered
*/
- protected function registerServerSocketResource (StorableSocket $socketInstance) {
+ protected function registerServerSocketInstance (StorableSocket $socketInstance) {
// First check if it is valid
if (!$socketInstance->isServerSocketResource()) {
// No server socket
} // END - if
// Set the main socket
- $this->registerServerSocketResource($mainSocket);
+ $this->registerServerSocketInstance($mainSocket);
// Initialize the peer pool instance
$poolInstance = ObjectFactory::createObjectByConfiguredName('node_pool_class', array($this));
if (!socket_bind($mainSocket, $this->getListenAddress(), $this->getListenPort())) {
// Handle the socket error with a faked recipientData array
$this->handleSocketError(__METHOD__, __LINE__, $mainSocket, array('0.0.0.0', '0'));
- /*
- // Get socket error code for verification
- $socketError = socket_last_error($mainSocket);
-
- // Get error message
- $errorMessage = socket_strerror($socketError);
-
- // Shutdown this socket
- $this->shutdownSocket($mainSocket);
-
- // And throw again
- throw new InvalidSocketException(array($this, $mainSocket, $socketError, $errorMessage), SocketHandler::EXCEPTION_INVALID_SOCKET);
- */
} // END - if
// Now, we want non-blocking mode
if (!socket_set_nonblock($mainSocket)) {
// Handle the socket error with a faked recipientData array
$this->handleSocketError(__METHOD__, __LINE__, $mainSocket, array('0.0.0.0', '0'));
- /*
- // Get socket error code for verification
- $socketError = socket_last_error($socket);
-
- // Get error message
- $errorMessage = socket_strerror($socketError);
-
- // Shutdown this socket
- $this->shutdownSocket($mainSocket);
-
- // And throw again
- throw new InvalidSocketException(array($this, $mainSocket, $socketError, $errorMessage), SocketHandler::EXCEPTION_INVALID_SOCKET);
- */
} // END - if
// Set the option to reuse the port
if (!socket_set_option($mainSocket, SOL_SOCKET, SO_REUSEADDR, 1)) {
// Handle the socket error with a faked recipientData array
$this->handleSocketError(__METHOD__, __LINE__, $mainSocket, array('0.0.0.0', '0'));
- /*
- // Get socket error code for verification
- $socketError = socket_last_error($mainSocket);
-
- // Get error message
- $errorMessage = socket_strerror($socketError);
-
- // Shutdown this socket
- $this->shutdownSocket($mainSocket);
-
- // And throw again
- throw new InvalidSocketException(array($this, $mainSocket, $socketError, $errorMessage), SocketHandler::EXCEPTION_INVALID_SOCKET);
- */
} // END - if
// Remember the socket in our class
- $this->registerServerSocketResource($mainSocket);
+ $this->registerServerSocketInstance($mainSocket);
// Initialize the network package handler
$handlerInstance = ObjectFactory::createObjectByConfiguredName('udp_raw_data_handler_class');
// Own namespace
namespace Hub\AptProxy;
+// Import application-specific stuff
+use Hub\Generic\HubInterface;
+
// Import framework stuff
use CoreFramework\Controller\Controller;
-use CoreFramework\Generic\FrameworkInterface;
use CoreFramework\Response\Responseable;
/**
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
-interface AptProxy extends FrameworkInterface {
+interface AptProxy extends HubInterface {
/**
* Method to "bootstrap" the apt-proxy. This step does also apply provided
* command-line arguments stored in the request instance. You should now
// Own namespace
namespace Hub\Miner;
-// Import framework stuff
-use CoreFramework\Generic\FrameworkInterface;
+// Import application-specific stuff
+use Hub\Generic\HubInterface;
/**
* An interface for minable (blocks)
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
-interface Minable extends FrameworkInterface {
+interface Minable extends HubInterface {
}
// [EOF]
// Own namespace
namespace Hub\Chatter;
+// Import application-specific stuff
+use Hub\Generic\HubInterface;
+
// Import framework stuff
use CoreFramework\Controller\Controller;
-use CoreFramework\Generic\FrameworkInterface;
use CoreFramework\Response\Responseable;
/**
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
-interface Chatter extends FrameworkInterface {
+interface Chatter extends HubInterface {
/**
* Method to "bootstrap" the chatter. This step does also apply provided
* command-line arguments stored in the request instance. You should now
--- /dev/null
+<?php
+// Own namespace
+namespace Hub\Generic;
+
+// Import application-specific stuff
+use Hub\Container\Socket\StorableSocket;
+
+// Inport frameworks stuff
+use CoreFramework\Generic\FrameworkInterface;
+
+/**
+ * This is the top-level interface for all hub-based interfaces.
+ *
+ * @author Roland Haeder <webmaster@shipsimu.org>
+ * @version 0.0.0
+ * @copyright Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2017 Hub Developer Team
+ * @license GNU GPL 3.0 or any newer version
+ * @link http://www.shipsimu.org
+ * @todo Find a better name for this interface
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program. If not, see <http://www.gnu.org/licenses/>.
+ */
+interface HubInterface extends FrameworkInterface {
+
+ /**
+ * Checks whether start/end marker are set
+ *
+ * @param $data Data to be checked
+ * @return $isset Whether start/end marker are set
+ */
+ function ifStartEndMarkersSet ($data);
+
+ /**
+ * Handles socket error for given socket resource and peer data. This method
+ * validates socket resource stored in given container if it is a valid
+ * resource (see is_resource()) but assumes valid data in array
+ * $recipientData, except that count($recipientData) is always 2.
+ *
+ * @param $method Value of __METHOD__ from calling method
+ * @param $line Value of __LINE__ from calling method
+ * @param $socketInstance An instance of a StoreableSocket class
+ * @param $socketData A valid socket data array (0 = IP/file name, 1 = port)
+ * @return void
+ * @throws InvalidSocketException If the stored socket resource is no socket resource
+ * @throws BadMethodCallException If socket_last_error() gives zero back
+ * @todo Move all this socket-related stuff into own class, most of it resides in BaseListener
+ */
+ function handleSocketError ($method, $line, StorableSocket $socketInstance, array $socketData);
+
+ /**
+ * Getter for listener pool instance
+ *
+ * @return $listenerPoolInstance Our current listener pool instance
+ */
+ function getListenerPoolInstance ();
+
+ /**
+ * Getter for info instance
+ *
+ * @return $infoInstance An instance of a ShareableInfo class
+ */
+ function getInfoInstance ();
+
+ /**
+ * Getter for node id
+ *
+ * @return $nodeId Current node id
+ */
+ function getNodeId ();
+
+ /**
+ * Getter for private key
+ *
+ * @return $privateKey Current private key
+ */
+ function getPrivateKey ();
+
+ /**
+ * Getter for private key hash
+ *
+ * @return $privateKeyHash Current private key hash
+ */
+ function getPrivateKeyHash ();
+
+ /**
+ * Getter for session id
+ *
+ * @return $sessionId Current session id
+ */
+ function getSessionId ();
+
+}
// Own namespace
namespace Hub\Consumer;
-// Import framework stuff
-use CoreFramework\Generic\FrameworkInterface;
+// Import application-specific stuff
+use Hub\Generic\HubInterface;
/**
* An interface for the producer/consumer implementation
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
-interface Consumer extends FrameworkInterface {
+interface Consumer extends HubInterface {
}
// [EOF]
// Own namespace
namespace Hub\Container\Socket;
-// Import framework stuff
-use CoreFramework\Generic\FrameworkInterface;
+// Import application-specific stuff
+use Hub\Generic\HubInterface;
/**
* An interface for socket containers
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
-interface StorableSocket extends FrameworkInterface {
+interface StorableSocket extends HubInterface {
/**
* Checks whether the given Universal Node Locator matches with the one from package data
// Own namespace
namespace Hub\Crawler;
+// Import application-specific stuff
+use Hub\Generic\HubInterface;
+
// Import framework stuff
use CoreFramework\Controller\Controller;
-use CoreFramework\Generic\FrameworkInterface;
use CoreFramework\Response\Responseable;
use CoreFramework\State\Stateable;
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
-interface Crawler extends FrameworkInterface {
+interface Crawler extends HubInterface {
/**
* Method to "bootstrap" the crawler. This step does also apply provided
* command-line arguments stored in the request instance. You should now
// Own namespace
namespace Hub\Helper\Cruncher;
+// Import application-specific stuff
+use Hub\Generic\HubInterface;
+
// Import framework stuff
use CoreFramework\Controller\Controller;
-use CoreFramework\Generic\FrameworkInterface;
use CoreFramework\Response\Responseable;
/**
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
-interface CruncherHelper extends FrameworkInterface {
+interface CruncherHelper extends HubInterface {
/**
* Method to "bootstrap" the cruncher. This step does also apply provided
* command-line arguments stored in the request instance. You should now
// Own namespace
namespace Hub\Decoder;
-// Import framework stuff
-use CoreFramework\Generic\FrameworkInterface;
+// Import application-specific stuff
+use Hub\Generic\HubInterface;
/**
* An interface for decoders
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
-interface Decodeable extends FrameworkInterface {
+interface Decodeable extends HubInterface {
/**
* Checks whether the assoziated stacker for raw package data has some entries left
*
// Own namespace
namespace Hub\Dht;
-// Import framework stuff
-use CoreFramework\Generic\FrameworkInterface;
+// Import application-specific stuff
+use Hub\Generic\HubInterface;
/**
* An interface for DHTs
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
-interface Distributable extends FrameworkInterface {
+interface Distributable extends HubInterface {
/**
* Initializes the distributable hash table (DHT)
*
// Own namespace
namespace Hub\Executor;
+// Import application-specific stuff
+use Hub\Generic\HubInterface;
+
// Import framework stuff
-use CoreFramework\Generic\FrameworkInterface;
use CoreFramework\State\Stateable;
/**
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
-interface Executor extends FrameworkInterface {
+interface Executor extends HubInterface {
/**
* Initializes the executor, whatever it does.
*
// Own namespace
namespace Hub\Locator\Node;
-// Import framework stuff
-use CoreFramework\Generic\FrameworkInterface;
+// Import application-specific stuff
+use Hub\Generic\HubInterface;
/**
* An interface for node locators (UNL mostly)
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
-interface LocateableNode extends FrameworkInterface {
+interface LocateableNode extends HubInterface {
}
// [EOF]
// Own namespace
namespace Hub\LookupTable;
-// Import framework stuff
-use CoreFramework\Generic\FrameworkInterface;
+// Import application-specific stuff
+use Hub\Generic\HubInterface;
/**
* An interface for lookup tables
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
-interface Lookupable extends FrameworkInterface {
+interface Lookupable extends HubInterface {
}
// [EOF]
// Own namespace
namespace Hub\Helper\Miner;
+// Import application-specific stuff
+use Hub\Generic\HubInterface;
+
// Import framework stuff
use CoreFramework\Controller\Controller;
-use CoreFramework\Generic\FrameworkInterface;
use CoreFramework\Response\Responseable;
/**
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
-interface MinerHelper extends FrameworkInterface {
+interface MinerHelper extends HubInterface {
/**
* Method to "bootstrap" the miner. This step does also apply provided
* command-line arguments stored in the request instance. You should now
// Own namespace
namespace Hub\Assembler;
-// Import framework stuff
-use CoreFramework\Generic\FrameworkInterface;
+// Import application-specific stuff
+use Hub\Generic\HubInterface;
/**
* An interface for a package assembler
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
-interface Assembler extends FrameworkInterface {
+interface Assembler extends HubInterface {
/**
* Chunks the content from $packageContent and feeds it into another queue
* for verification and possible re-requesting.
namespace Hub\Network\Deliver;
// Import application-specific stuff
+use Hub\Generic\HubInterface;
use Hub\Helper\HubHelper;
-// Import framework stuff
-use CoreFramework\Generic\FrameworkInterface;
-
/**
* An interface for package delivery boys... ;-)
*
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
-interface Deliverable extends FrameworkInterface {
+interface Deliverable extends HubInterface {
/**
* "Enqueues" raw content into this delivery class by reading the raw content
* from given helper's template instance and pushing it on the 'undeclared'
// Import application-specific stuff
use Hub\Network\Networkable;
-// Import framework stuff
-use CoreFramework\Generic\FrameworkInterface;
+// Import application-specific stuff
+use Hub\Generic\HubInterface;
/**
* An interface for package receivers
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
-interface Receivable extends FrameworkInterface {
+interface Receivable extends HubInterface {
/**
* Checks whether new raw data from the socket has arrived
*
// Import application-specific stuff
use Hub\Helper\Connection\ConnectionHelper;
-// Import framework stuff
-use CoreFramework\Generic\FrameworkInterface;
+// Import application-specific stuff
+use Hub\Generic\HubInterface;
/**
* An interface for a package fragmenter
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
-interface Fragmentable extends FrameworkInterface {
+interface Fragmentable extends HubInterface {
/**
* This method does "implode" the given package data array into one long
* string, splits it into small chunks, adds a serial number and checksum
// Own namespace
namespace Hub\Pool;
-// Import framework stuff
-use CoreFramework\Generic\FrameworkInterface;
+// Import application-specific stuff
+use Hub\Generic\HubInterface;
/**
* A Poolable interface
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
-interface Poolable extends FrameworkInterface {
+interface Poolable extends HubInterface {
/**
* Pre-shuts down the pool
namespace Hub\Pool\Peer;
// Import application-specific stuff
+use Hub\Container\Socket\StorableSocket;
use Hub\Pool\Poolable;
use Hub\Tag\Socket\SocketTag;
/**
* Adds a socket resource to the peer pool
*
- * @param $socketResource A valid (must be!) socket resource
+ * @param $socketInstance An instance of a StorableSocket class
* @param $connectionType Type of connection, can only be 'incoming', 'outgoing' or 'server'
* @return void
* @throws InvalidSocketException If the given resource is invalid or errorous
* @throws InvalidConnectionTypeException If the provided connection type is not valid
*/
- function addPeer ($socketResource, $connectionType);
+ function addPeer (StorableSocket $socketInstance, $connectionType);
/**
* Getter for array of all socket resource arrays
// Own namespace
namespace Hub\Producer;
-// Import framework stuff
-use CoreFramework\Generic\FrameworkInterface;
+// Import application-specific stuff
+use Hub\Generic\HubInterface;
/**
* An interface for the producer/consumer implementation
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
-interface Producer extends FrameworkInterface {
+interface Producer extends HubInterface {
}
// [EOF]
// Own namespace
namespace Hub\Recipient;
+// Import application-specific stuff
+use Hub\Generic\HubInterface;
+
// Import framework stuff
-use CoreFramework\Generic\FrameworkInterface;
use CoreFramework\Lists\Listable;
/**
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
-interface Recipient extends FrameworkInterface {
+interface Recipient extends HubInterface {
/**
* Tries to resolve given recipient into session ids or Universal Node Locator
* depending on implementation (hint: Template Method Pattern)
namespace Hub\Resolver\Protocol;
// Import application-specific stuff
+use Hub\Generic\HubInterface;
use Hub\Helper\Node\NodeHelper;
-// Import framework stuff
-use CoreFramework\Generic\FrameworkInterface;
/**
* An interface for ProtocolResolvers
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
-interface ProtocolResolver extends FrameworkInterface {
+interface ProtocolResolver extends HubInterface {
/**
* Returns an instance of a LocateableNode class for a given NodeHelper
* instance or null if it was not found.
// Own namespace
namespace Hub\Scanner;
-// Import framework stuff
-use CoreFramework\Generic\FrameworkInterface;
+// Import application-specific stuff
+use Hub\Generic\HubInterface;
/**
* An interface for scanners
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
-interface Scanner extends FrameworkInterface {
+interface Scanner extends HubInterface {
/**
* Runs the scanner (please no loops here)
*
// Import application-specific stuff
use Hub\Helper\Connection\ConnectionHelper;
+// Import application-specific stuff
+use Hub\Generic\HubInterface;
+
// Import framework stuff
-use CoreFramework\Generic\FrameworkInterface;
use CoreFramework\Listener\Listenable;
/**
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
-interface ShareableInfo extends FrameworkInterface {
+interface ShareableInfo extends HubInterface {
/**
* Fills the information class with data from a Listenable instance
*
// Own namespace
namespace Hub\Tag\Socket;
-// Import framework stuff
-use CoreFramework\Generic\FrameworkInterface;
+// Import application-specific stuff
+use Hub\Generic\HubInterface;
/**
* An interface/tag for socket classes
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
-interface SocketTag extends FrameworkInterface {
+interface SocketTag extends HubInterface {
/**
* "Getter" for a valid socket resource from given packae data.
*
// Own namespace
namespace Hub\Source;
-// Import framework stuff
-use CoreFramework\Generic\FrameworkInterface;
+// Import application-specific stuff
+use Hub\Generic\HubInterface;
/**
* An interface for sources
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
-interface Source extends FrameworkInterface {
+interface Source extends HubInterface {
}
// [EOF]
// Own namespace
namespace Hub\Tag;
+// Import application-specific stuff
+use Hub\Generic\HubInterface;
+
// Import framework stuff
-use CoreFramework\Generic\FrameworkInterface;
use CoreFramework\Listener\Listenable;
/**
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
-interface Tagable extends FrameworkInterface {
+interface Tagable extends HubInterface {
/**
* Chooses the right protocol from given package data
*
// Own namespace
namespace Hub\Helper\Unit;
-// Import framework stuff
-use CoreFramework\Generic\FrameworkInterface;
+// Import application-specific stuff
+use Hub\Generic\HubInterface;
/**
* An interface for work/test/foo unit helper
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
-interface UnitHelper extends FrameworkInterface {
+interface UnitHelper extends HubInterface {
/**
* Generates a work/test/foo unit instance
*