Updating to remove memory leak in functions.c (aka test cases).
[awesomized/libmemcached] / 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). It implements both
24 a modula and consistent method of object distribution.
25
26 The aim is to support multiple routing and hashing methods. Currently only
27 two hashing methods are supported, a quick built-in routine, and MD5. For
28 routing, a simple modulus method is currently used.
29
30 All operations are performed against a C<memcached_st> structure.
31 These structures can either be dynamically allocated or statically
32 allocated and then initialized by memcached_create(). Functions have been
33 written in order to encapsulate the C<memcached_st>. It is not
34 recommended that you operate directly against the structure.
35
36 Nearly all functions return a C<memcached_return> value.
37 This value can be translated to a printable string with memcached_strerr(3).
38
39 Partitioning based on keys is supported in the library. Using the key partioning
40 functions it is possible to group sets of object onto servers.
41
42 C<memcached_st> structures are thread-safe, but each thread must
43 contain its own structure (that is, if you want to share these among
44 threads you must provide your own locking). No global variables are
45 used in this library.
46
47 If you are working with GNU autotools you will want to add the following to
48 your configure.ac to properly include libmemcached in your application.
49
50 PKG_CHECK_MODULES(DEPS, libmemcached >= 0.8.0)
51 AC_SUBST(DEPS_CFLAGS)
52 AC_SUBST(DEPS_LIBS)
53
54 Some features of the library must be enabled through memcached_behavior_set().
55
56 Hope you enjoy it!
57
58 =head1 THREADS AND PROCESSES
59
60 When using threads or forked processes it is important to keep an instance
61 of C<memcached_st> per process or thread. Without creating your own locking
62 structures you can no share a single C<memcached_st>. You can though call
63 memcached_close(3) on a C<memcached_st> and then use the resulting cloned
64 structure.
65
66 =head1 HOME
67
68 To find out more information please check:
69 L<http://tangent.org/552/libmemcached.html>
70
71 =head1 AUTHOR
72
73 Brian Aker, E<lt>brian@tangent.orgE<gt>
74
75 =head1 SEE ALSO
76
77 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) memcached_get_by_key() memcached_mget_by_key()
78 =cut
79