libmemcached API介绍

曾经终败给现在 2022-08-07 06:50 174阅读 0赞

有关memcached的C语言接口——libmemcached的介绍： 详情参见： [http://docs.libmemcached.org/index.html][http_docs.libmemcached.org_index.html]

1.        创建和删除memcached\_st结构。

\#include <libmemcached/memcached.h>

**memcachd\_st **；该结构可以静态创建也可以由memcached\_create动态创建。

** **

memcached\_st\* memcached\_create(memcached\_st* \*ptr*)

ptr不为空时是静态创建，如果ptr为空，那么该函数返回一个memcached\_st结构。

void memcached\_free(memcached\_st* \*ptr*)

释放memcached\_st结构所用的内存，删除memcached\_st。

memcached\_st\* memcached\_clone(memcached\_st* \*destination*, memcached\_st* \*source*)

克隆一个memcached\_st结构；如果source为空，那么其作用和memcached\_create一样，如果destination为空，则该函数的返回值将会返回一个和source一样的memcached\_st结构。

void memcached\_servers\_reset(memcached\_st)

将memcached\_st所拥有与服务器的连接全都断开。

Compile and link with –lmemcached

2.    Memcached\_return\_t的返回值。

[MEMCACHED\_SUCCESS][MEMCACHED_SUCCESS]表示操作成功，其他均表示错误；其他错误的详情参考：[http://docs.libmemcached.org/error\_messages.html][http_docs.libmemcached.org_error_messages.html]。

3.       增加和减少值。

\#include <libmemcached/memcached.h>

memcached\_return\_t memcached\_increment (memcached\_st \*ptr, const char \*key, size\_t key\_length, unsigned int offset, uint64\_t \*value)

memcached\_return\_t memcached\_decrement (memcached\_st \*ptr, const char \*key, size\_t key\_length, unsigned int offset, uint64\_t \*value)

offset是其增加或者减少的数值，改变后的值通过value指针返回。

其他增加和减少操作参见：

[http://docs.libmemcached.org/memcached\_auto.html][http_docs.libmemcached.org_memcached_auto.html]。

4.       从服务器获取值。

\#include <libmemcached/memcached.h>

char \* memcached\_get(memcached\_st* \*ptr*, const char* \*key*, size\_t* key\_length*, size\_t* \*value\_length*, uint32\_t* \*flags*, [memcached\_return\_t][memcached_return_t]* \*error*)；

一次通过一个键获取一个值。

[memcached\_return\_t][memcached_return_t] memcached\_mget(memcached\_st* \*ptr*, const char \* const* \*keys*, const size\_t* \*key\_length*, size\_t* number\_of\_keys*)

[memcached\_result\_st][memcached_result_st] \* memcached\_fetch\_result(memcached\_st* \*ptr*, [memcached\_result\_st][memcached_result_st]* \*result*, [memcached\_return\_t][memcached_return_t]* \*error*)

以上两个函数同时配合使用，一次调用可以通过多个键获取多个值。先通过memcached\_mget调用获取多个键的值，这些值通过循环调用memcached\_fetch\_result来获得每一个键所对应的值，直到该函数返回0。

5.       Store， Add and Replace的操作。

memcached\_return\_t memcached\_set (memcached\_st \*ptr, const char \*key, size\_t key\_length, const char \*value, size\_t value\_length, time\_t expiration, uint32\_t flags);

memcached中如果存在该键，则利用新值去替换，否则将该记录写入memcached中。

memcached\_return\_t memcached\_add (memcached\_st \*ptr, const char \*key, size\_t key\_length, const char \*value, size\_t value\_length, time\_t expiration, uint32\_t flags);

如果memcached中存在该键，发生错误；否则将该记录添加进memcached中。

memcached\_return\_t memcached\_replace (memcached\_st \*ptr, const char \*key, size\_t key\_length, const char \*value, size\_t value\_length, time\_t expiration, uint32\_t flags);

如果memcached中没有该键，发生错误；否则替换value。

以上三个函数中，key的长度不能超过250个字符，value是一个16个字节的值。Expiration是该记录在memcached的有效时间，即是超时时间。

6.       删除操作。

memcached\_return\_t memcached\_delete (memcached\_st \*ptr, const char \*key, size\_t key\_length, time\_t expiration);

该函数将与key对应的记录放入删除队列中，并且通过expiration指定该记录从服务器删除的时间。

7.       断开客户端与服务器的连接。

void memcached\_quit (memcached\_st \*ptr);

**使用遇到的：**

memcached\_server\_list\_st memcached\_server\_list\_append(memcached\_server\_list\_st list, const char \*hostname, unsigned int port, [memcached\_return\_t][memcached_return_t] \*error)

该函数是将要连接的服务器添加到memcached\_server\_st数组中，返回值为NULL时表示出现错误，如果未指定port端口则使用默认的端口。

[memcached\_return\_t][memcached_return_t] memcached\_server\_push(memcached\_st \*ptr, const memcached\_server\_st \*list)

该函数将 memcached\_server\_st数组添加到memcached\_st结构中。

void memcached\_server\_list\_free(memcached\_server\_list\_st list)

释放memcached\_server\_list\_st所占据的内存。

[http_docs.libmemcached.org_index.html]: http://docs.libmemcached.org/index.html
[MEMCACHED_SUCCESS]: http://docs.libmemcached.org/client_errors/MEMCACHED_SUCCESS.html
[http_docs.libmemcached.org_error_messages.html]: http://docs.libmemcached.org/error_messages.html
[http_docs.libmemcached.org_memcached_auto.html]: http://docs.libmemcached.org/memcached_auto.html
[memcached_return_t]: http://docs.libmemcached.org/libmemcached/memcached_return_t.html#memcached_return_t
[memcached_result_st]: http://docs.libmemcached.org/memcached_result_st.html#memcached_result_st