X-Git-Url: https://git.m6w6.name/?a=blobdiff_plain;f=docs%2Flibmemcached.pod;h=cb5083d5af39934e9a58a8ea98fd6b0f77771750;hb=e4dbb63d6df3b1d756c863c502cb4d33cc49cb18;hp=1eaef0ae48d062355358fe5716ee8fc7a7e11177;hpb=b01ff6189633c1bf86f94065d2564810e6871869;p=m6w6%2Flibmemcached diff --git a/docs/libmemcached.pod b/docs/libmemcached.pod index 1eaef0ae..cb5083d5 100755 --- a/docs/libmemcached.pod +++ b/docs/libmemcached.pod @@ -23,9 +23,8 @@ particular keys to specific servers that you specify (and values are 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 -routing, a simple modulus method is currently used. +There are multiple implemented routing and hashing methods. See the +memcached_behavior_set() manpage. All operations are performed against a C structure. These structures can either be dynamically allocated or statically @@ -55,6 +54,37 @@ Some features of the library must be enabled through memcached_behavior_set(). Hope you enjoy it! +=head1 CONSTANTS + +A number of constants have been provided for in the library. + +=over 4 + +=item MEMCACHED_DEFAULT_PORT + +The default port used by memcached(3). + +=item MEMCACHED_MAX_KEY + +Default maximum size of a key (which includes the null pointer). Master keys +have no limit, this only applies to keys used for storage. + +=item MEMCACHED_MAX_KEY + +Default size of key (which includes the null pointer). + +=item MEMCACHED_STRIDE + +This is the "stride" used in the consistent hash used between replicas. + +=item MEMCACHED_MAX_HOST_LENGTH + +Maximum allowed size of the hostname. + +=back + + + =head1 THREADS AND PROCESSES When using threads or forked processes it is important to keep an instance @@ -74,6 +104,7 @@ 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_get_by_key() memcached_mget_by_key() +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(3) memcached_mget_by_key(3) memcached_delete_by_key(3) memcached_fetch_execute(3) + =cut