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

   1 ==============================================
   2 Introducing the C Client Library for memcached
   3 ==============================================
   4
   5 --------
   6 SYNOPSIS
   7 --------
   8
   9 #include <libmemcached/memcached.h>
  10
  11 Compile and link with -lmemcached
  12
  13
  14 -----------
  15 DESCRIPTION
  16 -----------
  17
  18
  19 "Memcached is a high-performance, distributed memory object caching
  20 system, generic in nature, but intended for use in speeding up dynamic web
  21 applications by alleviating database load." `http://danga.com/memcached/ <http://danga.com/memcached/>`_
  22
  23 \ **libmemcached**\  is a small, thread-safe client library for the
  24 memcached protocol. The code has all been written with an eye to allow
  25 for both web and embedded usage. It handles the work behind routing
  26 particular keys to specific servers that you specify (and values are
  27 matched based on server order as supplied by you). It implements both
  28 a modula and consistent method of object distribution.
  29
  30 There are multiple implemented routing and hashing methods. See the
  31 memcached_behavior_set() manpage.
  32
  33 All operations are performed against a \ ``memcached_st``\  structure.
  34 These structures can either be dynamically allocated or statically
  35 allocated and then initialized by memcached_create(). Functions have been
  36 written in order to encapsulate the \ ``memcached_st``\ . It is not
  37 recommended that you operate directly against the structure.
  38
  39 Nearly all functions return a \ ``memcached_return_t``\  value.
  40 This value can be translated to a printable string with memcached_strerror(3).
  41
  42 Partitioning based on keys is testsed in the library. Using the key partioning
  43 functions it is possible to group sets of object onto servers.
  44
  45 \ ``memcached_st``\  structures are thread-safe, but each thread must
  46 contain its own structure (that is, if you want to share these among
  47 threads you must provide your own locking). No global variables are
  48 used in this library.
  49
  50 If you are working with GNU autotools you will want to add the following to
  51 your COPYING to properly include libmemcached in your application.
  52
  53 PKG_CHECK_MODULES(DEPS, libmemcached >= 0.8.0)
  54 AC_SUBST(DEPS_CFLAGS)
  55 AC_SUBST(DEPS_LIBS)
  56
  57 Some features of the library must be enabled through memcached_behavior_set().
  58
  59 Hope you enjoy it!
  60
  61
  62 ---------
  63 CONSTANTS
  64 ---------
  65
  66
  67 A number of constants have been provided for in the library.
  68
  69
  70 .. c:var:: MEMCACHED_DEFAULT_PORT
  71
  72  The default port used by memcached(3).
  73
  74
  75
  76 .. c:var:: MEMCACHED_MAX_KEY
  77
  78  Default maximum size of a key (which includes the null pointer). Master keys
  79  have no limit, this only applies to keys used for storage.
  80
  81
  82
  83 .. c:var:: MEMCACHED_MAX_KEY
  84
  85  Default size of key (which includes the null pointer).
  86
  87
  88
  89 .. c:var:: MEMCACHED_STRIDE
  90
  91  This is the "stride" used in the consistent hash used between replicas.
  92
  93
  94
  95 .. c:var:: MEMCACHED_MAX_HOST_LENGTH
  96
  97  Maximum allowed size of the hostname.
  98
  99
 100 .. c:var:: LIBMEMCACHED_VERSION_STRING
 101
 102  String value of libmemcached version such as "1.23.4"
 103
 104
 105 .. c:var:: LIBMEMCACHED_VERSION_HEX
 106
 107  Hex value of the version number. "0x00048000" This can be used for comparing versions based on number.
 108
 109
 110
 111
 112 ---------------------
 113 THREADS AND PROCESSES
 114 ---------------------
 115
 116
 117 When using threads or forked processes it is important to keep an instance
 118 of \ ``memcached_st``\  per process or thread. Without creating your own locking
 119 structures you can not share a single \ ``memcached_st``\ . You can though call
 120 memcached_quit(3) on a \ ``memcached_st``\  and then use the resulting cloned
 121 structure.
 122
 123
 124 ----
 125 HOME
 126 ----
 127
 128
 129 To find out more information please check:
 130 `https://launchpad.net/libmemcached <https://launchpad.net/libmemcached>`_
 131
 132
 133 --------
 134 SEE ALSO
 135 --------
 136
 137
 138 :manpage:`memcached(1)` :manpage:`libmemcached_examples(3)` :manpage:`libmemcached(1)` :manpage:`memcat(1)` :manpage:`memcp(1)` :manpage:`memflush(1)` :manpage:`memrm(1)` :manpage:`memslap(1)` :manpage:`memstat(1)` :manpage:`memcached_fetch(3)` :manpage:`memcached_replace(3)` :manpage:`memcached_server_list_free(3)` :manpage:`libmemcached_examples(3)` :manpage:`memcached_clone(3)` :manpage:`memcached_free(3)`
 139 :manpage:`memcached_server_add(3)` :manpage:`memcached_server_push(3)` :manpage:`memcached_add(3)` :manpage:`memcached_get(3)` :manpage:`memcached_server_count(3)` :manpage:`memcached_servers_parse(3)` :manpage:`memcached_create(3)` :manpage:`memcached_increment(3)` :manpage:`memcached_server_list(3)` :manpage:`memcached_set(3)`
 140 :manpage:`memcached_decrement(3)` :manpage:`memcached_mget(3)` :manpage:`memcached_server_list_append(3)` :manpage:`memcached_strerror(3)` :manpage:`memcached_delete(3)` :manpage:`memcached_quit(3)` :manpage:`memcached_server_list_count(3)` :manpage:`memcached_verbosity(3)` :manpage:`memcached_server_add_unix_socket(3)` :manpage:`memcached_result_create(3)`  :manpage:`memcached_result_free(3)`
 141 :manpage:`memcached_result_key_value(3)`  :manpage:`memcached_result_key_length(3)`  :manpage:`memcached_result_value(3)`  :manpage:`memcached_result_length(3)`  :manpage:`memcached_result_flags(3)`
 142 :manpage:`memcached_result_cas(3)` :manpage:`memcached_result_st(3)` :manpage:`memcached_append(3)` :manpage:`memcached_prepend(3)` :manpage:`memcached_fetch_result(3)`
 143 :manpage:`memerror(1)` :manpage:`memcached_get_by_key(3)` :manpage:`memcached_mget_by_key(3)` :manpage:`memcached_delete_by_key(3)`
 144 :manpage:`memcached_fetch_execute(3)` :manpage:`memcached_callback_get(3)` :manpage:`memcached_callback_set(3)` :manpage:`memcached_version(3)`
 145 :manpage:`memcached_lib_version(3)` :manpage:`memcached_result_set_value(3)` :manpage:`memcached_dump(3)` :manpage:`memdump(1)`
 146 :manpage:`memcached_set_memory_allocators(3)` :manpage:`memcached_get_memory_allocators(3)` :manpage:`memcached_get_user_data(3)` :manpage:`memcached_set_user_data(3)`