php-beanstalkd消息队列类实例分享


Posted in PHP onJuly 19, 2017

本文实例为大家分享了php beanstalkd消息队列类的具体代码,供大家参考,具体内容如下

<?php
namespace Common\Business;
/**
 * beanstalk: A minimalistic PHP beanstalk client.
 *
 * Copyright (c) 2009-2015 David Persson
 *
 * Distributed under the terms of the MIT License.
 * Redistributions of files must retain the above copyright notice.
 */
 
use RuntimeException;
 
/**
 * An interface to the beanstalk queue service. Implements the beanstalk
 * protocol spec 1.9. Where appropriate the documentation from the protocol
 * has been added to the docblocks in this class.
 *
 * @link https://github.com/kr/beanstalkd/blob/master/doc/protocol.txt
 */
class BeanStalk {
 
  /**
   * Minimum priority value which can be assigned to a job. The minimum
   * priority value is also the _highest priority_ a job can have.
   *
   * @var integer
   */
  const MIN_PRIORITY = 0;
 
  /**
   * Maximum priority value which can be assigned to a job. The maximum
   * priority value is also the _lowest priority_ a job can have.
   *
   * @var integer
   */
  const MAX_PRIORITY = 4294967295;
 
  /**
   * Holds a boolean indicating whether a connection to the server is
   * currently established or not.
   *
   * @var boolean
   */
  public $connected = false;
 
  /**
   * Holds configuration values.
   *
   * @var array
   */
  protected $_config = [];
 
  /**
   * The current connection resource handle (if any).
   *
   * @var resource
   */
  protected $_connection;
 
  /**
   * Constructor.
   *
   * @param array $config An array of configuration values:
   *    - `'persistent'` Whether to make the connection persistent or
   *             not, defaults to `true` as the FAQ recommends
   *             persistent connections.
   *    - `'host'`    The beanstalk server hostname or IP address to
   *             connect to, defaults to `127.0.0.1`.
   *    - `'port'`    The port of the server to connect to, defaults
   *             to `11300`.
   *    - `'timeout'`   Timeout in seconds when establishing the
   *             connection, defaults to `1`.
   *    - `'logger'`   An instance of a PSR-3 compatible logger.
   *
   * @link https://github.com/php-fig/fig-standards/blob/master/accepted/PSR-3-logger-interface.md
   * @return void
   */
  public function __construct(array $config = []) {
    $defaults = [
      'persistent' => true,
      'host' => '127.0.0.1',
      'port' => 11300,
      'timeout' => 1,
      'logger' => null
    ];
    $this->_config = $config + $defaults;
  }
 
  /**
   * Destructor, disconnects from the server.
   *
   * @return void
   */
  public function __destruct() {
    $this->disconnect();
  }
 
  /**
   * Initiates a socket connection to the beanstalk server. The resulting
   * stream will not have any timeout set on it. Which means it can wait
   * an unlimited amount of time until a packet becomes available. This
   * is required for doing blocking reads.
   *
   * @see \Beanstalk\Client::$_connection
   * @see \Beanstalk\Client::reserve()
   * @return boolean `true` if the connection was established, `false` otherwise.
   */
  public function connect() {
    if (isset($this->_connection)) {
      $this->disconnect();
    }
    $errNum = '';
    $errStr = '';
    $function = $this->_config['persistent'] ? 'pfsockopen' : 'fsockopen';
    $params = [$this->_config['host'], $this->_config['port'], &$errNum, &$errStr];
 
    if ($this->_config['timeout']) {
      $params[] = $this->_config['timeout'];
    }
    $this->_connection = @call_user_func_array($function, $params);
 
    if (!empty($errNum) || !empty($errStr)) {
      $this->_error("{$errNum}: {$errStr}");
    }
 
    $this->connected = is_resource($this->_connection);
 
    if ($this->connected) {
      stream_set_timeout($this->_connection, -1);
    }
    return $this->connected;
  }
 
  /**
   * Closes the connection to the beanstalk server by first signaling
   * that we want to quit then actually closing the socket connection.
   *
   * @return boolean `true` if diconnecting was successful.
   */
  public function disconnect() {
    if (!is_resource($this->_connection)) {
      $this->connected = false;
    } else {
      $this->_write('quit');
      $this->connected = !fclose($this->_connection);
 
      if (!$this->connected) {
        $this->_connection = null;
      }
    }
    return !$this->connected;
  }
 
  /**
   * Pushes an error message to the logger, when one is configured.
   *
   * @param string $message The error message.
   * @return void
   */
  protected function _error($message) {
    if ($this->_config['logger']) {
      $this->_config['logger']->error($message);
    }
  }
 
