3 namespace Org\Mxchange\CoreFramework\Factory\Registry\Socket;
5 // Import framework stuff
6 use Org\Mxchange\CoreFramework\Factory\BaseFactory;
7 use Org\Mxchange\CoreFramework\Factory\Object\ObjectFactory;
8 use Org\Mxchange\CoreFramework\Registry\Object\ObjectRegistry;
11 * A factory class for socket registries
13 * @author Roland Haeder <webmaster@shipsimu.org>
15 * @copyright Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2023 Core Developer Team
16 * @license GNU GPL 3.0 or any newer version
17 * @link http://www.shipsimu.org
19 * This program is free software: you can redistribute it and/or modify
20 * it under the terms of the GNU General Public License as published by
21 * the Free Software Foundation, either version 3 of the License, or
22 * (at your option) any later version.
24 * This program is distributed in the hope that it will be useful,
25 * but WITHOUT ANY WARRANTY; without even the implied warranty of
26 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
27 * GNU General Public License for more details.
29 * You should have received a copy of the GNU General Public License
30 * along with this program. If not, see <http://www.gnu.org/licenses/>.
32 class SocketRegistryFactory extends BaseFactory {
34 * Protected constructor
38 private function __construct () {
39 // Call parent constructor
40 parent::__construct(__CLASS__);
44 * Returns a singleton socket registry instance. If an instance is found in
45 * the registry it will be returned, else a new instance is created and
46 * stored in the same registry entry.
48 * @return $registryInstance A socket registry instance
50 public static final function createSocketRegistryInstance () {
51 // Get registry instance
52 /* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->traceMessage('SOCKET-REGISTRY-FACTORY: CALLED!');
53 $objectRegistryInstance = ObjectRegistry::getRegistry('factory');
55 // Do we have an instance in the registry?
56 if ($objectRegistryInstance->instanceExists('socket_registry')) {
57 // Then use this instance
58 /* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugMessage('SOCKET-REGISTRY-FACTORY: Getting socket registry instance ...');
59 $registryInstance = $objectRegistryInstance->getInstance('socket_registry');
61 // Get the registry instance
62 /* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugMessage('SOCKET-REGISTRY-FACTORY: Creating new socket registry instance ...');
63 $registryInstance = ObjectFactory::createObjectByConfiguredName('socket_registry_class');
65 // Set the instance in registry for further use
66 /* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugMessage('SOCKET-REGISTRY-FACTORY: Adding socket registry instance ...');
67 $objectRegistryInstance->addInstance('socket_registry', $registryInstance);
70 // Return the instance
71 /* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->traceMessage(sprintf('SOCKET-REGISTRY-FACTORY: registryInstance=%s - EXIT!', $registryInstance->__toString()));
72 return $registryInstance;