]> git.mxchange.org Git - hub.git/blob - application/hub/main/discovery/class_BaseHubDiscovery.php
Moved some constants and added block comments for better reading
[hub.git] / application / hub / main / discovery / class_BaseHubDiscovery.php
1 <?php
2 /**
3  * A PackageRecipient discovery class
4  *
5  * @author              Roland Haeder <webmaster@ship-simu.org>
6  * @version             0.0.0
7  * @copyright   Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2011 Core 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 BaseHubDiscovery extends BaseDiscovery {
25         /**
26          * Protected constructor
27          *
28          * @param       $className      Real class name
29          * @return      void
30          */
31         protected function __construct ($className) {
32                 // Call parent constructor
33                 parent::__construct($className);
34         }
35
36         /**
37          * Determines the protoctol name
38          *
39          * @param       $packageData    Valid package data
40          * @return      $protocolName   Name of used protocol (TCP/UDP/etc.)
41          */
42         protected function determineProtocolByPackageData (array $packageData) {
43                 // First we need a tags instance
44                 $tagsInstance = PackageTagsFactory::createPackageTagsInstance();
45
46                 /*
47                  * We need to decide here which socket (TCP or UDP) should be used for
48                  * the actual data transmission. In this process we will find out if
49                  * the recipient of this package has already a known (registered) socket
50                  * and if so we can re-use it. If there is no socket registered, we try
51                  * to make a new connection (TCP or UDP) to the given IP:port.
52                  */
53                 $protocolName = $tagsInstance->chooseProtocolFromPackageData($packageData);
54
55                 // Return it
56                 return $protocolName;
57         }
58 }
59
60 // [EOF]
61 ?>