  public function errors()
  {
    return $this->_config['logger'];
  }
  /**
   * Writes a packet to the socket. Prior to writing to the socket will
   * check for availability of the connection.
   *
   * @param string $data
   * @return integer|boolean number of written bytes or `false` on error.
   */
  protected function _write($data) {
    if (!$this->connected) {
      $message = 'No connecting found while writing data to socket.';
      throw new RuntimeException($message);
    }
 
    $data .= "\r\n";
    return fwrite($this->_connection, $data, strlen($data));
  }
 
  /**
   * Reads a packet from the socket. Prior to reading from the socket
   * will check for availability of the connection.
   *
   * @param integer $length Number of bytes to read.
   * @return string|boolean Data or `false` on error.
   */
  protected function _read($length = null) {
    if (!$this->connected) {
      $message = 'No connection found while reading data from socket.';
      throw new RuntimeException($message);
    }
    if ($length) {
      if (feof($this->_connection)) {
        return false;
      }
      $data = stream_get_contents($this->_connection, $length + 2);
      $meta = stream_get_meta_data($this->_connection);
 
      if ($meta['timed_out']) {
        $message = 'Connection timed out while reading data from socket.';
        throw new RuntimeException($message);
      }
      $packet = rtrim($data, "\r\n");
    } else {
      $packet = stream_get_line($this->_connection, 16384, "\r\n");
    }
    return $packet;
  }
 
  /* Producer Commands */
 
  /**
   * The `put` command is for any process that wants to insert a job into the queue.
   *
   * @param integer $pri Jobs with smaller priority values will be scheduled
   *    before jobs with larger priorities. The most urgent priority is
   *    0; the least urgent priority is 4294967295.
   * @param integer $delay Seconds to wait before putting the job in the
   *    ready queue. The job will be in the "delayed" state during this time.
   * @param integer $ttr Time to run - Number of seconds to allow a worker to
   *    run this job. The minimum ttr is 1.
   * @param string $data The job body.
   * @return integer|boolean `false` on error otherwise an integer indicating
   *     the job id.
   */
  public function put($pri, $delay, $ttr, $data) {
    $this->_write(sprintf("put %d %d %d %d\r\n%s", $pri, $delay, $ttr, strlen($data), $data));
    $status = strtok($this->_read(), ' ');
 
    switch ($status) {
      case 'INSERTED':
      case 'BURIED':
        return (integer) strtok(' '); // job id
      case 'EXPECTED_CRLF':
      case 'JOB_TOO_BIG':
      default:
        $this->_error($status);
        return false;
    }
  }
 
  /**
   * The `use` command is for producers. Subsequent put commands will put
   * jobs into the tube specified by this command. If no use command has
   * been issued, jobs will be put into the tube named `default`.
   *
   * @param string $tube A name at most 200 bytes. It specifies the tube to
   *    use. If the tube does not exist, it will be created.
   * @return string|boolean `false` on error otherwise the name of the tube.
   */
  public function useTube($tube) {
    $this->_write(sprintf('use %s', $tube));
    $status = strtok($this->_read(), ' ');
 
    switch ($status) {
      case 'USING':
        return strtok(' ');
      default:
        $this->_error($status);
        return false;
    }
  }
 
  /**
   * Pause a tube delaying any new job in it being reserved for a given time.
   *
   * @param string $tube The name of the tube to pause.
   * @param integer $delay Number of seconds to wait before reserving any more
   *    jobs from the queue.
   * @return boolean `false` on error otherwise `true`.
   */
  public function pauseTube($tube, $delay) {
    $this->_write(sprintf('pause-tube %s %d', $tube, $delay));
    $status = strtok($this->_read(), ' ');
 
    switch ($status) {
      case 'PAUSED':
        return true;
      case 'NOT_FOUND':
      default:
        $this->_error($status);
        return false;
    }
  }
 
  /* Worker Commands */
 
  /**
   * Reserve a job (with a timeout).
   *
   * @param integer $timeout If given specifies number of seconds to wait for
   *    a job. `0` returns immediately.
   * @return array|false `false` on error otherwise an array holding job id
   *     and body.
   */
  public function reserve($timeout = null) {
    if (isset($timeout)) {
      $this->_write(sprintf('reserve-with-timeout %d', $timeout));
    } else {
      $this->_write('reserve');
    }
    $status = strtok($this->_read(), ' ');
 
    switch ($status) {
      case 'RESERVED':
        return [
          'id' => (integer) strtok(' '),
          'body' => $this->_read((integer) strtok(' '))
        ];
      case 'DEADLINE_SOON':
      case 'TIMED_OUT':
      default:
        $this->_error($status);
        return false;
    }
  }
 
