]> git.mxchange.org Git - hub.git/blob - application/hub/main/handler/network/udp/class_UdpNetworkPackageHandler.php
'public static final' is the right thing, some variables renamed to make clear what...
[hub.git] / application / hub / main / handler / network / udp / class_UdpNetworkPackageHandler.php
1 <?php
2 /**
3  * A UDP network package handler
4  *
5  * @author              Roland Haeder <webmaster@ship-simu.org>
6  * @version             0.0.0
7  * @copyright   Copyright (c) 2007, 2008 Roland Haeder, 2009, 2010 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 UdpNetworkPackageHandler extends BaseNetworkPackageHandler implements Networkable {
25         /**
26          * Protected constructor
27          *
28          * @return      void
29          */
30         protected function __construct () {
31                 // Call parent constructor
32                 parent::__construct(__CLASS__);
33
34                 // Set handler name
35                 $this->setHandlerName('udp');
36         }
37
38         /**
39          * Creates an instance of this class
40          *
41          * @return      $handlerInstance                An instance of a Networkable class
42          */
43         public static final function createUdpNetworkPackageHandler () {
44                 // Get new instance
45                 $handlerInstance = new UdpNetworkPackageHandler();
46
47                 // Return the prepared instance
48                 return $handlerInstance;
49         }
50
51         /**
52          * Processes a package from given resource. This is mostly useful for TCP
53          * package handling and is implemented in the TcpListener class
54          *
55          * @param       $resource       A valid resource identifier
56          * @return      void
57          * @throws      InvalidResourceException        If the given resource is invalid
58          * @todo        0%
59          */
60         public function processResourcePackage ($resource) {
61                 // Check the resource
62                 if (!is_resource($resource)) {
63                         // Throw an exception
64                         throw new InvalidResourceException($this, self::EXCEPTION_INVALID_RESOURCE);
65                 } // END - if
66
67                 // Implement processing here
68                 $this->partialStub('Please implement this method.');
69         }
70 }
71
72 // [EOF]
73 ?>