预定义常量

下列常量由此扩展定义，且仅在此扩展编译入 PHP 或在运行时动态载入时可用。

Memcached::OPT_COMPRESSION

开启或关闭压缩功能。当开启的时候，item的值超过某个阈值（当前是100bytes）时，会首先对值进行压缩然后存储，并在获取该值时进行解压缩然后返回，使得压缩对应用层透明。

类型: boolean, 默认: TRUE.

Memcached::OPT_SERIALIZER

指定对于非标量值进行序列化的序列化工具。可用的值有Memcached::SERIALIZER_PHP 和Memcached::SERIALIZER_IGBINARY。后者仅在memcached配置时开启 --enable-memcached-igbinary选项并且 igbinary扩展被加载时才有效。

类型: integer, 默认: Memcached::SERIALIZER_PHP.

Memcached::SERIALIZER_PHP

默认的PHP序列化工具（即serialize方法）。

Memcached::SERIALIZER_IGBINARY

» igbinary序列化工具。它将php的数据结构存储为紧密的二进制形式，在时间和空间上都有所改进。

Memcached::SERIALIZER_JSON

JSON序列化，需要 PHP 5.2.10以上。

Memcached::OPT_PREFIX_KEY

可以用于为key创建"域"。这个值将会被作为每个key的前缀，它不能长于128个字符，并且将会缩短最大可允许的key的长度。这个前缀仅仅用于被存储的元素的key，而不会用于服务器key。

类型: string, 默认: "".

Memcached::OPT_HASH

指定存储元素key使用的hash算法。可用的值是Memcached::HASH_*系列的常量。每种hash算法都有它的优势和劣势，在你不了解或不确定哪种算法对你更有利时，请使用默认值。

类型: integer, 默认: Memcached::HASH_DEFAULT

Memcached::HASH_DEFAULT

默认的(Jenkins one-at-a-time)元素key hash算法

Memcached::HASH_MD5

md5元素key hash算法。

Memcached::HASH_CRC

CRC元素key hash算法。

Memcached::HASH_FNV1_64

FNV1_64元素key hash算法。

Memcached::HASH_FNV1A_64

FNV1_64A元素key hash算法。

Memcached::HASH_FNV1_32

FNV1_32元素key hash算法。

Memcached::HASH_FNV1A_32

FNV1_32A元素key hash算法。

Memcached::HASH_HSIEH

Hsieh元素key hash算法。

Memcached::HASH_MURMUR

Murmur元素key hash算法。

Memcached::OPT_DISTRIBUTION

指定元素key分布到各个服务器的方法。当前支持的方法有余数分步法合一致性hash算法两种。一致性hash算法提供了更好的分配策略并且在添加服务器到集群时可以最小化缓存丢失。

类型: integer, 默认: Memcached::DISTRIBUTION_MODULA.

Memcached::DISTRIBUTION_MODULA

余数分布算法。

Memcached::DISTRIBUTION_CONSISTENT

一致性分布算法(基于libketama).

Memcached::OPT_LIBKETAMA_COMPATIBLE

开启或关闭兼容的libketama类行为。当开启此选项后，元素key的hash算法将会被设置为md5并且分布算法将会采用带有权重的一致性hash分布。这一点非常有用因为其他基于libketama的客户端（比如python，urby）在同样的服务端配置下可以透明的访问key。

Note:
如果你要使用一致性hash算法强烈建议开启此选项，并且这个选项可能在未来的发布版中被设置为默认开启。

类型: boolean, 默认: FALSE.

Memcached::OPT_BUFFER_WRITES

开启或关闭I/O缓存。开启I/O缓存会导致存储命令不实际发送而是存储到缓冲区中。任意的检索数据操作都会导致缓存中的数据被发送到远程服务端。退出连接或关闭连接也会导致缓存数据被发送到远程服务端。

类型: boolean, 默认: FALSE.

Memcached::OPT_BINARY_PROTOCOL

开启使用二进制协议。请注意这个选项不能在一个打开的连接上进行切换。

类型: boolean, 默认: FALSE.

Memcached::OPT_NO_BLOCK

开启或关闭异步I/O。这将使得存储函数传输速度最大化。

类型: boolean, 默认: FALSE.

Memcached::OPT_TCP_NODELAY

开启或关闭已连接socket的无延迟特性（在某些幻境可能会带来速度上的提升）。

类型: boolean, 默认: FALSE.

Memcached::OPT_SOCKET_SEND_SIZE

socket发送缓冲的最大值。

类型: integer, 默认: 根据不同的平台/内核配置不同

Memcached::OPT_SOCKET_RECV_SIZE

