application/hub/main/helper/connection/class_BaseConnectionHelper.php

   1 <?php
   2 /**
   3  * A general ConnectionHelper 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 Hub 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 BaseConnectionHelper extends BaseHubHelper implements Registerable, ProtocolHandler {
  25         /**
  26          * Protocol used
  27          */
  28         private $protocol = 'invalid';
  29
  30         /**
  31          * Port number used
  32          */
  33         private $port = 0;
  34
  35         /**
  36          * (IP) Adress used
  37          */
  38         private $address = 0;
  39
  40         /**
  41          * Sent data in bytes
  42          */
  43         private $sentData = 0;
  44
  45         /**
  46          * Offset
  47          */
  48         private $offset = 0;
  49
  50         /**
  51          * Connect retries for this connection
  52          */
  53         private $retryCount = 0;
  54
  55         /**
  56          * Wether this connection is shutted down
  57          */
  58         private $shuttedDown = false;
  59
  60         /**
  61          * Protected constructor
  62          *
  63          * @param       $className      Name of the class
  64          * @return      void
  65          */
  66         protected function __construct ($className) {
  67                 // Call parent constructor
  68                 parent::__construct($className);
  69
  70                 // Register this connection helper
  71                 Registry::getRegistry()->addInstance('connection', $this);
  72         }
  73
  74         /**
  75          * Getter for port number to satify ProtocolHandler
  76          *
  77          * @return      $port   The port number
  78          */
  79         public final function getPort () {
  80                 return $this->port;
  81         }
  82
  83         /**
  84          * Setter for port number to satify ProtocolHandler
  85          *
  86          * @param       $port   The port number
  87          * @return      void
  88          */
  89         protected final function setPort ($port) {
  90                 $this->port = $port;
  91         }
  92
  93         /**
  94          * Getter for protocol
  95          *
  96          * @return      $protocol       Used protocol
  97          */
  98         public final function getProtocol () {
  99                 return $this->protocol;
 100         }
 101
 102         /**
 103          * Setter for protocol
 104          *
 105          * @param       $protocol       Used protocol
 106          * @return      void
 107          */
 108         protected final function setProtocol ($protocol) {
 109                 $this->protocol = $protocol;
 110         }
 111
 112         /**
 113          * Getter for IP address
 114          *
 115          * @return      $address        The IP address
 116          */
 117         public final function getAddress () {
 118                 return $this->address;
 119         }
 120
 121         /**
 122          * Setter for IP address
 123          *
 124          * @param       $address        The IP address
 125          * @return      void
 126          */
 127         protected final function setAddress ($address) {
 128                 $this->address = $address;
 129         }
 130
 131         /**
 132          * "Accept" a visitor by simply calling it back
 133          *
 134          * @param       $visitorInstance        A Visitor instance
 135          * @return      void
 136          */
 137         protected final function accept (Visitor $visitorInstance) {
 138                 // Just call the visitor
 139                 $visitorInstance->visitConnectionHelper($this);
 140         }
 141
 142         /**
 143          * "Getter" for raw data from a package array. A fragmenter is used which
 144          * will returns us only so many raw data which fits into the back buffer.
 145          * The rest is being held in a back-buffer and waits there for the next
 146          * cycle and while be then sent. This is done by a FIFO.
 147          *
 148          * This method does 4 simple steps:
 149          * 1) Aquire fragmenter object instance from the factory
 150          * 2) Handle over the package data array to the fragmenter
 151          * 3) Request a chunk (which "pops" the chunk from the fragmenter's FIFO)
 152          * 4) Finally return the chunk to the caller
 153          *
 154          * @param       $packageData    Raw package data array
 155          * @return      $rawData                Raw package data bytes
 156          */
 157         private function getRawDataFromPackageArray (array $packageData) {
 158                 // Get the fragmenter instance
 159                 $fragmenterInstance = ObjectFactory::createObjectByConfiguredName('package_fragmenter_class');
 160
 161                 // Implode the package data array and fragement the resulting string
 162                 $fragmenterInstance->fragmentPackageArray($packageData, $this);
 163
 164                 // Get the next raw data chunk from the fragmenter's FIFO
 165                 $rawData = $fragmenterInstance->getNextRawDataChunk($packageData);
 166                 /* DEBUG: */ $this->debugOutput('rawData['.strlen($rawData).']='.$rawData);
 167                 /* DEBUG: */ die();
 168
 169                 // Return it
 170                 return $rawData;
 171         }
 172
 173         /**
 174          * Sends raw package data to the recipient
 175          *
 176          * @param       $packageData    Raw package data
 177          * @return      $sentBytes              Actual sent bytes to the peer
 178          * @throws      InvalidSocketException  If we got a problem with this socket
 179          */
 180         public function sendRawPackageData (array $packageData) {
 181                 // Convert the package data array to a raw data stream
 182                 $rawData = $this->getRawDataFromPackageArray($packageData);
 183
 184                 // Get socket resource
 185                 $socketResource = $this->getSocketResource();
 186
 187                 // And deliver it
 188                 $sentBytes = @socket_write($socketResource, $rawData, $this->getConfigInstance()->getConfigEntry($this->getProtocol() . '_buffer_length') - $this->offset);
 189
 190                 // If there was an error, we don't continue here
 191                 if ($sentBytes === false) {
 192                         // Get socket error code for verification
 193                         $socketError = socket_last_error($socketResource);
 194
 195                         // Get error message
 196                         $errorMessage = socket_strerror($socketError);
 197
 198                         // Shutdown this socket
 199                         $this->shutdownSocket($socketResource);
 200
 201                         // And throw it
 202                         throw new InvalidSocketException(array($this, gettype($socketResource), $socketError, $errorMessage), BaseListener::EXCEPTION_INVALID_SOCKET);
 203                 } // END - if
 204
 205                 // The difference between sent bytes and length of raw data should not be below zero
 206                 assert((strlen($rawData) - $sentBytes) >= 0);
 207
 208                 // Return sent bytes
 209                 return $sentBytes;
 210         }
 211
 212         /**
 213          * Getter for real class name
 214          *
 215          * @return      $class  Name of this class
 216          */
 217         public function __toString () {
 218                 // Class name representation
 219                 $class = $this->getAddress() . ':' . $this->getPort() . ':' . parent::__toString();
 220
 221                 // Return it
 222                 return $class;
 223         }
 224
 225         /**
 226          * Checks wether the connect retry is exhausted
 227          *
 228          * @return      $isExhaused             Wether connect retry is exchausted
 229          */
 230         public final function isConnectRetryExhausted () {
 231                 // Construct config entry
 232                 $configEntry = $this->getProtocol() . '_connect_retry_max';
 233
 234                 // Check it out
 235                 $isExhausted = ($this->retryCount >=  $this->getConfigInstance()->getConfigEntry($configEntry));
 236
 237                 // Return it
 238                 return $isExhausted;
 239         }
 240
 241         /**
 242          * Increases the connect retry count
 243          *
 244          * @return      void
 245          */
 246         public final function increaseConnectRetry () {
 247                 $this->retryCount++;
 248         }
 249
 250         /**
 251          * Marks this connection as shutted down
 252          *
 253          * @return      void
 254          */
 255         protected final function markConnectionShutdown () {
 256                 $this->shuttedDown = true;
 257         }
 258
 259         /**
 260          * Getter for shuttedDown
 261          *
 262          * @return      $shuttedDown    Wether this connection is shutted down
 263          */
 264         public final function isShuttedDown () {
 265                 return $this->shuttedDown;
 266         }
 267 }
 268
 269 // [EOF]
 270 ?>