adding documentation for memcached_get_by_key() and memcached_mget_by_key().

[m6w6/libmemcached] / docs / libmemcached.pod

diff --git a/docs/libmemcached.pod b/docs/libmemcached.pod
index 9685e01e88614ee309c1c3dbf04332678df26691..1eaef0ae48d062355358fe5716ee8fc7a7e11177 100755 (executable)
--- a/docs/libmemcached.pod
+++ b/docs/libmemcached.pod
@@ -20,7 +20,8 @@ B<libmemcached> 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<memcached_return> 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<memcached_st> 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
@@ -51,6 +55,14 @@ Some features of the library must be enabled through memcached_behavior_set().
 
 Hope you enjoy it!
 
+=head1 THREADS AND PROCESSES
+
+When using threads or forked processes it is important to keep an instance
+of C<memcached_st> per process or thread. Without creating your own locking
+structures you can no share a single C<memcached_st>. You can though call
+memcached_close(3) on a C<memcached_st> and then use the resulting cloned
+structure.
+
 =head1 HOME
 
 To find out more information please check:
@@ -62,6 +74,6 @@ Brian Aker, E<lt>brian@tangent.orgE<gt>
 
 =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