  /**
   * Removes a job from the server entirely.
   *
   * @param integer $id The id of the job.
   * @return boolean `false` on error, `true` on success.
   */
  public function delete($id) {
    $this->_write(sprintf('delete %d', $id));
    $status = $this->_read();
 
    switch ($status) {
      case 'DELETED':
        return true;
      case 'NOT_FOUND':
      default:
        $this->_error($status);
        return false;
    }
  }
 
  /**
   * Puts a reserved job back into the ready queue.
   *
   * @param integer $id The id of the job.
   * @param integer $pri Priority to assign to the job.
   * @param integer $delay Number of seconds to wait before putting the job in the ready queue.
   * @return boolean `false` on error, `true` on success.
   */
  public function release($id, $pri, $delay) {
    $this->_write(sprintf('release %d %d %d', $id, $pri, $delay));
    $status = $this->_read();
 
    switch ($status) {
      case 'RELEASED':
      case 'BURIED':
        return true;
      case 'NOT_FOUND':
      default:
        $this->_error($status);
        return false;
    }
  }
 
  /**
   * Puts a job into the `buried` state Buried jobs are put into a FIFO
   * linked list and will not be touched until a client kicks them.
   *
   * @param integer $id The id of the job.
   * @param integer $pri *New* priority to assign to the job.
   * @return boolean `false` on error, `true` on success.
   */
  public function bury($id, $pri) {
    $this->_write(sprintf('bury %d %d', $id, $pri));
    $status = $this->_read();
 
    switch ($status) {
      case 'BURIED':
        return true;
      case 'NOT_FOUND':
      default:
        $this->_error($status);
        return false;
    }
  }
 
  /**
   * Allows a worker to request more time to work on a job.
   *
   * @param integer $id The id of the job.
   * @return boolean `false` on error, `true` on success.
   */
  public function touch($id) {
    $this->_write(sprintf('touch %d', $id));
    $status = $this->_read();
 
    switch ($status) {
      case 'TOUCHED':
        return true;
      case 'NOT_TOUCHED':
      default:
        $this->_error($status);
        return false;
    }
  }
 
  /**
   * Adds the named tube to the watch list for the current connection.
   *
   * @param string $tube Name of tube to watch.
   * @return integer|boolean `false` on error otherwise number of tubes in watch list.
   */
  public function watch($tube) {
    $this->_write(sprintf('watch %s', $tube));
    $status = strtok($this->_read(), ' ');
 
    switch ($status) {
      case 'WATCHING':
        return (integer) strtok(' ');
      default:
        $this->_error($status);
        return false;
    }
  }
 
  /**
   * Remove the named tube from the watch list.
   *
   * @param string $tube Name of tube to ignore.
   * @return integer|boolean `false` on error otherwise number of tubes in watch list.
   */
  public function ignore($tube) {
    $this->_write(sprintf('ignore %s', $tube));
    $status = strtok($this->_read(), ' ');
 
    switch ($status) {
      case 'WATCHING':
        return (integer) strtok(' ');
      case 'NOT_IGNORED':
      default:
        $this->_error($status);
        return false;
    }
  }
 
  /* Other Commands */
 
  /**
   * Inspect a job by its id.
   *
   * @param integer $id The id of the job.
   * @return string|boolean `false` on error otherwise the body of the job.
   */
  public function peek($id) {
    $this->_write(sprintf('peek %d', $id));
    return $this->_peekRead();
  }
 
  /**
   * Inspect the next ready job.
   *
   * @return string|boolean `false` on error otherwise the body of the job.
   */
  public function peekReady() {
    $this->_write('peek-ready');
    return $this->_peekRead();
  }
 
  /**
   * Inspect the job with the shortest delay left.
   *
   * @return string|boolean `false` on error otherwise the body of the job.
   */
  public function peekDelayed() {
    $this->_write('peek-delayed');
    return $this->_peekRead();
  }
 
  /**
   * Inspect the next job in the list of buried jobs.
   *
   * @return string|boolean `false` on error otherwise the body of the job.
   */
  public function peekBuried() {
    $this->_write('peek-buried');
    return $this->_peekRead();
  }
 
