git.m6w6.name Git - awesomized/libmemcached/blob - docs/source/libmemcached/memcached_set_encoding_key.rst

   1 Set encryption key
   2 ==================
   3
   4 .. index:: object: memcached_st
   5
   6 SYNOPSIS
   7 --------
   8
   9 #include <libmemcached/memcached.h>
  10
  11 .. function:: void memcached_set_encoding_key (memcached_st *ptr, const char *string, const size_t string_length)
  12
  13 Compile and link with -lmemcached
  14
  15 DESCRIPTION
  16 -----------
  17
  18 :func:`memcached_set_encoding_key` sets the key that will be used to encrypt and decrypt data as it is sent and received from the server.
  19
  20 Currently only AES is is supported.
  21
  22 RETURN VALUE
  23 ------------
  24
  25 A value of type :type:`memcached_return_t` is returned On success that value
  26 will be `MEMCACHED_SUCCESS`.  Use :func:`memcached_strerror` to
  27 translate this value to a printable string.
  28
  29 SEE ALSO
  30 --------
  31
  32 .. only:: man
  33
  34   :manpage:`memcached(1)` :manpage:`libmemcached(3)` :manpage:`memcached_strerror(3)`