From f9e6b77431a796dd1937f9f49198225a392d95ca Mon Sep 17 00:00:00 2001 From: Date: Wed, 5 Dec 2007 08:52:19 +0900 Subject: [PATCH] adding documentation for memcached_get_by_key() and memcached_mget_by_key(). --- docs/Makefile.am | 8 ++++++++ docs/libmemcached.pod | 8 ++++++-- docs/memcached_get.pod | 18 ++++++++++++++++++ support/libmemcached.spec.in | 2 ++ 4 files changed, 34 insertions(+), 2 deletions(-) diff --git a/docs/Makefile.am b/docs/Makefile.am index 767065d4..d9795ad5 100644 --- a/docs/Makefile.am +++ b/docs/Makefile.am @@ -45,8 +45,10 @@ man_MANS = libmemcached.3\ memcached_fetch_result.3\ memcached_free.3\ memcached_get.3\ + memcached_get_by_key.3\ memcached_increment.3\ memcached_mget.3\ + memcached_mget_by_key.3\ memcached_prepend.3\ memcached_replace.3\ memcached_server_add.3\ @@ -114,12 +116,18 @@ memcached_flush.3: memcached_flush.pod memcached_get.3: memcached_get.pod pod2man -c "libmemcached" -r "" -s 3 memcached_get.pod > memcached_get.3 +memcached_get_by_key.3: memcached_get.pod + pod2man -c "libmemcached" -r "" -s 3 memcached_get.pod > memcached_get_by_key.3 + memcached_fetch_result.3: memcached_get.pod pod2man -c "libmemcached" -r "" -s 3 memcached_get.pod > memcached_fetch_result.3 memcached_mget.3: memcached_get.pod pod2man -c "libmemcached" -r "" -s 3 memcached_get.pod > memcached_mget.3 +memcached_mget_by_key.3: memcached_get.pod + pod2man -c "libmemcached" -r "" -s 3 memcached_get.pod > memcached_mget_by_key.3 + memcached_fetch.3: memcached_get.pod pod2man -c "libmemcached" -r "" -s 3 memcached_get.pod > memcached_fetch.3 diff --git a/docs/libmemcached.pod b/docs/libmemcached.pod index 510cd1e7..1eaef0ae 100755 --- a/docs/libmemcached.pod +++ b/docs/libmemcached.pod @@ -20,7 +20,8 @@ B is a small, thread-safe client library for the memcached protocol. The code has all been written with an eye to allow for both web and embedded usage. It handles the work behind routing particular keys to specific servers that you specify (and values are -matched based on server order as supplied by you). +matched based on server order as supplied by you). It implements both +a modula and consistent method of object distribution. The aim is to support multiple routing and hashing methods. Currently only two hashing methods are supported, a quick built-in routine, and MD5. For @@ -35,6 +36,9 @@ recommended that you operate directly against the structure. Nearly all functions return a C value. This value can be translated to a printable string with memcached_strerr(3). +Partitioning based on keys is supported in the library. Using the key partioning +functions it is possible to group sets of object onto servers. + C structures are thread-safe, but each thread must contain its own structure (that is, if you want to share these among threads you must provide your own locking). No global variables are @@ -70,6 +74,6 @@ Brian Aker, Ebrian@tangent.orgE =head1 SEE ALSO -memcached(1) libmemcached_examples(3) libmemcached(1) memcat(1) memcp(1) memflush(1) memrm(1) memslap(1) memstat(1) memcached_fetch(3) memcached_replace(3) memcached_server_list_free(3) libmemcached_examples(3) memcached_clone(3) memcached_free(3) memcached_server_add(3) memcached_server_push(3) memcached_add(3) memcached_get(3) memcached_server_count(3) memcached_servers_parse(3) memcached_create(3) memcached_increment(3) memcached_server_list(3) memcached_set(3) memcached_decrement(3) memcached_mget(3) memcached_server_list_append(3) memcached_strerror(3) memcached_delete(3) memcached_quit(3) memcached_server_list_count(3) memcached_verbosity(3) memcached_server_add_unix_socket(3) memcahed_result_create(3) memcached_result_free(3) memcached_result_key_value(3) memcached_result_key_length(3) memcached_result_value(3) memcached_result_length(3) memcached_result_flags(3) memcached_result_cas(3) memcached_result_st(3) memcached_append(3) memcached_prepend(3) memcached_fetch_result(3) memerror(1) +memcached(1) libmemcached_examples(3) libmemcached(1) memcat(1) memcp(1) memflush(1) memrm(1) memslap(1) memstat(1) memcached_fetch(3) memcached_replace(3) memcached_server_list_free(3) libmemcached_examples(3) memcached_clone(3) memcached_free(3) memcached_server_add(3) memcached_server_push(3) memcached_add(3) memcached_get(3) memcached_server_count(3) memcached_servers_parse(3) memcached_create(3) memcached_increment(3) memcached_server_list(3) memcached_set(3) memcached_decrement(3) memcached_mget(3) memcached_server_list_append(3) memcached_strerror(3) memcached_delete(3) memcached_quit(3) memcached_server_list_count(3) memcached_verbosity(3) memcached_server_add_unix_socket(3) memcahed_result_create(3) memcached_result_free(3) memcached_result_key_value(3) memcached_result_key_length(3) memcached_result_value(3) memcached_result_length(3) memcached_result_flags(3) memcached_result_cas(3) memcached_result_st(3) memcached_append(3) memcached_prepend(3) memcached_fetch_result(3) memerror(1) memcached_get_by_key() memcached_mget_by_key() =cut diff --git a/docs/memcached_get.pod b/docs/memcached_get.pod index 6de4b5eb..111a3b61 100755 --- a/docs/memcached_get.pod +++ b/docs/memcached_get.pod @@ -25,6 +25,19 @@ C Client Library for memcached (libmemcached, -lmemcached) memcached_mget (memcached_st *ptr, char **keys, size_t *key_length, unsigned int number_of_keys); + char * + memcached_get_by_key(memcached_st *ptr, + char *master_key, size_t master_key_length, + char *key, size_t key_length, + size_t *value_length, + uint16_t *flags, + memcached_return *error); + + memcached_return + memcached_mget_by_key(memcached_st *ptr, + char *master_key, size_t master_key_length, + char **keys, size_t *key_length, + unsigned int number_of_keys); char *memcached_fetch (memcached_st *ptr, char *key, size_t *key_length, @@ -67,6 +80,11 @@ to the server. For more information please refer to the memcached_result_st(3) help. This function will dynamically allocate a result structure for you if you do not pass one to the function. +memcached_get_by_key() and memcached_mget_by_key() behave in a similar nature +as memcached_get() and memcached_mget(). The difference is that they take +a master key that is used for determining which server an object was stored +if key partitioning was used for storage. + =head1 RETURN All objects returned must be freed by the calling application. diff --git a/support/libmemcached.spec.in b/support/libmemcached.spec.in index 2ed34137..580241fc 100644 --- a/support/libmemcached.spec.in +++ b/support/libmemcached.spec.in @@ -79,8 +79,10 @@ memerror - Creates human readable messages from libmemecached error codes. %{_mandir}/man3/memcached_fetch_result.3.gz %{_mandir}/man3/memcached_free.3.gz %{_mandir}/man3/memcached_get.3.gz +%{_mandir}/man3/memcached_get_by_key.3.gz %{_mandir}/man3/memcached_increment.3.gz %{_mandir}/man3/memcached_mget.3.gz +%{_mandir}/man3/memcached_mget_by_key.3.gz %{_mandir}/man3/memcached_prepend.3.gz %{_mandir}/man3/memcached_quit.3.gz %{_mandir}/man3/memcached_replace.3.gz -- 2.30.2