本文详细介绍了Beanstalkd队列服务的工作原理与核心功能，包括job的生命周期、生产者与消费者之间的交互过程，以及如何使用各种命令来管理任务。
参考：https://github.com/kr/beanstalkd/blob/master/doc/protocol.txt
专业术语：beanstalk beanstalkd producer consumer tube job
reserve 获取
release 释放
bury 休眠
touch 触碰
peek 窥视
kick 踢
所有的请求和响应都以下面的格式标记： request respons
[▧,*.▧]﹍﹍﹍﹍﹍﹍﹍﹍﹍﹍﹍﹍﹍﹍﹍华丽的分割线（下面基本都是直接翻译的。。）﹍﹍﹍﹍﹍﹍﹍﹍﹍﹍﹍﹍[▧,*.▧]
协议说明
Beanstalk 协议使用 ASCII 编码，运行在 TCP 协议之上。客户端负责主动建立 连接，发送命令和数据，等待响应以及关闭连接。对于每个连接，服务端以接收 请求的顺序串行地处理命令，并按相同的顺序发送响应。协议中所有的数字都是 十进制并且非负的（除非有明确说明）。协议中的名字都是 ASCII 字符串。名字可以包含字母（A-Z 和 a-z）、 数字（ 0-9）、 连字符（"-"）、 加（"+"）、 斜线（"/"）、 分号（";"）、 点（"."）、 美元符号（"$"）、 下划线（"_"）和括号（“(”和")"），但是不能以连字符开头。名字以空格或换行 结束。每个名字至少要有一个字符的长度。
协议中包含两类数据：文本行和非结构化的块数据。文本行用来传输客户端 的命令和服务端的响应。块数据用来传输 job 体和统计信息。每个 job 体是一个 不透明的字节序列。服务端从不检查或修改 job 体，直接按其原有的格式返回。 job 体的解释是有客户端来进行的。
当不再需要使用服务端时，客户端可以选择发送 ”quit” 命令或直接关闭 TCP 连接。然而，beanstalkd 可以很好处理和维护大量打开的连接，所以，客户端应 该尽可能包括连接的打开和重用。这同样也可以省去建立 TCP 连接的开销。 如果客户端违背了协议（比如发送错误格式的请求或者不存在的命令）或者 服务端出错，服务端将返回下面信息的一种：
“OUT_OF_MEMORY\r\n” 表示服务端不能为 job 分配足够的内存。客户 端应该稍后重试。
“INTERNAL_ERROR\r\n” 表示服务端的 bug。这种情况不应该发生。如果 发生了，可以报给 http://groups.google.com/group/beanstalk-talk。
"BAD_FORMAT\r\n" 表示客户端发送了一个错误格式的命令行。可能呢 导致这种错误发生的情况有：行没有以\r\n 结尾、在需要整数的地方出 现了非数字字符、参数的数目错误、或者其他格式的命令行错误。
"UNKNOWN_COMMAND\r\n" 表示客户端发送了一个服务端不认识的 命令。
这些错误响应不会在本文以下各节的命令列出，但都隐含在所有命令的说明里。客户端在发送命令之后都要准备好接收错误响 应。
最后，如果服务端发生了严重的错误不能继续服务，服务端将会主动关闭连接。
job 生命周期
Beanstalk 中的 job 由客户端发送的 ”put” 命令创建。在整个的生命周期中， 一个 job 可以经历 “ready”, “reserved”, “delayed” 和 ”buried” 四种状态。”put”命 令之后，一个 job 通常处于 “ready” 状态。它将在 ready 队列等待 worker 执行 “reserve” 命令。如果这个 job 是 ready 队列的下一个，它将由 worker 来处理。 这个 worker 将执行这个 job，当 worker 完成了该 job，可以发送 “delete” 命令 来删除 job。 下图是一个简单的 job 生命周期：
下面的图片说明了更复杂的情况：
[▧,*.▧]﹍﹍﹍﹍﹍﹍﹍﹍﹍﹍﹍﹍﹍﹍﹍华丽的分割线（上面这个图找不到中文的）﹍﹍﹍﹍﹍﹍﹍﹍﹍﹍﹍﹍[▧,*.▧]
系统可以有一个或多个 tube。每个 tube 包含一个 ready 队列和一个 delay 队 列。一个 job 的生命周期只能在一个 tube 中。Consumer 可以发送 “watch” 命令 来关注一个 tube，也可以发送 “ignore”命令来忽略一个 tube。被关注的 tube 将 会出现在consumer的 “watch list”里面。客户端获取的job可能来自其 “watch list” 中任意一个 tube。
当客户端刚建立连接，其 “watch list” 中只有初始设置的 “default” tube。如 果客户端提交 job 前没有发送 “use”命令，job 将被存储在 “default” tube 中。
Tube 是在被引用到时按需创建的。如果一个 tube 空了（也就是说不包含任 何 ready, delayed 或者 buried job）并且没有客户端引用，该 tube 将被删除。
[▧,*.▧]﹍﹍﹍﹍﹍﹍﹍﹍﹍﹍﹍﹍﹍﹍﹍华丽的分割线（下面才是重点。。敲敲黑板）﹍﹍﹍﹍﹍﹍﹍﹍﹍﹍﹍﹍[▧,*.▧]
Producer 命令
“put” 命令用来向队列中插入一个 job，包括一个命令行和一个 job 体：
23, // 优先级
1, // 延迟执行
5, // 执行超时
"测试");
use
“use” 命令是为producer设计的。put命令会将job放入由该命令指定的tube 中。如果没有执行 use 命令，job 将会被放入”default” tube。Worker 命令
一个进程可以通过”reserve”, “delete”, “release”和”bury”命令来从队列里面消 耗 job。
DEADLINE_SOON\r\n
<data> 表示消息体，一个长度为 <bytes> 的字节序列。这是对之前 put 命令 job 体原始字节的逐字拷贝。
delete 命令从服务端完全删除一个 job。当客户端已经成功执行完一个 job 时，该 job 一般会被使用。客户端可以删除一个已经被获取的 job，可用的 job， 以及被休眠的 job。delete 命令如下：
release 命令将一个已经被获取的 job 重新放回 ready 队列（并将 job 状态置 为 “ready”），让该 job 可以被其他客户端执行。这个命令经常在 job 因为短暂的 错误而失败时使用。格式如下：
"NOT_FOUND\r\n" 表示该 job 不存在或没有被客户端获取。
bury
touch
touch 命令允许一个 worker 请求在一个 job 获取更多执行的时间。这对于那 些需要长时间完成的job是非常有用的，但同时也可能利用TTR的优势将一个job 从一个无法完成工作的 worker 处移走。一个 worker 可以通过该命令来告诉服务 端它还在执行该 job（比如：在收到 DEADLINE_SOON 是可以发生给命令）。
touch 命令格式如下：
touch <id>\r\n
<id> 表示当前连接获取 job 的 id
有两种可能的响应：
" TOUCHED\r\n" 表示成功
"NOT_FOUND\r\n" 表示该 job 不存在或没有被客户端获取。
watch
watch 命令将一个 tube 名称加入当前连接的 watch list。reserve 命令将从 watch list 里面的任意一个 tube 中获取 job。对于每个新建的连接，watch list 中 只有一个”default” tube。
watch <tube>\r\n
<tube> 是一个不超过 200 字节的名称。它指定将一个 tube 加入到 watch list。如果该 tube 不存在，将会被 及时创建。
响应是：
WATCHING <count>\r\n
<count> 表示当前 watch list 中的 tube 数目。
ignore
ignore 命令是为 consumer 设计的。ignore 命令将一个 tube 从当前连接的 watch list 中移除。
ignore <tube>\r\n
响应如下：
"WATCHING <count>\r\n" 表示成功。<count>表示当前 watch list 中的 tube 数目。
"NOT_IGNORED\r\n" 表示客户端正在试图 ignore watch list 中的最后一 个 tube。
其他命令
peekpeek 命令可以让客户端检查系统中的 job。这个命令有 4 个变种。除第一个 命令之外，其他 3 个命令都只能作用在当前使用的 tube 上面。
"peek <id>\r\n" 返回编号为<id>的 job。
"peek-ready\r\n" 返回当前 tube 下一个 ready 的 job。
"peek-delayed\r\n" 返回当前 tube 剩余 delay 时间最短的 job。
"peek-buried\r\n" 返回当前 tube buried list 中下一个 job。
有两种可能的响应，其中一个是单行：
"NOT_FOUND\r\n" 表示请求的 job 不存在，或者没有 job 在当前请求的状态 队列中。
还有一个是一行跟一个块数据，表示命令执行成功：
FOUND <id> <bytes>\r\n <data>\r\n
<id> 表示 job 的 id。
<bytes> 表示 job 体大小的整数，不包括结尾的 ”\r\n”。
<data> 表示消息体，一个长度为 <bytes> 的字节序列。
kick
kick 命令只能针对当前正在使用的 tube 执行。它将 buried 或者 delayed 状态 的 job 移动到 ready 队列。命令格式如下：
kick <bound>\r\n
<bound> 表示每次 kick job 的上限，服务端将最多 kick <bound>个 job。
响应格式如下：
KICKED <count>\r\n
<count> 表示本次 kick 操作作用 job 的数目。
list-tubes
list-tubes 命令返回已经存在的所有 tube 的列表。格式如下：
list-tubes\r\n
响应如下：
OK <bytes>\r\n <data>\r\n
<bytes> 是<data>的字节大小。
<data>是一个长度为<bytes> 的字节序列。它是一个包含所有 tube 名称 的 YAML 文件。
list-tube-used
list-tube-used 命令返回客户当前正在使用的 tube。
格式如下：
list-tube-used\r\n
响应如下：
USING <tube>\r\n
<tube> 是正在使用的 tube 名称。
list-tubes-watched
list-tubes-watched命令返回客户端当前正在关注的tube名称列表。
格式如下：
list-tubes-watched\r\n
响应如下： OK <bytes>\r\n <data>\r\n
<bytes> 是<data>的字节大小。
<data>是一个长度为<bytes> 的字节序列。它是一个包含被关注 tube 名 称的 YAML 文件。
pause-tube
pause-tube 命令用来在给定时间内暂停从 tube 获取 job。
格式如下：
pause-tube <tube-name> <delay>\r\n
<tube> 表示要暂停的 tube。
<delay> 表示在可以从 tube 获取 job 之前需要等待的秒数。
有两种可能的响应：
"PAUSED\r\n" 表示成功。
"NOT_FOUND\r\n" 表示该 tube 不存在。
quit
quit 命令用来关闭当前连接。
格式如下：
quit\r\n
扫一扫
66
被折叠的 条评论
为什么被折叠?
到【灌水乐园】发言
