summaryrefslogtreecommitdiff
path: root/docs/source/libmemcached-1.0/memcached_set_encoding_key.rst
diff options
context:
space:
mode:
Diffstat (limited to 'docs/source/libmemcached-1.0/memcached_set_encoding_key.rst')
-rw-r--r--docs/source/libmemcached-1.0/memcached_set_encoding_key.rst58
1 files changed, 58 insertions, 0 deletions
diff --git a/docs/source/libmemcached-1.0/memcached_set_encoding_key.rst b/docs/source/libmemcached-1.0/memcached_set_encoding_key.rst
new file mode 100644
index 00000000..be38b03f
--- /dev/null
+++ b/docs/source/libmemcached-1.0/memcached_set_encoding_key.rst
@@ -0,0 +1,58 @@
+==================
+Set encryption key
+==================
+
+.. index:: object: memcached_st
+
+--------
+SYNOPSIS
+--------
+
+#include <libmemcached/memcached.h>
+
+.. c:function:: void memcached_set_encoding_key (memcached_st *ptr, const char *string, const size_t string_length)
+
+Compile and link with -lmemcached
+
+-----------
+DESCRIPTION
+-----------
+
+
+:c:func:`memcached_set_encoding_key` sets the key that will be used to encrypt and decrypt data as it is sent and recieved from the server.
+
+Currently only AES is is supported.
+
+
+------
+RETURN
+------
+
+
+A value of type :c:type:`memcached_return_t` is returned On success that value
+will be :c:type:`MEMCACHED_SUCCESS`. Use :c:func:`memcached_strerror` to
+translate this value to a printable string.
+
+
+----
+HOME
+----
+
+
+To find out more information please check:
+`http://libmemcached.org/ <http://libmemcached.org/>`_
+
+
+------
+AUTHOR
+------
+
+
+Brian Aker, <brian@tangent.org>
+
+
+--------
+SEE ALSO
+--------
+
+:manpage:`memcached(1)` :manpage:`libmemcached(3)` :manpage:`memcached_strerror(3)`