X-Git-Url: https://git.m6w6.name/?a=blobdiff_plain;f=docs%2Fmemcached_set.pod;h=dadb9d2bb53e37afa6e51b5f9c248daa2e578521;hb=bbd526419742d4a9bb99fcb1a56a80969ebe90fb;hp=6e962d382ea6522037fb6cc20d67139e96d5e8ff;hpb=f626f20a53bc94fd8a206b7c49af9d0ef9840f24;p=awesomized%2Flibmemcached diff --git a/docs/memcached_set.pod b/docs/memcached_set.pod old mode 100755 new mode 100644 index 6e962d38..dadb9d2b --- a/docs/memcached_set.pod +++ b/docs/memcached_set.pod @@ -1,6 +1,6 @@ =head1 NAME -memcached_set, memcached_add, memcached_replace +memcached_set, memcached_add, memcached_replace - Store value on server =head1 LIBRARY @@ -12,91 +12,91 @@ C Client Library for memcached (libmemcached, -lmemcached) memcached_return memcached_set (memcached_st *ptr, - char *key, size_t key_length, - char *value, size_t value_length, + const char *key, size_t key_length, + const char *value, size_t value_length, time_t expiration, uint32_t flags); memcached_return memcached_add (memcached_st *ptr, - char *key, size_t key_length, - char *value, size_t value_length, + const char *key, size_t key_length, + const char *value, size_t value_length, time_t expiration, uint32_t flags); memcached_return memcached_replace (memcached_st *ptr, - char *key, size_t key_length, - char *value, size_t value_length, + const char *key, size_t key_length, + const char *value, size_t value_length, time_t expiration, uint32_t flags); memcached_return memcached_prepend(memcached_st *ptr, - char *key, size_t key_length, - char *value, size_t value_length, + const char *key, size_t key_length, + const char *value, size_t value_length, time_t expiration, uint32_t flags) memcached_return memcached_append(memcached_st *ptr, - char *key, size_t key_length, - char *value, size_t value_length, + const char *key, size_t key_length, + const char *value, size_t value_length, time_t expiration, uint32_t flags) memcached_return memcached_cas(memcached_st *ptr, - char *key, size_t key_length, - char *value, size_t value_length, + const char *key, size_t key_length, + const char *value, size_t value_length, time_t expiration, uint32_t flags, uint64_t cas); memcached_return memcached_set_by_key(memcached_st *ptr, - char *master_key, size_t master_key_length, - char *key, size_t key_length, - char *value, size_t value_length, + const char *master_key, size_t master_key_length, + const char *key, size_t key_length, + const char *value, size_t value_length, time_t expiration, uint32_t flags); memcached_return memcached_add_by_key(memcached_st *ptr, - char *master_key, size_t master_key_length, - char *key, size_t key_length, - char *value, size_t value_length, + const char *master_key, size_t master_key_length, + const char *key, size_t key_length, + const char *value, size_t value_length, time_t expiration, uint32_t flags); memcached_return memcached_replace_by_key(memcached_st *ptr, - char *master_key, size_t master_key_length, - char *key, size_t key_length, - char *value, size_t value_length, + const char *master_key, size_t master_key_length, + const char *key, size_t key_length, + const char *value, size_t value_length, time_t expiration, uint32_t flags); memcached_return memcached_prepend_by_key(memcached_st *ptr, - char *master_key, size_t master_key_length, - char *key, size_t key_length, - char *value, size_t value_length, + const char *master_key, size_t master_key_length, + const char *key, size_t key_length, + const char *value, size_t value_length, time_t expiration, uint32_t flags); memcached_return memcached_append_by_key(memcached_st *ptr, - char *master_key, size_t master_key_length, - char *key, size_t key_length, - char *value, size_t value_length, + const char *master_key, size_t master_key_length, + const char *key, size_t key_length, + const char *value, size_t value_length, time_t expiration, uint32_t flags); memcached_return memcached_cas_by_key(memcached_st *ptr, - char *master_key, size_t master_key_length, - char *key, size_t key_length, - char *value, size_t value_length, + const char *master_key, size_t master_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); @@ -143,6 +143,24 @@ objects to particular servers. If you are looking for performance, memcached_set() with non-blocking IO is the fastest way to store data on the server. +All of the above functions are supported with the C +behavior enabled. But 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 Memcahed 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, C< MEMCACHED_BEHAVIOR_BINARY_PROTOCOL>, +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 C +will be returned. + + =head1 RETURN All methods return a value of type C.