socket接收缓冲的最大值。

类型: integer, 默认: 根据不同的平台/内核配置不同

Memcached::OPT_CONNECT_TIMEOUT

在非阻塞模式下这里设置的值就是socket连接的超时时间，单位是毫秒。

类型: integer, 默认: 1000.

Memcached::OPT_RETRY_TIMEOUT

等待失败的连接重试的时间，单位秒。

类型: integer, 默认: 0.

Memcached::OPT_SEND_TIMEOUT

socket发送超时时间，单位微秒。在这种情况下您不能使用非阻塞I/O，这将使得您仍然有数据会发送超时。

类型: integer, 默认: 0.

Memcached::OPT_RECV_TIMEOUT

socket读取超时时间，单位微秒。在这种情况下您不能使用非阻塞I/O，这将使得您仍然有数据会读取超时。

类型: integer, 默认: 0.

Memcached::OPT_POLL_TIMEOUT

poll连接超时时间，单位毫秒。

类型: integer, 默认: 1000.

Memcached::OPT_CACHE_LOOKUPS

开启或禁用DNS查找缓存。

类型: boolean, 默认: FALSE.

Memcached::OPT_SERVER_FAILURE_LIMIT

指定一个服务器连接的失败重试次数限制。在达到此数量的失败重连后此服务器将被从服务器池中移除。

类型: integer, 默认: 0.

Memcached::HAVE_IGBINARY

指示是否支持igbinary的序列化。

类型: boolean.

Memcached::HAVE_JSON

指示是否支持json的序列化。

类型: boolean.

Memcached::GET_PRESERVE_ORDER

一个用于Memcached::getMulti()和 Memcached::getMultiByKey()的标记用以确保返回的key和请求的key顺序保持一致。不存在的key将会得到一个NULL值。

Memcached::RES_SUCCESS

操作成功。

Memcached::RES_FAILURE

某种方式的操作失败。

Memcached::RES_HOST_LOOKUP_FAILURE

DNS查找失败。

Memcached::RES_UNKNOWN_READ_FAILURE

读取网络数据失败。

Memcached::RES_PROTOCOL_ERROR

错误的memcached协议命令。

Memcached::RES_CLIENT_ERROR

客户端错误。

Memcached::RES_SERVER_ERROR

服务端错误。

Memcached::RES_WRITE_FAILURE

向网络写数据失败。

Memcached::RES_DATA_EXISTS

比较并交换值操作失败（cas方法）：尝试向服务端存储数据时由于自此连接最后一次取此key对应数据之后被改变导致失败。

Memcached::RES_NOTSTORED

元素没有被存储，但并不是因为一个错误。这通常表明add（元素已存在）或replace（元素不存在）方式存储数据失败或者元素已经在一个删除序列中（延时删除）。

Memcached::RES_NOTFOUND

元素未找到（通过get或cas操作时）。

Memcached::RES_PARTIAL_READ

局部网络数据读错误。

Memcached::RES_SOME_ERRORS

在多key获取的时候发生错误。

Memcached::RES_NO_SERVERS

服务器池空。

Memcached::RES_END

结果集到结尾了。

Memcached::RES_ERRNO

系统错误。

Memcached::RES_BUFFERED

操作被缓存。

Memcached::RES_TIMEOUT

操作超时。

Memcached::RES_BAD_KEY_PROVIDED

提供了无效的key。

Memcached::RES_CONNECTION_SOCKET_CREATE_FAILURE

创建网络socket失败。

Memcached::RES_PAYLOAD_FAILURE

不能压缩/解压缩或序列化/反序列化值。

User Contributed Notes

Anonymous 24-Feb-2017 12:06


Note that with Memcached::OPT_BINARY_PROTOCOL enabled there is some (possibly significant) size overhead added at the TCP level.



If you have a high volume of small values being get/set, you should analyze the effect of this option on your overall traffic size with a network tool (e.g. tcpdump) before enabling it, especially if you pay for traffic in/out of your memcache instance.

igorsantos07 no gmail 28-Dec-2015 07:00


