Clarified return type for prefix key in cases where it is too long.

[awesomized/libmemcached] / docs / memcached_callback.pod

diff --git a/docs/memcached_callback.pod b/docs/memcached_callback.pod
index a9c0ac417b570af4f8ac5458035edf25dbdd3c42..1858302cbb487fac62be51b8eee6b29570a755d5 100755 (executable)
--- a/docs/memcached_callback.pod
+++ b/docs/memcached_callback.pod
@@ -47,6 +47,15 @@ point of its execution all connections have been closed.
 When memcached_delete() is called this function will be excuted. At the
 point of its execution all connections have been closed.
 
+=item MEMCACHED_CALLBACK_PREFIX_KEY
+
+You can set a value which will be used to create a domain for your keys.
+The value specified here will be prefixed to each of your keys. The value can not
+be greater then MEMCACHED_PREFIX_KEY_MAX_SIZE - 1 and will reduce MEMCACHED_MAX_KEY by
+the value of your key. The prefix key is only applied to the primary key,
+not the master key. MEMCACHED_FAILURE will be returned if no key is set. In the case
+of a key which is too long MEMCACHED_BAD_KEY_PROVIDED will be returned.
+
 =item MEMCACHED_CALLBACK_USER_DATA
 
 This allows you to store a pointer to a specifc piece of data. This can be