PEAR2_Net_Transmitter-1.0.0a2PEAR2_Net_Transmitter-1.0.0a2/src/PEAR2/Net/Transmitter/SocketException.php

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
<?php

/**
 * Wrapper for network stream functionality.

 * 
 * PHP has built in support for various types of network streams, such as HTTP and TCP sockets. One problem that arises with them is the fact that a single fread/fwrite call might not read/write all the data you intended, regardless of whether you're in blocking mode or not. While the PHP manual offers a workaround in the form of a loop with a few variables, using it every single time you want to read/write can be tedious.

This package abstracts this away, so that when you want to get exactly N amount of bytes, you can be sure the upper levels of your app will be dealing with N bytes. Oh, and the functionality is nicely wrapped in an object (but that's just the icing on the cake).
 * 
 * PHP version 5
 * 
 * @category  Net
 * @package   PEAR2_Net_Transmitter
 * @author    Vasil Rangelov <boen.robot@gmail.com>
 * @copyright 2011 Vasil Rangelov
 * @license   http://www.gnu.org/copyleft/lesser.html LGPL License 2.1
 * @version   1.0.0a2
 * @link      http://pear2.php.net/PEAR2_Net_Transmitter
 */
/**
 * The namespace declaration.
 */
namespace PEAR2\Net\Transmitter;

/**
 * Exception thrown when something goes wrong with the connection.
 * 
 * @category Net
 * @package  PEAR2_Net_Transmitter
 * @author   Vasil Rangelov <boen.robot@gmail.com>
 * @license  http://www.gnu.org/copyleft/lesser.html LGPL License 2.1
 * @link     http://pear2.php.net/PEAR2_Net_Transmitter
 */
class SocketException extends \RuntimeException implements Exception
{

    /**
     * @var int The error code of the last error on the socket.
     */
    protected $error_no = 0;

    /**
     * @var string The error message of the last error on the socket.
     */
    protected $error_str = '';

    /**
     * Creates a new socket exception.
     * 
     * @param string    $message   The Exception message to throw.
     * @param int       $code      The Exception code.
     * @param Exception $previous  The previous exception used for the exception
     * chaining.
     * @param int       $error_no  If provided, holds the system level error
     * number that occurred in the system-level connect() call.
     * @param string    $error_str The error message as a string.
     */
    public function __construct($message = '', $code = 0, $previous = null,
        $error_no = null, $error_str = null
    ) {
        parent::__construct($message, $code, $previous);
        $this->error_no = $error_no;
        $this->error_str = $error_str;
    }

    /**
     * Gets the error code of the last error on the socket.
     * 
     * @return int NULL if none was provided or the number itself.  
     */
    public function getSocketErrorNumber()
    {
        return $this->error_no;
    }

    // @codeCoverageIgnoreStart
    // Unreliable in testing.

    /**
     * Gets the error message of the last error on the socket.
     * 
     * @return string The error message.
     */
    public function getSocketErrorMessage()
    {
        return $this->error_str;
    }

    /**
     * Returns a string representation of the exception.
     * 
     * @return string The exception as a string.
     */
    public function __toString()
    {
        $result = parent::__toString();
        if (0 !== $this->getSocketErrorNumber()) {
            $result .= "\nSocket error number:" . $this->getSocketErrorNumber();
        }
        if ('' !== $this->getSocketErrorMessage()) {
            $result .= "\nSocket error message:"
                . $this->getSocketErrorMessage();
        }
        return $result;
    }

    // @codeCoverageIgnoreEnd
}
EOF