As per a StackOverflow answer (http://stackoverflow.com/a/9042985/102960, by @rid), this is the current list of Memcached Response constants:



00 = MEMCACHED_SUCCESS

01 = MEMCACHED_FAILURE

02 = MEMCACHED_HOST_LOOKUP_FAILURE // getaddrinfo() and getnameinfo() only

03 = MEMCACHED_CONNECTION_FAILURE

04 = MEMCACHED_CONNECTION_BIND_FAILURE // DEPRECATED see MEMCACHED_HOST_LOOKUP_FAILURE

05 = MEMCACHED_WRITE_FAILURE

06 = MEMCACHED_READ_FAILURE

07 = MEMCACHED_UNKNOWN_READ_FAILURE

08 = MEMCACHED_PROTOCOL_ERROR

09 = MEMCACHED_CLIENT_ERROR

10 = MEMCACHED_SERVER_ERROR // Server returns "SERVER_ERROR"

11 = MEMCACHED_ERROR // Server returns "ERROR"

12 = MEMCACHED_DATA_EXISTS

13 = MEMCACHED_DATA_DOES_NOT_EXIST

14 = MEMCACHED_NOTSTORED

15 = MEMCACHED_STORED

16 = MEMCACHED_NOTFOUND

17 = MEMCACHED_MEMORY_ALLOCATION_FAILURE

18 = MEMCACHED_PARTIAL_READ

19 = MEMCACHED_SOME_ERRORS

20 = MEMCACHED_NO_SERVERS

21 = MEMCACHED_END

22 = MEMCACHED_DELETED

23 = MEMCACHED_VALUE

24 = MEMCACHED_STAT

25 = MEMCACHED_ITEM

26 = MEMCACHED_ERRNO

27 = MEMCACHED_FAIL_UNIX_SOCKET // DEPRECATED

28 = MEMCACHED_NOT_SUPPORTED

29 = MEMCACHED_NO_KEY_PROVIDED /* Deprecated. Use MEMCACHED_BAD_KEY_PROVIDED! */

30 = MEMCACHED_FETCH_NOTFINISHED

31 = MEMCACHED_TIMEOUT

32 = MEMCACHED_BUFFERED

33 = MEMCACHED_BAD_KEY_PROVIDED

34 = MEMCACHED_INVALID_HOST_PROTOCOL

35 = MEMCACHED_SERVER_MARKED_DEAD

36 = MEMCACHED_UNKNOWN_STAT_KEY

37 = MEMCACHED_E2BIG

38 = MEMCACHED_INVALID_ARGUMENTS

39 = MEMCACHED_KEY_TOO_BIG

40 = MEMCACHED_AUTH_PROBLEM

41 = MEMCACHED_AUTH_FAILURE

42 = MEMCACHED_AUTH_CONTINUE

43 = MEMCACHED_PARSE_ERROR

44 = MEMCACHED_PARSE_USER_ERROR

45 = MEMCACHED_DEPRECATED

46 = MEMCACHED_IN_PROGRESS

47 = MEMCACHED_SERVER_TEMPORARILY_DISABLED

48 = MEMCACHED_SERVER_MEMORY_ALLOCATION_FAILURE

49 = MEMCACHED_MAXIMUM_RETURN /* Always add new error code before */

11 = MEMCACHED_CONNECTION_SOCKET_CREATE_FAILURE = MEMCACHED_ERROR

Allen Tsai 24-May-2011 03:04


Memcached::OPT_SERVER_FAILURE_LIMIT - once a server has hit this limit, the client's getResultMessage() will return "SERVER IS MARKED DEAD."  Further gets() for keys hashing to this server will continue returning this message, as will sets() hashing to the dead server.



Version 2.0.01b supports a constant Memcached::OPT_AUTO_EJECT_HOSTS which allows automatic rebalancing of the cluster/automatic failover handling.

akenney at onesite dot com 29-Dec-2010 08:13


Apparently there is a bug in libmemcached where connect timeout does not work when OPT_NO_BLOCK is set as well.



The bug and related blocking bugs are discussed here:

https://bugs.launchpad.net/libmemcached/+bug/583031



We confirmed this in libmemcached version 0.43 



Be sure to test some memcache servers in your pool being unavailable (no route to host and memcache service down) to ensure that timeout settings are working correctly.

tyliu2 at gmail dot com 21-Jan-2010 10:07


RES_SUCCESS = 0

RES_FAILURE = 1

RES_HOST_LOOKUP_FAILURE = 2

RES_UNKNOWN_READ_FAILURE = 7

RES_PROTOCOL_ERROR = 8

RES_CLIENT_ERROR = 9

RES_SERVER_ERROR = 10

RES_WRITE_FAILURE = 5

RES_DATA_EXISTS = 12

RES_NOTSTORED = 14

RES_NOTFOUND = 16

RES_PARTIAL_READ = 18

RES_SOME_ERRORS = 19

RES_NO_SERVERS = 20

RES_END = 21

RES_ERRNO = 26

RES_BUFFERED = 32

RES_TIMEOUT = 31

RES_BAD_KEY_PROVIDED = 33

RES_CONNECTION_SOCKET_CREATE_FAILURE = 11

RES_PAYLOAD_FAILURE = -1001