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

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