MemLink API

Introduction

目前，memlink支持的客户端库，有c,python,php,java这四种。python，php，java客户端实际上是利用c客户端来做成不同语言的模块。因此c以外语言的客户端同样可以达到很高的性能。

Details

C/C++

• MemLink* memlink_create(char *host, int readport, int writeport, int timeout);
  
  

创建MemLink数据结构

host为memlink server的ip，readport为server端的读端口，writeport为server端的写端口，timeout为网络操作的超时时间。单位为秒。

错误返回NULL，否则为成功

• void memlink_destroy(MemLink *m);
  
  

销毁MemLink数据结构，释放资源

• void memlink_close(MemLink *m);
  
  

关闭MemLink中的网络连接

• int memlink_cmd_dump(MemLink *m);
  
  

发送DUMP命令。memlink服务器端执行dump操作。

返回MEMLINK_OK表示执行成功，否则出错

• int memlink_cmd_clean(MemLink *m, char *key);
  
  

发送CLEAN命令。memlink会对该key下的列表进行重新排列，以去除已真实删除的数据空洞。

• int memlink_cmd_stat(MemLink *m, char *key, MemLinkStat *stat);
  
  

发送STAT命令。获取对应key的一些统计信息，结果存储到传入的参数stat中。 MemLinkStat的结构如下：

  typedef struct _memlink_stat
  {
      unsigned char   valuesize;
      unsigned char   masksize;
      unsigned int    blocks; // all blocks
      unsigned int    data;   // all alloc data item
      unsigned int    data_used; // all data item used
      unsigned int    mem;       // all alloc mem
      unsigned int    mem_used;  // all used mem
  }MemLinkStat; 

其中valuesize为value长度的字节数，masksize为mask长度的字节数。blocks为该key下有多少个大的数据块（这里称为block），data为这些所有block中可以容纳的value数，data_used为实际存储了多少个value值。mem为所有block一共占用的内存字节数，mem_used对应data_used所占用的内存字节数。

• int memlink_cmd_create(MemLink *m, char *key, int valuelen, char *maskstr);
  
  

发送CREATE命令，创建一个key。参数valuelen表示该key下的value的长度，maskstr为value的属性格式。该属性格式由问号分隔的数字组成。这些数字表示对应属性项所占用的空间的bit数。比如4:3:1表示有三个属性，这三个属性分别占用4bit，3bit，1bit。

• int memlink_cmd_del(MemLink *m, char *key, char *value, int valuelen);
  
  

发送DEL命令。删除一个指定key下的对应value。

• int memlink_cmd_insert(MemLink *m, char *key, char *value, int valuelen,char *maskstr, unsigned int pos);
  
  

发送insert命令，在指定的key下插入一个value，且此value要插入到一个指定位置。maskstr为该value的熟悉信息。格式和创建key时指定的属性格式对应。比如创建时属性格式为4:3:1，那么这里的maskstr也只能设置三项，比如maskstr可以为8:3:1。pos表示value要插入到列表中的哪个位置，0是列表头部，-1是列表尾部。注意，如果pos超出了列表的范围，也会被插入到尾部。

• int memlink_cmd_update(MemLink *m, char *key, char *value, int valuelen, unsigned int pos);
  
  

发送UPDATE命令，更新一个value的位置。pos为此value的新位置。

• int memlink_cmd_mask(MemLink *m, char *key, char *value, int valuelen, char *maskstr);
  
  

发送MASK命令，修改一个value的属性值。这里的maskstr的格式和INSERT命令的格式一样。

• int memlink_cmd_tag(MemLink *m, char *key, char *value, int valuelen, int tag);
  
  

发送TAG命令，对一个value进行标记删除或者恢复。标记删除的value不会被真实删除，只是该数据不再显示。tag值为MEMLINK_TAG_DEL表示标记删除，为MEMLINK_TAG_RESTOR表示恢复。

• int memlink_cmd_range(MemLink *m, char *key, char *maskstr,unsigned int frompos, unsigned int len,MemLinkResult *result);
  
  

发送RANGE命令，获取指定key下的某个范围的value。frompos是获取的开始位置，从0开始，len为要获取的长度。结果将写入到result中。 MemLinkResult的结构定义如下：

  typedef struct _memlink_result
  {
      int          count;
      int          valuesize;
      int          masksize;
      MemLinkItem  *root;
  }MemLinkResult;

其中count为返回的结果的条数，valuesize为value的长度(字节数)，masksize为mask的长度（字节数）。root为返回结果的链表。 MemLinkItem的结构定义如下：

  typedef struct _memlink_item
  {
      struct _memlink_item    *next;
      char                    value[256];
      char                    mask[256];
  }MemLinkItem;

其中的next是链表的下一个节点指针，value和mask就是对应的结果值。

• int memlink_cmd_rmkey(MemLink *m, char *key);
  
  

发送RMKEY命令，删除一个key，以及该key下的所有value。

• int memlink_cmd_count(MemLink *m, char *key, char *maskstr, MemLinkCount *count); 
  
  

发送COUNT命令，以maskstr为条件，统计一个key下所有可见的value，以及被标记删除的value的数量。结果写入到count中。MemLinkCount结构定义如下：

  typedef struct _memlink_count
  {
     unsigned int    visible_count;
     unsigned int    tagdel_count;
  }MemLinkCount;

visible_count为可见value的数量。tagdel_count为标记删除的value的数量。

