/**
* A class for registerable socket classes
*
- * @author Roland Haeder <webmaster@ship-simu.org>
+ * @author Roland Haeder <webmaster@shipsimu.org>
* @version 0.0.0
- * @copyright Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2012 Core Developer Team
+ * @copyright Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2015 Core Developer Team
* @license GNU GPL 3.0 or any newer version
- * @link http://www.ship-simu.org
+ * @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
interface RegisterableSocket extends Registerable {
/**
* Checks whether given socket resource is registered. If $socketResource is
- * false only the instance will be checked.
+ * FALSE only the instance will be checked.
*
- * @param $protocolInstance An instance of a ProtocolHandler class
+ * @param $infoInstance An instance of a ShareableInfo class
* @param $socketResource A valid socket resource
* @return $isRegistered Whether the given socket resource is registered
*/
- function isSocketRegistered (ProtocolHandler $protocolInstance, $socketResource);
+ function isSocketRegistered (ShareableInfo $infoInstance, $socketResource);
/**
* Registeres given socket for listener or throws an exception if it is already registered
*
- * @param $protocolInstance An instance of a ProtocolHandler class
+ * @param $infoInstance An instance of a ShareableInfo class
* @param $socketResource A valid socket resource
* @return void
* @throws SocketAlreadyRegisteredException If the given socket is already registered
*/
- function registerSocket (ProtocolHandler $protocolInstance, $socketResource);
+ function registerSocket (ShareableInfo $infoInstance, $socketResource);
/**
* Getter for given listener's socket resource
*
- * @param $protocolInstance An instance of a ProtocolHandler class
+ * @param $listenerInstance An instance of a Listenable class
* @return $socketResource A valid socket resource
* @throws NoSocketRegisteredException If the requested socket is not registered
*/
- function getRegisteredSocketResource (ProtocolHandler $protocolInstance);
+ function getRegisteredSocketResource (Listenable $listenerInstance);
/**
- * "Getter" for protocol/connection instance from given package data
+ * "Getter" for info instance from given package data
*
- * @param $packageData Raw package data
- * @return $protocolInstance An instance of a ProtocolHandler class
+ * @param $packageData Raw package data
+ * @return $infoInstance An instance of a ShareableInfo class
*/
- function getHandlerInstanceFromPackageData (array $packageData);
+ function getInfoInstanceFromPackageData (array $packageData);
}
// [EOF]