inc/main/exceptions/socket/class_SocketShutdownException.php

   1 <?php
   2 // Own namespace
   3 namespace CoreFramework\Socket;
   4
   5 /**
   6  * This exception is thrown if the socket cannot be shut down is not error 107
   7  * which is "Transport endpoint not connected".
   8  *
   9  * @author              Roland Haeder <webmaster@shipsimu.org>
  10  * @version             0.0.0
  11  * @copyright   Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2017 Core Developer Team
  12  * @license             GNU GPL 3.0 or any newer version
  13  * @link                http://www.shipsimu.org
  14  *
  15  * This program is free software: you can redistribute it and/or modify
  16  * it under the terms of the GNU General Public License as published by
  17  * the Free Software Foundation, either version 3 of the License, or
  18  * (at your option) any later version.
  19  *
  20  * This program is distributed in the hope that it will be useful,
  21  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  22  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  23  * GNU General Public License for more details.
  24  *
  25  * You should have received a copy of the GNU General Public License
  26  * along with this program. If not, see <http://www.gnu.org/licenses/>.
  27  */
  28 class SocketShutdownException extends AbstractSocketException {
  29         /**
  30          * A Constructor for this exception
  31          *
  32          * @param       $helperInstance         An instance of a ConnectionHelper class
  33          * @param       $code                           Error code
  34          * @return      void
  35          */
  36         public function __construct (ConnectionHelper $helperInstance, $code) {
  37                 // Get socket resource
  38                 $socketResource = $helperInstance->getSocketResource();
  39
  40                 // Construct the message
  41                 $message = sprintf('[%s:] Socket %s cannot be shutdown down. errNo=%s, errStr=%s',
  42                         $helperInstance->__toString(),
  43                         $socketResource,
  44                         socket_last_error($socketResource),
  45                         socket_strerror(socket_last_error($socketResource))
  46                 );
  47
  48                 // Call parent exception constructor
  49                 parent::__construct($message, $code);
  50         }
  51
  52 }