Used self::createDebugInstance(__CLASS__)->debugOutput() instead of $fooInstance...
[core.git] / inc / classes / main / container / socket / class_SocketContainer.php
index eff4ca18d7878d61a04cfa10a55ef55f1a47a462..445a90f09be4fb6b55505bf80f11b34a2daafefb 100644 (file)
@@ -4,7 +4,7 @@
  *
  * @author             Roland Haeder <webmaster@ship-simu.org>
  * @version            0.0.0
- * @copyright  Copyright (c) 2007, 2008 Roland Haeder, 2009, 2010 Core Developer Team
+ * @copyright  Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2012 Core Developer Team
  * @license            GNU GPL 3.0 or any newer version
  * @link               http://www.ship-simu.org
  *
@@ -36,18 +36,70 @@ class SocketContainer extends BaseContainer implements Registerable {
         * Creates an instance of this Container class and prepares it for usage
         *
         * @param       $socketResource         A valid socket resource
+        * @param       $protocolInstance       A ProtocolHandler instance
+        * @param       $packageData            Raw package data
         * @return      $containerInstance      An instance of this Container class
         */
-       public final static function createSocketContainer ($socketResource) {
+       public static final function createSocketContainer ($socketResource, ProtocolHandler $protocolInstance = NULL, array $packageData = array()) {
                // Get a new instance
                $containerInstance = new SocketContainer();
 
-               // Set the resource
+               // Remove unneeded entries
+               unset($packageData[NetworkPackage::PACKAGE_DATA_CONTENT]);
+               unset($packageData[NetworkPackage::PACKAGE_DATA_SIGNATURE]);
+
+               // Debug message
+               //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(__METHOD__ . ':socketResource=' . $socketResource . ',packageData='.print_r($packageData,true));
+
+               // Set the resource ...
                $containerInstance->setSocketResource($socketResource);
 
+               // ..., protocol instance ...
+               $containerInstance->setProtocolInstance($protocolInstance);
+
+               // ... and package data
+               $containerInstance->setPackageData($packageData);
+
                // Return the prepared instance
                return $containerInstance;
        }
+
+       /**
+        * Checks whether the given address (IP) matches with the one from the socket resource
+        *
+        * @param       $addressPort    The address:port (IP to check
+        * @return      $matches                Whether $address matches with the one from socket resource
+        */
+       public final function ifAddressMatches ($addressPort) {
+               // Get current package data
+               $packageData = $this->getPackageData();
+
+               // Debug message
+               //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('SOCKET-CONTAINER: addressPort=' . $addressPort . ',packageData=' . print_r($packageData, true));
+
+               // So, does both match?
+               $matches = ((isset($packageData[NetworkPackage::PACKAGE_DATA_RECIPIENT])) && ($packageData[NetworkPackage::PACKAGE_DATA_RECIPIENT] === $addressPort));
+
+               // Return result
+               return $matches;
+       }
+
+       /**
+        * Checks whether the given socket matches with stored
+        *
+        * @param       $addressPort    The address:port (IP to check
+        * @return      $matches                Whether given socket matches
+        */
+       public final function ifSocketResourceMatches ($socketResource) {
+               // Debug message
+               /* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('SOCKET-CONTAINER: socketResource[' . gettype($socketResource) . ']=' .$socketResource . ',storedResource[' . gettype($this->getSocketResource()) . ']=' . $this->getSocketResource());
+
+               // So, does both match?
+               $matches = ((is_resource($socketResource)) && ($socketResource === $this->getSocketResource()));
+
+               // Return result
+               return $matches;
+       }
 }
 
 // [EOF]