  /**
   * Handles response for all peek methods.
   *
   * @return string|boolean `false` on error otherwise the body of the job.
   */
  protected function _peekRead() {
    $status = strtok($this->_read(), ' ');
 
    switch ($status) {
      case 'FOUND':
        return [
          'id' => (integer) strtok(' '),
          'body' => $this->_read((integer) strtok(' '))
        ];
      case 'NOT_FOUND':
      default:
        $this->_error($status);
        return false;
    }
  }
 
  /**
   * Moves jobs into the ready queue (applies to the current tube).
   *
   * If there are buried jobs those get kicked only otherwise delayed
   * jobs get kicked.
   *
   * @param integer $bound Upper bound on the number of jobs to kick.
   * @return integer|boolean False on error otherwise number of jobs kicked.
   */
  public function kick($bound) {
    $this->_write(sprintf('kick %d', $bound));
    $status = strtok($this->_read(), ' ');
 
    switch ($status) {
      case 'KICKED':
        return (integer) strtok(' ');
      default:
        $this->_error($status);
        return false;
    }
  }
 
  /**
   * This is a variant of the kick command that operates with a single
   * job identified by its job id. If the given job id exists and is in a
   * buried or delayed state, it will be moved to the ready queue of the
   * the same tube where it currently belongs.
   *
   * @param integer $id The job id.
   * @return boolean `false` on error `true` otherwise.
   */
  public function kickJob($id) {
    $this->_write(sprintf('kick-job %d', $id));
    $status = strtok($this->_read(), ' ');
 
    switch ($status) {
      case 'KICKED':
        return true;
      case 'NOT_FOUND':
      default:
        $this->_error($status);
        return false;
    }
  }
 
  /* Stats Commands */
 
  /**
   * Gives statistical information about the specified job if it exists.
   *
   * @param integer $id The job id.
   * @return string|boolean `false` on error otherwise a string with a yaml formatted dictionary.
   */
  public function statsJob($id) {
    $this->_write(sprintf('stats-job %d', $id));
    return $this->_statsRead();
  }
 
  /**
   * Gives statistical information about the specified tube if it exists.
   *
   * @param string $tube Name of the tube.
   * @return string|boolean `false` on error otherwise a string with a yaml formatted dictionary.
   */
  public function statsTube($tube) {
    $this->_write(sprintf('stats-tube %s', $tube));
    return $this->_statsRead();
  }
 
  /**
   * Gives statistical information about the system as a whole.
   *
   * @return string|boolean `false` on error otherwise a string with a yaml formatted dictionary.
   */
  public function stats() {
    $this->_write('stats');
    return $this->_statsRead();
  }
 
  /**
   * Returns a list of all existing tubes.
   *
   * @return string|boolean `false` on error otherwise a string with a yaml formatted list.
   */
  public function listTubes() {
    $this->_write('list-tubes');
    return $this->_statsRead();
  }
 
  /**
   * Returns the tube currently being used by the producer.
   *
   * @return string|boolean `false` on error otherwise a string with the name of the tube.
   */
  public function listTubeUsed() {
    $this->_write('list-tube-used');
    $status = strtok($this->_read(), ' ');
 
    switch ($status) {
      case 'USING':
        return strtok(' ');
      default:
        $this->_error($status);
        return false;
    }
  }
 
  /**
   * Returns a list of tubes currently being watched by the worker.
   *
   * @return string|boolean `false` on error otherwise a string with a yaml formatted list.
   */
  public function listTubesWatched() {
    $this->_write('list-tubes-watched');
    return $this->_statsRead();
  }
 
  /**
   * Handles responses for all stat methods.
   *
   * @param boolean $decode Whether to decode data before returning it or not. Default is `true`.
   * @return array|string|boolean `false` on error otherwise statistical data.
   */
  protected function _statsRead($decode = true) {
    $status = strtok($this->_read(), ' ');
 
    switch ($status) {
      case 'OK':
        $data = $this->_read((integer) strtok(' '));
        return $decode ? $this->_decode($data) : $data;
      default:
        $this->_error($status);
        return false;
    }
  }
 
  /**
   * Decodes YAML data. This is a super naive decoder which just works on
   * a subset of YAML which is commonly returned by beanstalk.
   *
   * @param string $data The data in YAML format, can be either a list or a dictionary.
   * @return array An (associative) array of the converted data.
   */
  protected function _decode($data) {
    $data = array_slice(explode("\n", $data), 1);
    $result = [];
 
    foreach ($data as $key => $value) {
      if ($value[0] === '-') {
        $value = ltrim($value, '- ');
      } elseif (strpos($value, ':') !== false) {
        list($key, $value) = explode(':', $value);
        $value = ltrim($value, ' ');
      }
      if (is_numeric($value)) {
        $value = (integer) $value == $value ? (integer) $value : (float) $value;
      }
      $result[$key] = $value;
    }
    return $result;
  }
}
 
