application/hub/main/helper/connection/ipv4/udp/class_UdpConnectionHelper.php

   1 <?php
   2 /**
   3  * A UDP connection helper class
   4  *
   5  * @author              Roland Haeder <webmaster@shipsimu.org>
   6  * @version             0.0.0
   7  * @copyright   Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2015 Hub Developer Team
   8  * @license             GNU GPL 3.0 or any newer version
   9  * @link                http://www.shipsimu.org
  10  * @todo                Find an interface for hub helper
  11  *
  12  * This program is free software: you can redistribute it and/or modify
  13  * it under the terms of the GNU General Public License as published by
  14  * the Free Software Foundation, either version 3 of the License, or
  15  * (at your option) any later version.
  16  *
  17  * This program is distributed in the hope that it will be useful,
  18  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  19  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  20  * GNU General Public License for more details.
  21  *
  22  * You should have received a copy of the GNU General Public License
  23  * along with this program. If not, see <http://www.gnu.org/licenses/>.
  24  */
  25 class UdpConnectionHelper extends BaseIpV4ConnectionHelper implements ConnectionHelper {
  26         /**
  27          * Protected constructor
  28          *
  29          * @return      void
  30          */
  31         protected function __construct () {
  32                 // Call parent constructor
  33                 parent::__construct(__CLASS__);
  34
  35                 // Set protocol
  36                 $this->setProtocolName('udp');
  37         }
  38
  39         /**
  40          * Creates a half-connected socket resource ("connection") for given
  41          * recipient in package data. After you called this method you still need to
  42          * connect to the other node.
  43          *
  44          * @param       $packageData            Raw package data
  45          * @return      $socketResource         Socket resource
  46          */
  47         public static function createConnectionFromPackageData (array $packageData) {
  48                 $this->debugBackTrace('[' . __METHOD__ . ':' . __LINE__ . ']:  Unfinished method, packageData[]=' . count($packageData));
  49         }
  50
  51         /**
  52          * Do the shutdown sequence for this connection helper
  53          *
  54          * @return      void
  55          * @throws      SocketShutdownException         If the current socket could not be shut down
  56          * @todo        Implement a filter for ease notification of other objects like the pool
  57          */
  58         public function doShutdown () {
  59                 $this->partialStub('Please implement this method.');
  60         }
  61 }
  62
  63 // [EOF]
  64 ?>