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 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266
|
<?php
namespace PhpAmqpLib\Wire\IO;
use PhpAmqpLib\Connection\AMQPConnectionConfig;
use PhpAmqpLib\Exception\AMQPConnectionClosedException;
use PhpAmqpLib\Exception\AMQPHeartbeatMissedException;
use PhpAmqpLib\Exception\AMQPIOWaitException;
use PhpAmqpLib\Exception\AMQPRuntimeException;
use PhpAmqpLib\Wire\AMQPWriter;
abstract class AbstractIO
{
const BUFFER_SIZE = 8192;
/** @var null|AMQPConnectionConfig */
protected $config;
/** @var string */
protected $host;
/** @var int */
protected $port;
/** @var int|float */
protected $connection_timeout;
/** @var float */
protected $read_timeout;
/** @var float */
protected $write_timeout;
/** @var int */
protected $heartbeat;
/** @var int */
protected $initial_heartbeat;
/** @var bool */
protected $keepalive;
/** @var int|float */
protected $last_read;
/** @var int|float */
protected $last_write;
/** @var \ErrorException|null */
protected $last_error;
/** @var bool */
protected $canDispatchPcntlSignal = false;
/**
* @param int $len
* @return string
* @throws \PhpAmqpLib\Exception\AMQPIOException
* @throws AMQPRuntimeException
* @throws \PhpAmqpLib\Exception\AMQPSocketException
* @throws \PhpAmqpLib\Exception\AMQPTimeoutException
* @throws \PhpAmqpLib\Exception\AMQPConnectionClosedException
*/
abstract public function read($len);
/**
* @param string $data
* @throws \PhpAmqpLib\Exception\AMQPIOException
* @throws \PhpAmqpLib\Exception\AMQPSocketException
* @throws \PhpAmqpLib\Exception\AMQPConnectionClosedException
* @throws \PhpAmqpLib\Exception\AMQPTimeoutException
*/
abstract public function write($data);
/**
* @return void
*/
abstract public function close();
/**
* @param int|null $sec
* @param int $usec
* @return int
* @throws AMQPIOWaitException
* @throws AMQPRuntimeException
* @throws AMQPConnectionClosedException
*/
public function select(?int $sec, int $usec = 0)
{
$this->check_heartbeat();
$this->setErrorHandler();
try {
$result = $this->do_select($sec, $usec);
$this->throwOnError();
} catch (\ErrorException $e) {
throw new AMQPIOWaitException($e->getMessage(), $e->getCode(), $e->getPrevious());
} finally {
$this->restoreErrorHandler();
}
if ($this->canDispatchPcntlSignal) {
pcntl_signal_dispatch();
}
// no exception and false result - either timeout or signal was sent
if ($result === false) {
$result = 0;
}
return $result;
}
/**
* @param int|null $sec
* @param int $usec
* @return int|bool
* @throws AMQPConnectionClosedException
*/
abstract protected function do_select(?int $sec, int $usec);
/**
* Set ups the connection.
* @return void
* @throws \PhpAmqpLib\Exception\AMQPIOException
* @throws AMQPRuntimeException
*/
abstract public function connect();
/**
* Set connection params connection tune(negotiation).
* @param int $heartbeat
*/
public function afterTune(int $heartbeat): void
{
$this->heartbeat = $heartbeat;
$this->initial_heartbeat = $heartbeat;
}
/**
* Heartbeat logic: check connection health here
* @return void
* @throws AMQPRuntimeException
*/
public function check_heartbeat()
{
// ignore unless heartbeat interval is set
if ($this->heartbeat !== 0 && $this->last_read > 0 && $this->last_write > 0) {
// server has gone away
$this->checkBrokerHeartbeat();
// time for client to send a heartbeat
$now = microtime(true);
if (($this->heartbeat / 2) < $now - $this->last_write) {
$this->write_heartbeat();
}
}
}
/**
* @throws \PhpAmqpLib\Exception\AMQPHeartbeatMissedException
*/
protected function checkBrokerHeartbeat(): void
{
if ($this->heartbeat > 0 && ($this->last_read > 0 || $this->last_write > 0)) {
$lastActivity = $this->getLastActivity();
$now = microtime(true);
if (($now - $lastActivity) > $this->heartbeat * 2 + 1) {
$this->close();
throw new AMQPHeartbeatMissedException('Missed server heartbeat');
}
}
}
/**
* @return float|int
*/
public function getLastActivity()
{
return max($this->last_read, $this->last_write);
}
public function getReadTimeout(): float
{
return $this->read_timeout;
}
/**
* @return $this
*/
public function disableHeartbeat()
{
$this->initial_heartbeat = $this->heartbeat;
$this->heartbeat = 0;
return $this;
}
/**
* @return $this
*/
public function reenableHeartbeat()
{
$this->heartbeat = $this->initial_heartbeat;
return $this;
}
/**
* Sends a heartbeat message
*/
protected function write_heartbeat()
{
$pkt = new AMQPWriter();
$pkt->write_octet(8);
$pkt->write_short(0);
$pkt->write_long(0);
$pkt->write_octet(0xCE);
$this->write($pkt->getvalue());
}
/**
* Begin tracking errors and set the error handler
*/
protected function setErrorHandler(): void
{
$this->last_error = null;
set_error_handler(array($this, 'error_handler'));
}
protected function throwOnError(): void
{
if ($this->last_error instanceof \ErrorException) {
$error = $this->last_error;
$this->last_error = null;
throw $error;
}
}
protected function restoreErrorHandler(): void
{
restore_error_handler();
}
/**
* Internal error handler to deal with stream and socket errors.
*
* @param int $errno
* @param string $errstr
* @param string $errfile
* @param int $errline
* @return void
*/
public function error_handler($errno, $errstr, $errfile, $errline): void
{
// throwing an exception in an error handler will halt execution
// collect error continue
$this->last_error = new \ErrorException($errstr, $errno, 1, $errfile, $errline, $this->last_error);
}
protected function isPcntlSignalEnabled(): bool
{
return extension_loaded('pcntl')
&& function_exists('pcntl_signal_dispatch')
&& (defined('AMQP_WITHOUT_SIGNALS') ? !AMQP_WITHOUT_SIGNALS : true);
}
}
|