?>

以上就是本文的全部内容,希望对大家的学习有所帮助,也希望大家多多支持三水点靠木。

PHP 相关文章推荐
用Apache反向代理设置对外的WWW和文件服务器
Oct 09 PHP
php 调用远程url的六种方法小结
Nov 02 PHP
解析用PHP读写音频文件信息的详解(支持WMA和MP3)
May 10 PHP
PHP 安全检测代码片段(分享)
Jul 05 PHP
PHP获取服务器端信息的方法
Nov 28 PHP
php准确获取文件MIME类型的方法
Jun 17 PHP
Eclipse PHPEclipse 配置的具体步骤
Aug 08 PHP
thinkphp5引入公共部分header、footer的方法详解
Sep 14 PHP
PHP读取目录树的实现方法分析
Mar 22 PHP
PHP保留两位小数的几种方法
Jul 24 PHP
解决Laravel 不能创建 migration 的问题
Oct 09 PHP
php的单例模式及应用场景详解
Feb 27 PHP
php+ajax实现异步上传文件或图片功能
Jul 18 #PHP
Joomla框架实现字符串截取的方法示例
Jul 18 #PHP
PHP新特性详解之命名空间、性状与生成器
Jul 18 #PHP
PHP实现基于面向对象的mysqli扩展库增删改查操作工具类
Jul 18 #PHP
PHP基于XMLWriter操作xml的方法分析
Jul 17 #PHP
PHP基于DOMDocument解析和生成xml的方法分析
Jul 17 #PHP
PHP基于SimpleXML生成和解析xml的方法示例
Jul 17 #PHP
You might like
php 中include()与require()的对比
2006/10/09 PHP
ecshop适应在PHP7的修改方法解决报错的实现
2016/11/01 PHP
javascript+dom树型菜单类,希望朋友们一起进步
2007/05/03 Javascript
JavaScript 设计模式 安全沙箱模式
2010/09/24 Javascript
Javascript跨域请求的4种解决方式
2013/03/17 Javascript
jquery form表单序列化为对象的示例代码
2014/03/05 Javascript
JavaScript关闭当前页面(窗口)不带任何提示
2014/03/26 Javascript
Javascript正则控制文本框只能输入整数或浮点数
2014/09/02 Javascript
jQuery实现带滚动导航效果的全屏滚动相册实例
2015/06/19 Javascript
jquery实现表格隔行换色效果
2015/11/19 Javascript
JS获取鼠标坐标位置实例分析
2016/01/20 Javascript
javascript事件处理模型实例说明
2016/05/31 Javascript
JavaScript中undefined和null的区别
2017/05/03 Javascript
vue2.0与bootstrap3实现列表分页效果
2017/11/28 Javascript
Vue 组件传值几种常用方法【总结】
2018/05/28 Javascript
微信小程序如何修改radio和checkbox的默认样式和图标
2019/07/24 Javascript
JavaScript 监听组合按键思路及代码实现
2020/07/28 Javascript
Python爬虫获取整个站点中的所有外部链接代码示例
2017/12/26 Python
Python实现PS滤镜中马赛克效果示例
2018/01/20 Python
网红编程语言Python将纳入高考你怎么看?
2018/06/07 Python
python实现微信小程序用户登录、模板推送
2019/08/28 Python
python对文件的操作方法汇总
2020/02/28 Python
PyTorch加载自己的数据集实例详解
2020/03/18 Python
Python selenium爬取微信公众号文章代码详解
2020/08/12 Python
html5版canvas自由拼图实例
2014/10/15 HTML / CSS
世界领先的高品质定制产品平台:Zazzle
2017/07/23 全球购物
单位领导证婚词
2014/01/14 职场文书
活动总结报告范文
2014/05/04 职场文书
作风转变心得体会
2014/09/02 职场文书
个人借条范本
2015/05/25 职场文书
三傻大闹宝莱坞观后感
2015/06/03 职场文书
幼儿园中班教学反思
2016/03/03 职场文书
Python生成九宫格图片的示例代码
2021/04/14 Python
Nginx如何配置Http、Https、WS、WSS的方法步骤
2021/05/11 Servers
浅析python中特殊文件和特殊函数
2022/02/24 Python
GO语言字符串处理函数之处理Strings包
2022/04/14 Golang