X-Git-Url: https://git.m6w6.name/?a=blobdiff_plain;f=docs%2Fmemcached_append.rst;h=0510a3164f4ab1d73376c9d370f6a60510e6ea7b;hb=168937e6c8d09d126458a4b698ce46f6e9560cf2;hp=a99b2cbc53deb4a48e44072d326861a97071a0f2;hpb=04b8554c3724eae57fbd75dc6b3e69dca8b58187;p=awesomized%2Flibmemcached diff --git a/docs/memcached_append.rst b/docs/memcached_append.rst index a99b2cbc..0510a316 100644 --- a/docs/memcached_append.rst +++ b/docs/memcached_append.rst @@ -18,9 +18,9 @@ SYNOPSIS .. c:function:: memcached_return_t memcached_append(memcached_st *ptr, const char *key, size_t key_length, const char *value, size_t value_length, time_t expiration, uint32_t flags) -.. c:function:: memcached_return_t memcached_prepend_by_key(memcached_st *ptr, const char *group_key, size_t group_key_length, const char *key, size_t key_length, const char *value, size_t value_length, time_t expiration, uint32_t flags); +.. c:function:: memcached_return_t memcached_prepend_by_key(memcached_st *ptr, const char *group_key, size_t group_key_length, const char *key, size_t key_length, const char *value, size_t value_length, time_t expiration, uint32_t flags) -.. c:function:: memcached_return_t memcached_append_by_key(memcached_st *ptr, const char *group_key, size_t group_key_length, const char *key, size_t key_length, const char *value, size_t value_length, time_t expiration, uint32_t flags); +.. c:function:: memcached_return_t memcached_append_by_key(memcached_st *ptr, const char *group_key, size_t group_key_length, const char *key, size_t key_length, const char *value, size_t value_length, time_t expiration, uint32_t flags) Compile and link with -lmemcached @@ -30,7 +30,7 @@ DESCRIPTION ----------- -:c:func:`memcached_prepend()` and memcached_append are used to +:c:func:`memcached_prepend` and memcached_append are used to modify information on a server. All methods take a key, and its length to store the object. Keys are currently limited to 250 characters when using either a version of memcached which is 1.4 or below, or when using the text @@ -40,18 +40,18 @@ meant to be used as a bitmap). "flags" is a 4byte space that is stored alongside of the main value. Many sub libraries make use of this field, so in most cases users should avoid making use of it. -:c:func:`memcached_prepend()` places a segment of data before the last piece +:c:func:`memcached_prepend` places a segment of data before the last piece of data stored. Currently expiration and key are not used in the server. -:c:func:`memcached_append()` places a segment of data at the end of the last +:c:func:`memcached_append` places a segment of data at the end of the last piece of data stored. Currently expiration and key are not used in the server. -:c:func:`memcached_prepend_by_key()` and -:c:func:`memcached_append_by_key_by_key()` methods both behave in a similar +:c:func:`memcached_prepend_by_key` and +:c:func:`memcached_append_by_key` methods both behave in a similar method as the non key methods. The difference is that they use their group_key parameter to map objects to particular servers. -If you are looking for performance, :c:func:`memcached_set()` with non-blocking +If you are looking for performance, :c:func:`memcached_set` with non-blocking IO is the fastest way to store data on the server. All of the above functions are testsed with the @@ -81,7 +81,7 @@ RETURN All methods return a value of type :c:type:`memcached_return_t`. On success the value will be :c:type:`MEMCACHED_SUCCESS`. -Use :c:func:`memcached_strerror()` to translate this value to a printable +Use :c:func:`memcached_strerror` to translate this value to a printable string.