X-Git-Url: https://git.m6w6.name/?a=blobdiff_plain;f=docs%2Fman%2Fmemcached_cas.3;h=134823c82301130cc7b220e6ce808769623da688;hb=38c7c4e5444881eee8f76c6050e146c137c3781e;hp=2f3554e93fff530e7a4ee3e25db1a2b786ca5fe9;hpb=c87f1a554cce74ac1ba3d4e7e9c2a1d2904e4766;p=m6w6%2Flibmemcached diff --git a/docs/man/memcached_cas.3 b/docs/man/memcached_cas.3 index 2f3554e9..e7702707 100644 --- a/docs/man/memcached_cas.3 +++ b/docs/man/memcached_cas.3 @@ -1,4 +1,4 @@ -.TH "MEMCACHED_CAS" "3" "June 17, 2011" "0.49" "libmemcached" +.TH "MEMCACHED_CAS" "3" "July 11, 2012" "1.0.9" "libmemcached" .SH NAME memcached_cas \- Working with data on the server in an atomic fashion . @@ -35,53 +35,53 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] #include .INDENT 0.0 .TP -.B memcached_return_t memcached_cas(memcached_st *ptr, const char *key, size_t key_length, const char *value, size_t value_length, time_t expiration, uint32_t flags, uint64_t cas); +.B memcached_return_t memcached_cas(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, uint64_t\fI\ cas\fP) .UNINDENT .INDENT 0.0 .TP -.B memcached_return_t memcached_cas_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, uint64_t cas); +.B memcached_return_t memcached_cas_by_key(memcached_st\fI\ *ptr\fP, const char\fI\ *group_key\fP, size_t\fI\ group_key_length\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, uint64_t\fI\ cas\fP) .UNINDENT .sp Compile and link with \-lmemcached .SH DESCRIPTION .sp -memcached_cas() overwrites data in the server as long as the "cas" value is -still the same in the server. You can get the cas value of a result by -calling memcached_result_cas() on a memcached_result_st(3) structure. At the point -that this note was written cas is still buggy in memached. Turning on tests -for it in libmemcached(3) is optional. Please see memcached_set() for -information on how to do this. +\fI\%memcached_cas()\fP overwrites data in the server as long as the "cas" +value is still the same in the server. You can get the cas value of a result +by calling \fBmemcached_result_cas()\fP on a memcached_result_st(3) +structure. At the point that this note was written cas is still buggy in memached. Turning on tests for it in libmemcached(3) is optional. Please see +\fBmemcached_set()\fP for information on how to do this. .sp -memcached_cas_by_key() method behaves in a similar method as the non key -methods. The difference is that it uses the group_key parameter to map -objects to particular servers. +\fI\%memcached_cas_by_key()\fP method behaves in a similar method as the non +key methods. The difference is that it uses the group_key parameter +to map objects to particular servers. .sp -memcached_cas() is 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. +\fI\%memcached_cas()\fP is testsed with the \fBMEMCACHED_BEHAVIOR_USE_UDP\fP behavior 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, +\fBMEMCACHED_BEHAVIOR_BINARY_PROTOCOL\fP, 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\fP will 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. +Use \fBmemcached_strerror()\fP 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_append(3) memcached_add(3) memcached_prepend(3) memcached_replace(3) +\fImemcached(1)\fP \fIlibmemached(3)\fP \fImemcached_strerror(3)\fP \fImemcached_set(3)\fP \fImemcached_append(3)\fP \fImemcached_add(3)\fP \fImemcached_prepend(3)\fP \fImemcached_replace(3)\fP .SH AUTHOR Brian Aker .SH COPYRIGHT