Memcached通讯协议

英文水平很烂，作梦都想着能把英语学习，可使用一口流利的英文和洋鬼子交流，顺便忽悠下本身的同胞。没有地方学习英语，看还能够，网上有不少关于计算机的英文文献，写还行，说就彻底不可能了。在之后的工做中慢慢的锻炼本身的英语水平吧，先翻译一下一些计算机的英文文献，锻炼下^_^，能读则读不能读则付之一笑。

协议
关键字 Keys
命令Commands
超时时间 Expiration times
错误信息 Error strings
存储命令 Storage commands
读取命令 Retrieval command
删除 Deletion
增长/减小 Increment/Decrement
统计 Statistics
多用途统计 General-purpose statistics
其余命令 Other commands
UDP协议 UDP protocol

协议

       memcached的客户端经过TCP链接与服务器通讯（UDP协议的接口也可使用，详细说明请参考”UDP 协议”部分）。一个给定的运行中的memcached服务器在某个（可配置的）端口上监听链接；客户端链接该端口，发送命令给服务器，读取反馈，最后关闭链接。

没有必要发送一个专门的命令去结束会话。客户端能够在不须要该链接的时候就关闭它。注意：咱们鼓励客户端缓存它们与服务器的链接，而不是每次要存储或读取数据的时候再次从新创建与服务器的链接。memcache同时打开不少链接不会对性能形成到大的影响，这是由于memcache在设计之处，就被设计成即便打开了不少链接（数百或者须要时上千个链接）也能够高效的运行。缓存链接能够节省与服务器创建TCP链接的时间开销（于此相比，在服务器段为创建一个新的链接所作准备的开销能够忽略不计）。

       memcache通讯协议有两种类型的数据：文本行和非结构化数据。文本行用来发送从客户端到服务器的命令以及从服务器回送的反馈信息。非结构化的数据用在客户端但愿存储或者读取数据时。服务器会以字符流的形式严格准确的返回相应数据在存储时存储的数据。服务器不关注字节序，它也不知道字节序的存在。memcahce对非结构化数据中的字符没有任何限制，能够是任意的字符，读取数据时，客户端能够在前次返回的文本行中确切的知道接下来的数据块的长度。

文本行一般以“"r"n”结束。非结构化数据一般也是以“"r"n”结束，尽管"r、"n或者其余任何8位字符能够出如今数据块中。因此当客户端从服务器读取数据时，必须使用前面提供的数据块的长度，来肯定数据流的结束，二不是依据跟随在字符流尾部的“"r"n”来肯定数据流的结束，尽管实际上数据流格式如此。

关键字 Keys

memcached使用关键字来区分存储不一样的数据。关键字是一个字符串，能够惟一标识一条数据。当前关键字的长度限制是250个字符（固然目前客户端彷佛没有需求用这么长的关键字）；关键字必定不能包含控制字符和空格。

命令Commands

memcahe有3种类型的命令：

l 存储命令—（3个命令：set、add和replace）要求服务器安装关键字存储数据。客户端发送一个命令行，而后一个数据块；命令执行后客户端等待一行反馈，用来表示命令执行成功与否。

l 读取命令-- （只有1个命令：get）要求服务器根据一组关键字读取数据（在一个请求总能够包含一个或多个关键字）。客户端发送一个包含请求关键字的命令行；命令传递到服务器后，服务器就查找每个关键字下的数据，然户将数据以“一个关键字数据，一个反馈信息行跟着一个数据块”的格式回送数据，直到服务器发送“END”的反馈行。

l 其余命令，如flush_all，version等。这些命令不使用非结构化的数据。对于这些命令，客户端发送一个文本的命令行，根据命令的特性等待一行数据或者在最后一行以“END“结尾的几行反馈信息。

全部的命令行老是以命令的名字开始，紧接着是以空格分割的参数。命令名称都是小写，而且是大小写敏感的。

超时时间 Expiration times

一些发送到服务器的命令包含超时时间（该超时时间对应于：数据项保存时间；客户端操做限时）。在这些例子中，被发送的真实时间要么是UNIX时间戳（自1970年1月1日零时起的秒数数值），或者从当前时间开始算起的秒数。对于后一种状况，秒数的数值不能超过60*60*24*30（30天的秒数）；若是秒数的数值大于了这个数值，服务器会认为该数值是UNIX时间戳，而不是自当前时间开始的秒数偏移值。

错误信息 Error strings

每一个命令都有可能被反馈以一个错误消息。这些错误消息有如下三个类型：

l “ERROR"r"n”

意味着客户端发送了一个在协议中不存在的命令。

l "CLIENT_ERROR <error>"r"n"

表示客户端输入的命令行上存在某种错误，输入不符合协议规定。<error>是一我的工可读（human-readable）的错误注释。

l "SERVER_ERROR <error>"r"n"

表示服务器在执行命令时发生了某些错误，导致服务器没法执行下去。<error>也是一我的工可读（human-readable）的错误注释。在一些状况下，错误致使服务器不能再为客户端服务（这样的状况不多发生），服务器就会在发生错误消息后主动关闭链接。这也是服务器主动关闭到客户端链接的惟一状况。

