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

   1 =======================================================
   2 Getting version information about the client and server
   3 =======================================================
   4
   5
   6 Get library version
   7
   8
   9 *******
  10 LIBRARY
  11 *******
  12
  13
  14 C Client Library for memcached (libmemcached, -lmemcached)
  15
  16
  17 --------
  18 SYNOPSIS
  19 --------
  20
  21
  22
  23 .. code-block:: perl
  24
  25    #include <libmemcached/memcached.h>
  26
  27    const char *
  28      memcached_lib_version (void)
  29
  30
  31    memcached_return_t
  32      memcached_version (memcached_st *ptr)
  33
  34
  35
  36 -----------
  37 DESCRIPTION
  38 -----------
  39
  40
  41 memcached_lib_version() is used to return a simple version string representing
  42 the libmemcached version (client library version, not server version)
  43
  44 memcached_version() is used to set the major, minor, and micro versions of each
  45 memcached server being used by the memcached_st connection structure. It returns the
  46 memcached server return code.
  47
  48
  49 ******
  50 RETURN
  51 ******
  52
  53
  54 A string with the version of libmemcached driver is returned from
  55 memcached_lib_version()
  56
  57 A value of type \ ``memcached_return_t``\  is returned from memcached_version()
  58 On success that value will be \ ``MEMCACHED_SUCCESS``\ . If called with the
  59 \ ``MEMCACHED_BEHAVIOR_USE_UDP``\  behavior set, the value \ ``MEMCACHED_NOT_SUPPORTED``\
  60 will be returned. Use memcached_strerror() to translate this value to
  61 a printable string.
  62
  63
  64 ****
  65 HOME
  66 ****
  67
  68
  69 To find out more information please check:
  70 `http://libmemcached.org/ <http://libmemcached.org/>`_
  71
  72
  73 ******
  74 AUTHOR
  75 ******
  76
  77
  78 Brian Aker, <brian@tangent.org>
  79
  80
  81 --------
  82 SEE ALSO
  83 --------
  84
  85
  86 memcached(1) libmemcached(3) memcached_strerror(3)
  87