application/hub/interfaces/socket/class_SocketTag.php

   1 <?php
   2 /**
   3  * An interface/tag for socket classes
   4  *
   5  * @author              Roland Haeder <webmaster@shipsimu.org>
   6  * @version             0.0.0
   7  * @copyright   Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2014 Hub 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 interface SocketTag extends FrameworkInterface {
  25         /**
  26          * "Getter" for a valid socket resource from given packae data.
  27          *
  28          * @param       $packageData            Raw package data
  29          * @param       $connectionType         Type of connection, can be 'incoming', 'outgoing', 'server' or default
  30          * @return      $socketResource         Socket resource
  31          * @throws      InvalidConnectionTypeException  If the provided connection type is not valid
  32          */
  33         function getSocketFromPackageData (array $packageData, $connectionType = NULL);
  34 }
  35
  36 // [EOF]
  37 ?>