Merge Trond.
[m6w6/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 There are multiple implemented routing and hashing methods. See the
27 memcached_behavior_set() manpage.
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_strerror(3).
37
38 Partitioning based on keys is supported in the library. Using the key partioning
39 functions it is possible to group sets of object onto servers.
40
41 C<memcached_st> structures are thread-safe, but each thread must
42 contain its own structure (that is, if you want to share these among
43 threads you must provide your own locking). No global variables are
44 used in this library.
45
46 If you are working with GNU autotools you will want to add the following to
47 your configure.ac to properly include libmemcached in your application.
48
49 PKG_CHECK_MODULES(DEPS, libmemcached >= 0.8.0)
50 AC_SUBST(DEPS_CFLAGS)
51 AC_SUBST(DEPS_LIBS)
52
53 Some features of the library must be enabled through memcached_behavior_set().
54
55 Hope you enjoy it!
56
57 =head1 CONSTANTS
58
59 A number of constants have been provided for in the library.
60
61 =over 4
62
63 =item MEMCACHED_DEFAULT_PORT
64
65 The default port used by memcached(3).
66
67 =item MEMCACHED_MAX_KEY
68
69 Default maximum size of a key (which includes the null pointer). Master keys
70 have no limit, this only applies to keys used for storage.
71
72 =item MEMCACHED_MAX_KEY
73
74 Default size of key (which includes the null pointer).
75
76 =item MEMCACHED_STRIDE
77
78 This is the "stride" used in the consistent hash used between replicas.
79
80 =item MEMCACHED_MAX_HOST_LENGTH
81
82 Maximum allowed size of the hostname.
83
84 =item MEMCACHED_VERSION_STRING
85
86 String value of libmemcached version such as "1.23.4"
87
88 =item MEMCACHED_MAJOR_VERSION
89
90 Major version value. Such as 1.23.4, would be 1
91
92 =item MEMCACHED_MINOR_VERSION
93
94 Major version value. Such as 1.23.4, would be 23
95
96 =item MEMCACHED_MICRO_VERSION
97
98 Major version value. Such as 1.23.4, would be 4
99
100
101 =back
102
103
104
105 =head1 THREADS AND PROCESSES
106
107 When using threads or forked processes it is important to keep an instance
108 of C<memcached_st> per process or thread. Without creating your own locking
109 structures you can not share a single C<memcached_st>. You can though call
110 memcached_quit(3) on a C<memcached_st> and then use the resulting cloned
111 structure.
112
113 =head1 HOME
114
115 To find out more information please check:
116 L<http://tangent.org/552/libmemcached.html>
117
118 =head1 AUTHOR
119
120 Brian Aker, E<lt>brian@tangent.orgE<gt>
121
122 =head1 SEE ALSO
123
124 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) memcached_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(3) memcached_mget_by_key(3) memcached_delete_by_key(3) memcached_fetch_execute(3) memcached_callback_get(3) memcached_callback_set(3) memcached_version(3) memcached_lib_version(3) memcached_result_set_value(3) memcached_dump(3) memdump(1) memcached_set_memory_allocators(3) memcached_get_memory_allocators(3) memcached_get_user_data(3) memcached_set_user_data(3)
125
126 =cut
127