X-Git-Url: https://git.m6w6.name/?a=blobdiff_plain;f=docs%2Flibmemcached.rst;h=a97db699575f35967327950f6c9a21d146855aa1;hb=a18c65b0ee1a4721a4f1298f52f8b3446cf7c600;hp=23ec93b49a9974e6b0b7646d00b96a6f747d1a62;hpb=0f16555031c7f44d1acd034ff74e628c51a72dac;p=m6w6%2Flibmemcached diff --git a/docs/libmemcached.rst b/docs/libmemcached.rst index 23ec93b4..a97db699 100644 --- a/docs/libmemcached.rst +++ b/docs/libmemcached.rst @@ -10,7 +10,9 @@ SYNOPSIS Compile and link with -lmemcached -libMemcached is an open source C/C++ client library and tools for the memcached server (http://danga.com/memcached). It has been designed to be light on memory usage, thread safe, and provide full access to server side methods. +======= + +libMemcached is an open source C/C++ client library and tools for the memcached server (http://memcached.org/). It has been designed to be light on memory usage, thread safe, and provide full access to server side methods. libMemcached was designed to provide the greatest number of options to use Memcached. Some of the features provided: @@ -29,9 +31,9 @@ DESCRIPTION "Memcached is a high-performance, distributed memory object caching system, generic in nature, but intended for use in speeding up dynamic web -applications by alleviating database load." `http://danga.com/memcached/ `_ +applications by alleviating database load." `http://memcached.org/ `_ -\ **libmemcached**\ is a small, thread-safe client library for the +:program:`libmemcached` is a small, thread-safe client library for the memcached protocol. The code has all been written to allow for both web and embedded usage. It handles the work behind routing individual keys to specific servers specified by the developer (and values are @@ -39,16 +41,17 @@ matched based on server order as supplied by the user). It implements a modular and consistent method of object distribution. There are multiple implemented routing and hashing methods. See the -memcached_behavior_set() manpage for more information. +:c:func:`memcached_behavior_set()` manpage for more information. -All operations are performed against a \ ``memcached_st``\ structure. +All operations are performed against a :c:type:`memcached_st` structure. These structures can either be dynamically allocated or statically -allocated and then initialized by memcached_create(). Functions have been -written in order to encapsulate the \ ``memcached_st``\ . It is not +allocated and then initialized by :c:func:`memcached_create()`. Functions have +been written in order to encapsulate the :c:type:`memcached_st`. It is not recommended that you operate directly against the structure. -Nearly all functions return a \ ``memcached_return_t``\ value. -This value can be translated to a printable string with memcached_strerror(3). +Nearly all functions return a :c:type:`memcached_return_t` value. +This value can be translated to a printable string with +:c:type:`memcached_strerror()`. Objects are stored on servers by hashing keys. The hash value maps the key to a particular server. All clients understand how this hashing works, so it is possibly to reliably both push data to a server and retrieve data from a server. @@ -56,7 +59,7 @@ Group keys can be optionally used to group sets of objects with servers. Namespaces are supported, and can be used to partition caches so that multiple applications can use the same memcached servers. -\ ``memcached_st``\ structures are thread-safe, but each thread must +:c:type:`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 used in this library. @@ -68,7 +71,7 @@ PKG_CHECK_MODULES(DEPS, libmemcached >= 0.8.0) AC_SUBST(DEPS_CFLAGS) AC_SUBST(DEPS_LIBS) -Some features of the library must be enabled through memcached_behavior_set(). +Some features of the library must be enabled through :c:func:`memcached_behavior_set()`. Hope you enjoy it! @@ -129,10 +132,9 @@ THREADS AND PROCESSES When using threads or forked processes it is important to keep one instance -of \ ``memcached_st``\ per process or thread. Without creating your own locking -structures you can not share a single \ ``memcached_st``\ . However, you can call -memcached_quit(3) on a \ ``memcached_st``\ and then use the resulting cloned -structure. +of :c:type:`memcached_st` per process or thread. Without creating your own +locking structures you can not share a single :c:type:`memcached_st`. However, +you can call :c:func:`memcached_quit()` on a :c:type:`memcached_st` and then use the resulting cloned structure. ----