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 267 268 269 270 271 272 273 274 275 276 277 278 279 280
|
<?php
/**
* Zend Framework
*
* LICENSE
*
* This source file is subject to the new BSD license that is bundled
* with this package in the file LICENSE.txt.
* It is also available through the world-wide-web at this URL:
* http://framework.zend.com/license/new-bsd
* If you did not receive a copy of the license and are unable to
* obtain it through the world-wide-web, please send an email
* to license@zend.com so we can send you a copy immediately.
*
* @category Zend
* @package Zend_Queue
* @subpackage Stomp
* @copyright Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
* @license http://framework.zend.com/license/new-bsd New BSD License
* @version $Id: Connection.php 20096 2010-01-06 02:05:09Z bkarwin $
*/
/**
* @see Zend_Queue_Stomp_Client_ConnectionInterface
*/
require_once 'Zend/Queue/Stomp/Client/ConnectionInterface.php';
/**
* The Stomp client interacts with a Stomp server.
*
* @category Zend
* @package Zend_Queue
* @subpackage Stomp
* @copyright Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
* @license http://framework.zend.com/license/new-bsd New BSD License
*/
class Zend_Queue_Stomp_Client_Connection
implements Zend_Queue_Stomp_Client_ConnectionInterface
{
const READ_TIMEOUT_DEFAULT_USEC = 0; // 0 microseconds
const READ_TIMEOUT_DEFAULT_SEC = 5; // 5 seconds
/**
* Connection options
* @var array
*/
protected $_options;
/**
* tcp/udp socket
*
* @var resource
*/
protected $_socket = false;
/**
* open() opens a socket to the Stomp server
*
* @param array $options ('scheme', 'host', 'port')
* @param string $scheme
* @param string $host
* @param int $port
* @param array $options Accepts "timeout_sec" and "timeout_usec" keys
* @return true;
* @throws Zend_Queue_Exception
*/
public function open($scheme, $host, $port, array $options = array())
{
$str = $scheme . '://' . $host;
$this->_socket = fsockopen($str, $port, $errno, $errstr);
if ($this->_socket === false) {
// aparently there is some reason that fsockopen will return false
// but it normally throws an error.
require_once 'Zend/Queue/Exception.php';
throw new Zend_Queue_Exception("Unable to connect to $str; error = $errstr ( errno = $errno )");
}
stream_set_blocking($this->_socket, 0); // non blocking
if (!isset($options['timeout_sec'])) {
$options['timeout_sec'] = self::READ_TIMEOUT_DEFAULT_SEC;
}
if (! isset($options['timeout_usec'])) {
$options['timeout_usec'] = self::READ_TIMEOUT_DEFAULT_USEC;
}
$this->_options = $options;
return true;
}
/**
* Close the socket explicitly when destructed
*
* @return void
*/
public function __destruct()
{
}
/**
* Close connection
*
* @param boolean $destructor
* @return void
*/
public function close($destructor = false)
{
// Gracefully disconnect
if (!$destructor) {
$frame = $this->createFrame();
$frame->setCommand('DISCONNECT');
$this->write($frame);
}
// @todo: Should be fixed.
// When the socket is "closed", it will trigger the below error when php exits
// Fatal error: Exception thrown without a stack frame in Unknown on line 0
// Danlo: I suspect this is because this has already been claimed by the interpeter
// thus trying to shutdown this resources, which is already shutdown is a problem.
if (is_resource($this->_socket)) {
// fclose($this->_socket);
}
// $this->_socket = null;
}
/**
* Check whether we are connected to the server
*
* @return true
* @throws Zend_Queue_Exception
*/
public function ping()
{
if (!is_resource($this->_socket)) {
require_once 'Zend/Queue/Exception.php';
throw new Zend_Queue_Exception('Not connected to Stomp server');
}
return true;
}
/**
* Write a frame to the stomp server
*
* example: $response = $client->write($frame)->read();
*
* @param Zend_Queue_Stom_FrameInterface $frame
* @return $this
*/
public function write(Zend_Queue_Stomp_FrameInterface $frame)
{
$this->ping();
$output = $frame->toFrame();
$bytes = fwrite($this->_socket, $output, strlen($output));
if ($bytes === false || $bytes == 0) {
require_once 'Zend/Queue/Exception.php';
throw new Zend_Queue_Exception('No bytes written');
}
return $this;
}
/**
* Tests the socket to see if there is data for us
*
* @return boolean
*/
public function canRead()
{
$read = array($this->_socket);
$write = null;
$except = null;
return stream_select(
$read,
$write,
$except,
$this->_options['timeout_sec'],
$this->_options['timeout_usec']
) == 1;
// see http://us.php.net/manual/en/function.stream-select.php
}
/**
* Reads in a frame from the socket or returns false.
*
* @return Zend_Queue_Stomp_FrameInterface|false
* @throws Zend_Queue_Exception
*/
public function read()
{
$this->ping();
$response = '';
$prev = '';
// while not end of file.
while (!feof($this->_socket)) {
// read in one character until "\0\n" is found
$data = fread($this->_socket, 1);
// check to make sure that the connection is not lost.
if ($data === false) {
require_once 'Zend/Queue/Exception.php';
throw new Zend_Queue_Exception('Connection lost');
}
// append last character read to $response
$response .= $data;
// is this \0 (prev) \n (data)? END_OF_FRAME
if (ord($data) == 10 && ord($prev) == 0) {
break;
}
$prev = $data;
}
if ($response === '') {
return false;
}
$frame = $this->createFrame();
$frame->fromFrame($response);
return $frame;
}
/**
* Set the frameClass to be used
*
* This must be a Zend_Queue_Stomp_FrameInterface.
*
* @param string $classname - class is an instance of Zend_Queue_Stomp_FrameInterface
* @return $this;
*/
public function setFrameClass($classname)
{
$this->_options['frameClass'] = $classname;
return $this;
}
/**
* Get the frameClass
*
* @return string
*/
public function getFrameClass()
{
return isset($this->_options['frameClass'])
? $this->_options['frameClass']
: 'Zend_Queue_Stomp_Frame';
}
/**
* Create an empty frame
*
* @return Zend_Queue_Stomp_FrameInterface
*/
public function createFrame()
{
$class = $this->getFrameClass();
if (!class_exists($class)) {
require_once 'Zend/Loader.php';
Zend_Loader::loadClass($class);
}
$frame = new $class();
if (!$frame instanceof Zend_Queue_Stomp_FrameInterface) {
require_once 'Zend/Queue/Exception.php';
throw new Zend_Queue_Exception('Invalid Frame class provided; must implement Zend_Queue_Stomp_FrameInterface');
}
return $frame;
}
}
|