git.m6w6.name Git - m6w6/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 libMemcached is an open source C/C++ client library and tools for the memcached server (http://danga.com/memcached). It has been designed to be light on memory usage, thread safe, and provide full access to server side methods.
  14
  15 libMemcached was designed to provide the greatest number of options to use Memcached. Some of the features provided:
  16
  17 1. Asynchronous and Synchronous Transport Support.
  18 2. Consistent Hashing and Distribution.
  19 3. Tunable Hashing algorithm to match keys.
  20 4. Access to large object support.
  21 5. Local replication.
  22 6. A complete reference guide and documentation to the API.
  23 7. Tools to Manage your Memcached networks.
  24
  25 -----------
  26 DESCRIPTION
  27 -----------
  28
  29
  30 "Memcached is a high-performance, distributed memory object caching
  31 system, generic in nature, but intended for use in speeding up dynamic web
  32 applications by alleviating database load." `http://danga.com/memcached/ <http://danga.com/memcached/>`_
  33
  34 \ **libmemcached**\  is a small, thread-safe client library for the
  35 memcached protocol. The code has all been written to allow
  36 for both web and embedded usage. It handles the work behind routing
  37 individual keys to specific servers specified by the developer (and values are
  38 matched based on server order as supplied by the user). It implements
  39 a modular and consistent method of object distribution.
  40
  41 There are multiple implemented routing and hashing methods. See the
  42 memcached_behavior_set() manpage for more information.
  43
  44 All operations are performed against a \ ``memcached_st``\  structure.
  45 These structures can either be dynamically allocated or statically
  46 allocated and then initialized by memcached_create(). Functions have been
  47 written in order to encapsulate the \ ``memcached_st``\ . It is not
  48 recommended that you operate directly against the structure.
  49
  50 Nearly all functions return a \ ``memcached_return_t``\  value.
  51 This value can be translated to a printable string with memcached_strerror(3).
  52
  53 Objects are stored on servers by hashing keys. The hash value maps the key to a particular server. All clients understand how this hashing works, so it is possibly to reliably both push data to a server and retrieve data from a server.
  54
  55 Group keys can be optionally used to group sets of objects with servers.
  56
  57 Namespaces are supported, and can be used to partition caches so that multiple applications can use the same memcached servers.
  58
  59 \ ``memcached_st``\  structures are thread-safe, but each thread must
  60 contain its own structure (that is, if you want to share these among
  61 threads you must provide your own locking). No global variables are
  62 used in this library.
  63
  64 If you are working with GNU autotools you will want to add the following to
  65 your COPYING to properly include libmemcached in your application.
  66
  67 PKG_CHECK_MODULES(DEPS, libmemcached >= 0.8.0)
  68 AC_SUBST(DEPS_CFLAGS)
  69 AC_SUBST(DEPS_LIBS)
  70
  71 Some features of the library must be enabled through memcached_behavior_set().
  72
  73 Hope you enjoy it!
  74
  75
  76 ---------
  77 CONSTANTS
  78 ---------
  79
  80
  81 A number of constants have been provided for in the library.
  82
  83
  84 .. c:var:: MEMCACHED_DEFAULT_PORT
  85
  86  The default port used by memcached(3).
  87
  88
  89
  90 .. c:var:: MEMCACHED_MAX_KEY
  91
  92  Default maximum size of a key (which includes the null pointer). Master keys
  93  have no limit, this only applies to keys used for storage.
  94
  95
  96
  97 .. c:var:: MEMCACHED_MAX_KEY
  98
  99  Default size of key (which includes the null pointer).
 100
 101
 102
 103 .. c:var:: MEMCACHED_STRIDE
 104
 105  This is the "stride" used in the consistent hash used between replicas.
 106
 107
 108
 109 .. c:var:: MEMCACHED_MAX_HOST_LENGTH
 110
 111  Maximum allowed size of the hostname.
 112
 113
 114 .. c:var:: LIBMEMCACHED_VERSION_STRING
 115
 116  String value of libmemcached version such as "1.23.4"
 117
 118
 119 .. c:var:: LIBMEMCACHED_VERSION_HEX
 120
 121  Hex value of the version number. "0x00048000" This can be used for comparing versions based on number.
 122
 123
 124
 125
 126 ---------------------
 127 THREADS AND PROCESSES
 128 ---------------------
 129
 130
 131 When using threads or forked processes it is important to keep one instance
 132 of \ ``memcached_st``\  per process or thread. Without creating your own locking
 133 structures you can not share a single \ ``memcached_st``\ . However, you can call
 134 memcached_quit(3) on a \ ``memcached_st``\  and then use the resulting cloned
 135 structure.
 136
 137
 138 ----
 139 HOME
 140 ----
 141
 142
 143 To find out more information please check:
 144 `http://libmemcached.org/ <http://libmemcached.org/>`_
 145
 146
 147 --------
 148 SEE ALSO
 149 --------
 150
 151
 152 :manpage:`memcached(1)` :manpage:`libmemcached_examples(3)`
 153 :manpage:`libmemcached(1)` :manpage:`memcat(1)` :manpage:`memcp(1)`
 154 :manpage:`memflush(1)` :manpage:`memrm(1)` :manpage:`memslap(1)`
 155 :manpage:`memstat(1)` :manpage:`memcached_fetch(3)`
 156 :manpage:`memcached_replace(3)` :manpage:`memcached_server_list_free(3)`
 157 :manpage:`libmemcached_examples(3)` :manpage:`memcached_clone(3)`
 158 :manpage:`memcached_free(3)` :manpage:`memcached_server_add(3)`
 159 :manpage:`memcached_server_push(3)` :manpage:`memcached_add(3)`
 160 :manpage:`memcached_get(3)` :manpage:`memcached_server_count(3)`
 161 :manpage:`memcached_create(3)` :manpage:`memcached_increment(3)`
 162 :manpage:`memcached_server_list(3)` :manpage:`memcached_set(3)`
 163 :manpage:`memcached_decrement(3)` :manpage:`memcached_mget(3)`
 164 :manpage:`memcached_server_list_append(3)` :manpage:`memcached_strerror(3)`
 165 :manpage:`memcached_delete(3)` :manpage:`memcached_quit(3)`
 166 :manpage:`memcached_server_list_count(3)` :manpage:`memcached_verbosity(3)`
 167 :manpage:`memcached_server_add_unix_socket(3)`
 168 :manpage:`memcached_result_create(3)`  :manpage:`memcached_result_free(3)`
 169 :manpage:`memcached_result_key_value(3)`
 170 :manpage:`memcached_result_key_length(3)`
 171 :manpage:`memcached_result_value(3)`  :manpage:`memcached_result_length(3)`
 172 :manpage:`memcached_result_flags(3)`  :manpage:`memcached_result_cas(3)`
 173 :manpage:`memcached_result_st(3)` :manpage:`memcached_append(3)`
 174 :manpage:`memcached_prepend(3)` :manpage:`memcached_fetch_result(3)`
 175 :manpage:`memerror(1)` :manpage:`memcached_get_by_key(3)`
 176 :manpage:`memcached_mget_by_key(3)` :manpage:`memcached_delete_by_key(3)`
 177 :manpage:`memcached_fetch_execute(3)` :manpage:`memcached_callback_get(3)`
 178 :manpage:`memcached_callback_set(3)` :manpage:`memcached_version(3)`
 179 :manpage:`memcached_lib_version(3)` :manpage:`memcached_result_set_value(3)`
 180 :manpage:`memcached_dump(3)` :manpage:`memdump(1)`
 181 :manpage:`memcached_set_memory_allocators(3)`
 182 :manpage:`memcached_get_memory_allocators(3)`
 183 :manpage:`memcached_get_user_data(3)` :manpage:`memcached_set_user_data(3)`