后续秒数各类命令的时候，咱们再也不赘述错误消息的状况，当咱们要清楚错误是存在的，不可忽略。

存储命令 Storage commands

首先，客户端发生以下这样的命令：

<command name> <key> <flags> <exptime> <bytes>"r"n

<data block>"r"n

其中：

<command name> 是 set、add或者replace。set表示存储该数据；add表示若是服务器没有保存该关键字的状况下，存储该数据；replace表示在服务器已经拥有该关键字的状况下，替换原有内容。

<key>是客户端要求服务器存储数据的关键字。

<flags>是一个16位的无符号整数，服务器将它和数据一块儿存储而且当该数据被检索时一块儿返回。客户端可能使用该数值做为一个位图来存储特殊数据信息；这个字段对服务器不是透明的。

<exptime>是超时时间。若是值为0表示该数据项永远不超时（但有时候该数据项可能被删除觉得其余数据腾出空间）；若是值不为0，多是绝对的UNIX时间，也多是自如今开始的偏移值，它保证客户段在这个超时时间到达后，客户端将取不到该数据项。

<bytes>是随后数据的字节数，不包括终结符”"r"n”。<bytes>有多是0，它后面将是一个空的数据块。

<data block>是真正要存储数据流。

发送命令行和数据后，客户端等待反馈，能够是以下几种状况：

l "STORED"r"n"              表示存储数据成功。

l "NOT_STORED"r"n"    表示发送的数据没有存储，但这不由于错误，而是发生在add或者replace命令不能知足条件时，或者数据项正处于要删除的队列中。

l 错误消息

读取命令 Retrieval command:

读取命令以下所示：

get <key>*"r"n

<key>*表示一个或多个使用空格分割的关键字字符串。

发送命令后，客户端等待返回一个或多个数据项，每一个数据项的格式是一个文本行，后跟着一个数据块。当全部的数据项发送完毕后，服务器发送字符串”END"r"n”表示服务器反馈数据的结束。

返回数据项的格式以下：

VALUE <key> <flags> <bytes>"r"n

<data block>"r"n

<key>是发生数据项的关键字。

       <flags>是存储该数据项时，客户端命令中的标志字段。

       <bytes>是紧跟文本行后数据块的长度，不包括终结符”"r"n”。

<data block>是数据项的数据部分。

若是请求命令行中的有些关键字对应的数据项没有被返回，这意味着服务器没有该关键字标示下的数据项（有多是历来没有被存储过，或者存储过但被删除掉以腾出内存空间，或者数据项超时了，再或者它被某个客户端删除了）。

删除 Deletion

删除命令容许直接删除数据项，命令格式以下：

delete <key> <time>"r"n

<key>是客户端但愿服务器删除数据项的关键字

<time>是客户端但愿服务器阻止add和replace命令使用该关键字数据项的秒数，能够是相对时间也能够是UNIX的绝对时间。在这段时间内，数据项被放入一个删除队列，它不能被get命令读取，在其上使用add和replace也会失败，但使用set命令能够成功。当这个时间过去后，数据项从服务器的内存中真正的删除。该参数是可选参数，若是不存在默认为0，这意味着当即从服务器上删除。

服务器返回信息：

l "DELETED"r"n"          表示数据项删除成功

l "NOT_FOUND"r"n"      表示该关键字指定的数据项在服务器上没有找到

l 其余错误消息

下面的flush_all命令使得全部存在的数据项当即失效。

增长/减小 Increment/Decrement

       “incr”和”decr”命令用来修改以及存在的数据项的内容，增长或者减小它。该数据被看成32位无符号整数处理。若是当前数据非此类数据，则经将该内容看成0来处理。另外在其上施加incr/decr命令的数据项必须是业已存在的；对于不存在的数据项不会将它做为0对待，而是以错误结束。

客户端发送命令行以下格式：

incr <key> <value>"r"n

或者

decr <key> <value>"r"n

<key>是客户端要修改数据项的关键字

<value>是对该数据行进行增长或者减小的操做数。它是一个32位的无符号整数。

反馈信息有以下几种：

l "NOT_FOUND"r"n"

代表在服务器上没有找到该数据项。

l "<value>"r"n "

value是执行完增长/减小命令后，该数据项新的数值。

l 错误信息。

注意到“decr”命令的下溢问题，若是客户端尝试减小的数量小于0，其结果是0。“incr”命令的溢出问题没有检查。另外减小一个数据而使它减小了长度，但不保证减小它返回时的长度。该数字多是附加空格的数字，但这只是实现的优化，因此你不能相信它。

统计 Statistics

“stats”命令用来查询服务器的运行状况和其余内部数据。它有两种状况，以有无参数来区分：

stats"r"n

或者

stats <args>"r"n

第一种状况它致使服务器输出通常统计信息以及设置信息和文档化内容。

