X-Git-Url: https://git.m6w6.name/?a=blobdiff_plain;f=docs%2Flibmemcached.pod;h=e1a95a73eebdd34bfcf69a8b5e355c37f75437be;hb=0d26482f4c7e8cb5e811771c91e95007d0b78f3e;hp=1eaef0ae48d062355358fe5716ee8fc7a7e11177;hpb=b01ff6189633c1bf86f94065d2564810e6871869;p=awesomized%2Flibmemcached diff --git a/docs/libmemcached.pod b/docs/libmemcached.pod old mode 100755 new mode 100644 index 1eaef0ae..e1a95a73 --- 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 @@ -34,7 +33,7 @@ written in order to encapsulate the C. It is not 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). +This value can be translated to a printable string with memcached_strerror(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. @@ -55,12 +54,60 @@ 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. + +=item MEMCACHED_VERSION_STRING + +String value of libmemcached version such as "1.23.4" + +=item MEMCACHED_MAJOR_VERSION + +Major version value. Such as 1.23.4, would be 1 + +=item MEMCACHED_MINOR_VERSION + +Major version value. Such as 1.23.4, would be 23 + +=item MEMCACHED_MICRO_VERSION + +Major version value. Such as 1.23.4, would be 4 + + +=back + + + =head1 THREADS AND PROCESSES When using threads or forked processes it is important to keep an instance of C per process or thread. Without creating your own locking -structures you can no share a single C. You can though call -memcached_close(3) on a C and then use the resulting cloned +structures you can not share a single C. You can though call +memcached_quit(3) on a C and then use the resulting cloned structure. =head1 HOME @@ -74,6 +121,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) memcached_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) memcached_callback_get(3) memcached_callback_set(3) memcached_version(3) memcached_lib_version(3) memcached_result_set_value(3) memcached_dump(3) memdump(1) memcached_set_memory_allocators(3) memcached_get_memory_allocators(3) memcached_get_user_data(3) memcached_set_user_data(3) + =cut