Cleanup of previous commit.
[core.git] / inc / classes / main / container / socket / class_SocketContainer.php
1 <?php
2 /**
3  * A Socket Container class
4  *
5  * @author              Roland Haeder <webmaster@shipsimu.org>
6  * @version             0.0.0
7  * @copyright   Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2014 Core Developer Team
8  * @license             GNU GPL 3.0 or any newer version
9  * @link                http://www.shipsimu.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 SocketContainer extends BaseContainer implements Registerable {
25         /**
26          * Protected constructor
27          *
28          * @return      void
29          */
30         protected function __construct () {
31                 // Call parent constructor
32                 parent::__construct(__CLASS__);
33         }
34
35         /**
36          * Creates an instance of this Container class and prepares it for usage
37          *
38          * @param       $socketResource         A valid socket resource
39          * @param       $protocolInstance       A ProtocolHandler instance
40          * @param       $packageData            Raw package data
41          * @return      $containerInstance      An instance of this Container class
42          */
43         public static final function createSocketContainer ($socketResource, ProtocolHandler $protocolInstance = NULL, array $packageData = array()) {
44                 // Get a new instance
45                 $containerInstance = new SocketContainer();
46
47                 // Remove unneeded entries
48                 unset($packageData[NetworkPackage::PACKAGE_DATA_CONTENT]);
49                 unset($packageData[NetworkPackage::PACKAGE_DATA_SIGNATURE]);
50
51                 // Debug message
52                 //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('SOCKET-CONTAINER[' . __METHOD__ . ':' . __LINE__ . ']:socketResource=' . $socketResource . ',packageData='.print_r($packageData, TRUE));
53
54                 // Set the resource ...
55                 $containerInstance->setSocketResource($socketResource);
56
57                 // ..., protocol instance ...
58                 $containerInstance->setProtocolInstance($protocolInstance);
59
60                 // ... and package data
61                 $containerInstance->setPackageData($packageData);
62
63                 // Return the prepared instance
64                 return $containerInstance;
65         }
66
67         /**
68          * Checks whether the given Universal Node Locator matches with the one from package data
69          *
70          * @param       $unlInstance            An instance of a LocateableNode class
71          * @return      $matches        Whether $address matches with the one from package data
72          */
73         public final function ifAddressMatches (LocateableNode $unlInstance) {
74                 // Get current package data
75                 $packageData = $this->getPackageData();
76
77                 // Debug message
78                 //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('SOCKET-CONTAINER: unlInstance=' . print_r($unlInstance, TRUE) . ',packageData=' . print_r($packageData, TRUE));
79
80                 // So, does both match?
81                 die(__METHOD__ . ': Unfinished.' . PHP_EOL);
82                 $matches = ((isset($packageData[NetworkPackage::PACKAGE_DATA_RECIPIENT])) && ($packageData[NetworkPackage::PACKAGE_DATA_RECIPIENT] === $unlInstance));
83
84                 // Return result
85                 return $matches;
86         }
87
88         /**
89          * Checks whether the given socket matches with stored
90          *
91          * @param       $unlInstance    An instance of a LocateableNode class
92          * @return      $matches                Whether given socket matches
93          */
94         public final function ifSocketResourceMatches ($socketResource) {
95                 // Debug message
96                 /* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('SOCKET-CONTAINER: socketResource[' . gettype($socketResource) . ']=' .$socketResource . ',storedResource[' . gettype($this->getSocketResource()) . ']=' . $this->getSocketResource());
97
98                 // So, does both match?
99                 $matches = ((is_resource($socketResource)) && ($socketResource === $this->getSocketResource()));
100
101                 // Return result
102                 return $matches;
103         }
104 }
105
106 // [EOF]
107 ?>