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." (http://danga.com/memcached/)
  18
  19 libmemcached has the aim of being a small, thread safe client library for
  20 memcached. The code has all been written with an eye to allow for both web
  21 and embedded usage. It handles the work behind route particular keys to
  22 specifc servers that you specify (and values are matched based on server
  23 order as supplied by you). See more about this via X.
  24
  25 The aim is to support multiple routing and hashing methods. Currently only
  26 two hashing methods are supported, a built quick routine, and MD5. For
  27 routing a simple modulous method is used currently.
  28
  29 All operations are performance against memcached_st structure. These
  30 can either be dynamically allocated or statically allocated and initializd
  31 by memcached_create(3). Functions have been written in order to encapsulate
  32 the memcached_st (it is not recommended that you operate directly against
  33 the structure).
  34
  35 Nearly all functions return a memcached_return value. This is documented in
  36 memcached_strerr(3).
  37
  38 memcached_st structures are thread safe, but each thread must contain its own structure (aka if you want to share these among threads you must provide your own locking). No global variables are used in this library.
  39
  40 Some features of the library must be enabled through memcached_behavior_set(3).
  41 Hope you enjoy it!
  42
  43
  44 =head1 HOME
  45
  46 To find out more information please check: http://tangent.org/552/libmemcached.html
  47
  48 =head1 AUTHOR
  49
  50 Brian Aker, brian@tangent.org
  51
  52 =head1 SEE ALSO
  53
  54 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_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)
  55
  56 =cut
  57