X-Git-Url: https://git.m6w6.name/?a=blobdiff_plain;f=docs%2Fman%2Fmemcached_append.3;fp=docs%2Fman%2Fmemcached_append.3;h=0000000000000000000000000000000000000000;hb=1269230d28c43a67a51b74a5b42fd906be6a172a;hp=34b2c8ec69ad14e552be68798d290414b9bcd65f;hpb=c3723b53b87471782076765f0fff656d07de74e0;p=awesomized%2Flibmemcached diff --git a/docs/man/memcached_append.3 b/docs/man/memcached_append.3 deleted file mode 100644 index 34b2c8ec..00000000 --- a/docs/man/memcached_append.3 +++ /dev/null @@ -1,111 +0,0 @@ -.TH "MEMCACHED_APPEND" "3" "June 10, 2011" "0.47" "libmemcached" -.SH NAME -memcached_append \- Appending to or Prepending to data on the server -. -.nr rst2man-indent-level 0 -. -.de1 rstReportMargin -\\$1 \\n[an-margin] -level \\n[rst2man-indent-level] -level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] -- -\\n[rst2man-indent0] -\\n[rst2man-indent1] -\\n[rst2man-indent2] -.. -.de1 INDENT -.\" .rstReportMargin pre: -. RS \\$1 -. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin] -. nr rst2man-indent-level +1 -.\" .rstReportMargin post: -.. -.de UNINDENT -. RE -.\" indent \\n[an-margin] -.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]] -.nr rst2man-indent-level -1 -.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] -.in \\n[rst2man-indent\\n[rst2man-indent-level]]u -.. -.\" Man page generated from reStructeredText. -. -.sp -Appending or Prepending to data on the server -.SH SYNOPSIS -.sp -#include -.INDENT 0.0 -.TP -.B memcached_return_t memcached_prepend(memcached_st\fI\ *ptr\fP, const char\fI\ *key\fP, size_t\fI\ key_length\fP, const char\fI\ *value\fP, size_t\fI\ value_length\fP, time_t\fI\ expiration\fP, uint32_t\fI\ flags\fP) -.UNINDENT -.INDENT 0.0 -.TP -.B memcached_return_t memcached_append(memcached_st\fI\ *ptr\fP, const char\fI\ *key\fP, size_t\fI\ key_length\fP, const char\fI\ *value\fP, size_t\fI\ value_length\fP, time_t\fI\ expiration\fP, uint32_t\fI\ flags\fP) -.UNINDENT -.INDENT 0.0 -.TP -.B 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); -.UNINDENT -.INDENT 0.0 -.TP -.B 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); -.UNINDENT -.sp -Compile and link with \-lmemcached -.SH DESCRIPTION -.sp -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(1) which is 1.4 or below, or when using the text protocol. -You must supply both a value and a length. Optionally you -may test an expiration time for the object and a 16 byte value (it is -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. -.sp -memcached_prepend() places a segment of data before the last piece of data -stored. Currently expiration and key are not used in the server. -.sp -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. -.sp -memcached_prepend_by_key() and memcached_append_by_key_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. -.sp -If you are looking for performance, memcached_set() with non\-blocking IO is -the fastest way to store data on the server. -.sp -All of the above functions are testsed with the \fBMEMCACHED_BEHAVIOR_USE_UDP\fPbehavior enabled. However, when using these operations with this behavior on, there -are limits to the size of the payload being sent to the server. The reason for -these limits is that the Memcached Server does not allow multi\-datagram requests -and the current server implementation sets a datagram size to 1400 bytes. Due -to protocol overhead, the actual limit of the user supplied data is less than -1400 bytes and depends on the protocol in use as, well as the operation being -executed. When running with the binary protocol, \(ga\(ga MEMCACHED_BEHAVIOR_BINARY_PROTOCOL\(ga\(ga, -the size of the key,value, flags and expiry combined may not exceed 1368 bytes. -When running with the ASCII protocol, the exact limit fluctuates depending on -which function is being executed and whether the function is a cas operation -or not. For non\-cas ASCII set operations, there are at least 1335 bytes available -to split among the key, key_prefix, and value; for cas ASCII operations there are -at least 1318 bytes available to split among the key, key_prefix and value. If the -total size of the command, including overhead, exceeds 1400 bytes, a \fBMEMCACHED_WRITE_FAILURE\fPwill be returned. -.SH RETURN -.sp -All methods return a value of type \fBmemcached_return_t\fP. -On success the value will be \fBMEMCACHED_SUCCESS\fP. -Use memcached_strerror() to translate this value to a printable string. -.SH HOME -.sp -To find out more information please check: -\fI\%http://libmemcached.org/\fP -.SH SEE ALSO -.sp -memcached(1) libmemached(3) memcached_strerror(3) memcached_set(3) memcached_add(3) memcached_cas(3) memcached_replace(3) -.SH AUTHOR -Brian Aker -.SH COPYRIGHT -2011, Brian Aker DataDifferential, http://datadifferential.com/ -.\" Generated by docutils manpage writer. -.\" -.