• void memlink_result_free(MemLinkResult *result);
  
  

释放MemLinkResult结构中的root项的内存。

PHP

• class MemLinkClient

memlink客户端类。

• construct($host, $readport, $writeport, $timeout)

同c版memlink_create。

• close()

同c版memlink_close

• destroy()

同c版memlink_destroy

• create($key, $valuesize, $maskformat)

同c版memlink_cmd_create。返回值为整型，正常返回MEMLNK_OK。

• dump()

同c版memlink_dump。返回值为整型，正常返回MEMLNK_OK。

• clean($key)

同c版memlink_cmd_clean。返回值为整型，正常返回MEMLNK_OK。

• stat($key)

同c版memlink_cmd_stat。返回MemLinkStat对象，失败返回null。

• stat2($key, $mstat)

同c版memlink_cmd_stat。和上一个stat方法的区别是，需要传一个MemLinkStat对象作为第二个参数，返回值为整型，正常返回MEMLNK_OK。

• delete($key, $value, $valuelen)

同c版memlink_cmd_del。返回值为整型，正常返回MEMLNK_OK。

• insert($key, $value, $valuelen, $maskstr, $pos)

同c版memlink_cmd_insert。返回值为整型，正常返回MEMLNK_OK。

• update($key, $value, $valuelen, $pos)

同c版memlink_cmd_update。返回值为整型，正常返回MEMLNK_OK。

• mask($key, $value, $valulen, $maskstr)

同c版memlink_cmd_mask。返回值为整型，正常返回MEMLNK_OK。

• tag($key, $value, $valuelen, $tag)

同c版memlink_cmd_tag。返回值为整型，正常返回MEMLNK_OK。

• range($key, $maskstr, $frompos, $len)

同c版memlink_cmd_range。返回MemLinkResult对象，失败返回null。

• range2($key, $maskstr, $frompos, $len, $result)

同c版memlink_cmd_range。和上一个range方法的区别是，需要传一个MemLinkResult对象作为第二个参数，返回值为整型，正常返回MEMLNK_OK。

• rmkey($key)

同c版memlink_cmd_rmkey。返回值为整型，正常返回MEMLNK_OK。

• count($key, $maskstr)

同c版memlink_cmd_count。返回MemLinkCount对象，失败返回null。

• count2($key, $maskstr, $count)

同c版memlink_cmd_count2。和上一个count方法的区别是，需要传一个MemLinkCount对象作为第二个参数，返回值为整型，正常返回MEMLNK_OK。

 

PYTHON

• class MemLinkClient

memlink客户端类

• init(self, host, readport, writeport, timeout)

同c版memlink_create。

• close(self)

同c版memlink_close

• destroy(self)

同c版memlink_destroy

• dump(self)

同c版memlink_dump。返回值为整型，正常返回MEMLNK_OK。

• clean(self, key)

同c版memlink_cmd_clean。返回值为整型，正常返回MEMLNK_OK。

• create(self, key, valuesize, maskstr)

同c版memlink_cmd_create。返回值为整型，正常返回MEMLNK_OK。

• stat(self, key)

同c版memlink_cmd_stat。返回值为tuple,共两个成员。其中第一项为整形返回值，为MEMLINK_OK表示正常。第二项为MemLinkStat对象。

• delete(self, key, value)

同c版memlink_cmd_delete。返回值为整型，正常返回MEMLNK_OK。

• insert(self, key, value, maskstr, pos)

同c版memlink_cmd_insert。返回值为整型，正常返回MEMLNK_OK。

• update(self, key, value, pos)

同c版memlink_cmd_update。返回值为整型，正常返回MEMLNK_OK。

• mask(self, key, value, maskstr)

同c版memlink_cmd_mask。返回值为整型，正常返回MEMLNK_OK。

• tag(self, key, value, tag)

同c版memlink_cmd_tag。返回值为整型，正常返回MEMLNK_OK。

• range(self, key, maskstr, frompos, len)

同c版memlink_cmd_range。返回值为tuple,共两个成员。其中第一项为整形返回值，为MEMLINK_OK表示正常。第二项为MemLinkResult对象。

• rmkey(self, key)

同c版memlink_cmd_rmkey。返回值为整型，正常返回MEMLNK_OK。

• count(self, key, maskstr)

同c版memlink_cmd_count。返回值为tuple,共两个成员。其中第一项为整形返回值，为MEMLINK_OK表示正常。第二项为MemLinkCount对象。

Java

• public class MemLinkClient

memlink客户端类。说明和php版本类似。

• public MemLinkClient (String host, int readport, int writeport, int timeout)
• public void close()
• public void destroy()
• public int create(String key, int valuesize, String maskstr)
• public int dump()
• public int clean(String key)
• public MemLinkStat stat(String key)
• public int stat2(String key, MemLinkStat stat)
• public int delete(String key, String value)
• public int insert(String key, String value, String maskstr, int pos)
• public int update(String key, String value, int pos)
• public int mask(String key, String value, String maskstr)
• public int tag(String key, String value, int tag)
• public MemLinkResult range(String key, String maskstr, int frompos, int len)
• public int range2(String key, String maskstr, int frompos, int len, MemLinkResult mresult)
• public int rmkey(String key)
• public MemLinkCount count(String key, String maskstr)
• public int count2(String key, String maskstr, MemLinkCount mcount)