第二种状况根据<args>具体的参数，服务器发送各类内部数据。这部分没有在协议中文档化，由于与memcache的开发者有关其多是随时变化的。

多用途统计 General-purpose statistics

当接收到没有带参数的“stats”命令后，服务器发送许多相似与以下格式的文本行：

STAT <name> <value>"r"n

当相似的文本行所有发送完毕后，服务器发送以下的文本行结束反馈信息：

END"r"n

在全部STAT文本行中，<name>是该统计项目的名称，<value>是其数据。下面是一份stats命令反馈的全部统计项目的列表，后面跟着其值的数据类型。在数据类型列中，”32u”表示一个32位无符号整数，”64u”表示一个64位无符号整数，”32u:32u”表示是两个用冒号分割的32位无符号整数。

名称

值类型

含义

pid

32u

服务器进程的进程号

uptime

32u

服务器自运行以来的秒数

time

32u

当前服务器上的UNIX时间

version

string

服务器的版本字符串

rusage_user

32u:32u

服务器进程积累的用户时间（秒:微妙）

rusage_system

32u:32u

服务器进程积累的系统时间（秒:微妙）

curr_items

32u

当前在服务器上存储的数据项的个数

total_items

32u

在服务器上曾经保存过的数据项的个数

bytes

64u

当前服务器上保存数据的字节数

curr_connections

32u

处于打开状态的链接数目

total_connections

32u

曾经打开过的全部链接的数目

connection_structures

32u

服务器分配的链接结构体的个数

cmd_get

64u

get命令请求的次数

cmd_set

64u

存储命令请求的次数

get_hits

64u

关键字获取命中的次数

get_misses

64u

关键字获取没有命中的次数

evictions

64u

全部因超时而被替换出内存的数据项的个数

bytes_read

64u

服务器从网络上读取到的字节数

bytes_write

64u

服务器向网络上写的字节数

limit_maxbytes

64u

服务器容许存储数据的最大值

其余命令 Other commands

"flush_all"是一个带有可选数字参数的命令，它的执行老是成功的，服务器老是响应以"OK"r"n"字符串。它的做用是使得全部的数据项当即（默认）或者通过一个指定的超时时间后所有失效。在置数据项失效后，对于读取命令将不会返回任何内容，除非在失效后这些数据再次被存储。flush_all并无真正的释放这些存在过的数据项占用的内存空间；数据空间真实被占用的状况发生在使用新的数据项覆盖老的数据项时。该命令做用最准确的定义是：它致使全部更新时间早于该命令设定的时间点的数据项，在被检索时被忽略，其表现就像已被删除了同样。

使用带有延时flush_all命令的目的是，当你有个memcached服务器池，须要刷新全部的内容时，但不能在同一时间刷洗全部的服务器，这样就可能由于全部的服务器忽然都要从新创建数据内容，而致使数据库压力的颠簸。延时选项容许你设置他们隔10秒失效（设置第一个延时为0，第二个10秒，第三个20秒等等）。

"version"是一个没有参数的命令，命令格式以下：

version"r"n

服务器发回的反馈信息以下：

l "VERSION <version>"r"n"

<version>是从服务器返回的版本字符串。

l 错误消息。

"verbosity"是一个带有数字参数的命令。它的执行老是成功的，服务器反馈以"OK"r"n"表示执行完成。它用来设置日志输出的详细等级。

"quit"是一个没有参数的命令。其格式以下：

quit"r"n

当服务器接受到此命令后，就关闭与该客户的链接。无论怎样，客户端能够在任意不须要该链接的时刻关闭它，而不须要发送该命令。

UDP协议 UDP protocol

当基于TCP协议的链接数超过TCP链接的上限时，咱们可使用UDP协议来替代。可是UDP协议接口不提供可靠的传输，因此多用在不严格要求成功的操做上；典型的get请求会由于缓存的问题，引发丢失或者不完整的传输。

每一个UDP数据包包含一个简单的帧头，接着就是如TCP协议描述的数据格式的数据流。在当前的实现中，请求必须包含在一个单独的UDP数据包中，但返回可能分散在多个数据包中。（惟一的能够拆分请求数据包的是大的多关键字get请求和set请求，鉴于可靠性相比而言他们更适合用TCP传输。）

帧头有8字节长，以下是其格式（全部的数字都是16位网络字节序整形，高位在前）：

       0 - 1                     请求ID

       2 - 3                     序列号

       4 - 5                     在当前的消息中含有的数据包的个数

       6-7                保留之后使用，当前必须为0

请求ID由客户端提供。它的典型值是一个从随机种子开始递增值，实际上客户端可使用任意的请求ID。服务器的反馈信息中包含了和请求命令中同样的请求ID。客户端凭借这个请求ID区分来自于同一服务器的反馈。每个包含未知请求ID的数据包，多是因为延时反馈形成，这些数据包都应该抛弃不用。

序列号从0到n-1，n是消息中总的数据包的个数。客户端按照序列号排序重组数据包；结果序列中包含了一个完整的如TCP协议同样格式的反馈信息（包含了“"r"n”总结字符串）。