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

   1 =head1 NAME
   2
   3 libmemcached - Client library for memcached
   4
   5 =head1 LIBRARY
   6
   7 C Client Library for memcached (libmemcached, -lmemcached)
   8
   9 =head1 SYNOPSIS
  10
  11   #include <memcached.h>
  12
  13 =head1 DESCRIPTION
  14
  15 "Memcached is a high-performance, distributed memory object caching
  16 system, generic in nature, but intended for use in speeding up dynamic web
  17 applications by alleviating database load." L<http://danga.com/memcached/>
  18
  19 B<libmemcached> is a small, thread-safe client library for the
  20 memcached protocol. The code has all been written with an eye to allow
  21 for both web and embedded usage. It handles the work behind routing
  22 particular keys to specific servers that you specify (and values are
  23 matched based on server order as supplied by you).
  24
  25 The aim is to support multiple routing and hashing methods. Currently only
  26 two hashing methods are supported, a quick built-in routine, and MD5. For
  27 routing, a simple modulus method is currently used.
  28
  29 All operations are performed against a C<memcached_st> structure.
  30 These structures can either be dynamically allocated or statically
  31 allocated and then initialized by memcached_create(). Functions have been
  32 written in order to encapsulate the C<memcached_st>. It is not
  33 recommended that you operate directly against the structure.
  34
  35 Nearly all functions return a C<memcached_return> value.
  36 This value can be translated to a printable string with memcached_strerr(3).
  37
  38 C<memcached_st> structures are thread-safe, but each thread must
  39 contain its own structure (that is, if you want to share these among
  40 threads you must provide your own locking). No global variables are
  41 used in this library.
  42
  43 If you are working with GNU autotools you will want to add the following to
  44 your configure.ac to properly include libmemcached in your application.
  45
  46 PKG_CHECK_MODULES(DEPS, libmemcached >= 0.8.0)
  47 AC_SUBST(DEPS_CFLAGS)
  48 AC_SUBST(DEPS_LIBS)
  49
  50 Some features of the library must be enabled through memcached_behavior_set().
  51
  52 Hope you enjoy it!
  53
  54 =head1 THREADS AND PROCESSES
  55
  56 When using threads or forked processes it is important to keep an instance
  57 of C<memcached_st> per process or thread. Without creating your own locking
  58 structures you can no share a single C<memcached_st>. You can though call
  59 memcached_close(3) on a C<memcached_st> and then use the resulting cloned
  60 structure.
  61
  62 =head1 HOME
  63
  64 To find out more information please check:
  65 L<http://tangent.org/552/libmemcached.html>
  66
  67 =head1 AUTHOR
  68
  69 Brian Aker, E<lt>brian@tangent.orgE<gt>
  70
  71 =head1 SEE ALSO
  72
  73 memcached(1) libmemcached_examples(3) libmemcached(1) memcat(1) memcp(1) memflush(1) memrm(1) memslap(1) memstat(1) memcached_fetch(3) memcached_replace(3) memcached_server_list_free(3) libmemcached_examples(3) memcached_clone(3) memcached_free(3) memcached_server_add(3) memcached_server_push(3) memcached_add(3) memcached_get(3) memcached_server_count(3) memcached_servers_parse(3) memcached_create(3) memcached_increment(3) memcached_server_list(3) memcached_set(3) memcached_decrement(3) memcached_mget(3) memcached_server_list_append(3) memcached_strerror(3) memcached_delete(3) memcached_quit(3) memcached_server_list_count(3) memcached_verbosity(3) memcached_server_add_unix_socket(3) memcahed_result_create(3)  memcached_result_free(3)  memcached_result_key_value(3)  memcached_result_key_length(3)  memcached_result_value(3)  memcached_result_length(3)  memcached_result_flags(3)  memcached_result_cas(3) memcached_result_st(3) memcached_append(3) memcached_prepend(3) memcached_fetch_result(3) memerror(1)
  74 =cut
  75