-.TH "LIBMEMCACHED" "3" "April 07, 2011" "0.47" "libmemcached"
+.TH "LIBMEMCACHED" "3" "April 14, 2011" "0.47" "libmemcached"
.SH NAME
-libmemcached \- libmemcached Documentation
+libmemcached \- Introducing the C Client Library for memcached
.
.nr rst2man-indent-level 0
.
..
.\" Man page generated from reStructeredText.
.
-.sp
-Client library for memcached
-.SH LIBRARY
-.sp
-C Client Library for memcached (libmemcached, \-lmemcached)
.SH SYNOPSIS
.sp
-.nf
-.ft C
#include <libmemcached/memcached.h>
-.ft P
-.fi
+.sp
+Compile and link with \-lmemcached
.SH DESCRIPTION
.sp
"Memcached is a high\-performance, distributed memory object caching
Nearly all functions return a \fBmemcached_return_t\fP value.
This value can be translated to a printable string with memcached_strerror(3).
.sp
-Partitioning based on keys is supported in the library. Using the key partioning
-functions it is possible to group sets of object onto servers.
+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.
+.sp
+Group keys can be optionally used to group sets of objects with servers.
+.sp
+Namespaces are supported, and can be used to partition caches so that multiple applications can use the same memcached servers.
.sp
\fBmemcached_st\fP structures are thread\-safe, but each thread must
contain its own structure (that is, if you want to share these among
used in this library.
.sp
If you are working with GNU autotools you will want to add the following to
-your configure.ac to properly include libmemcached in your application.
+your COPYING to properly include libmemcached in your application.
.sp
PKG_CHECK_MODULES(DEPS, libmemcached >= 0.8.0)
AC_SUBST(DEPS_CFLAGS)
.SH CONSTANTS
.sp
A number of constants have been provided for in the library.
-.sp
-MEMCACHED_DEFAULT_PORT
.INDENT 0.0
-.INDENT 3.5
-.sp
+.TP
+.B MEMCACHED_DEFAULT_PORT
+.
The default port used by memcached(3).
.UNINDENT
-.UNINDENT
-.sp
-MEMCACHED_MAX_KEY
.INDENT 0.0
-.INDENT 3.5
-.sp
+.TP
+.B MEMCACHED_MAX_KEY
+.
Default maximum size of a key (which includes the null pointer). Master keys
have no limit, this only applies to keys used for storage.
.UNINDENT
-.UNINDENT
-.sp
-MEMCACHED_MAX_KEY
.INDENT 0.0
-.INDENT 3.5
-.sp
+.TP
+.B MEMCACHED_MAX_KEY
+.
Default size of key (which includes the null pointer).
.UNINDENT
-.UNINDENT
-.sp
-MEMCACHED_STRIDE
.INDENT 0.0
-.INDENT 3.5
-.sp
+.TP
+.B MEMCACHED_STRIDE
+.
This is the "stride" used in the consistent hash used between replicas.
.UNINDENT
-.UNINDENT
-.sp
-MEMCACHED_MAX_HOST_LENGTH
.INDENT 0.0
-.INDENT 3.5
-.sp
+.TP
+.B MEMCACHED_MAX_HOST_LENGTH
+.
Maximum allowed size of the hostname.
.UNINDENT
-.UNINDENT
-.sp
-MEMCACHED_VERSION_STRING
.INDENT 0.0
-.INDENT 3.5
-.sp
+.TP
+.B LIBMEMCACHED_VERSION_STRING
+.
String value of libmemcached version such as "1.23.4"
.UNINDENT
-.UNINDENT
-.sp
-MEMCACHED_MAJOR_VERSION
-.INDENT 0.0
-.INDENT 3.5
-.sp
-Major version value. Such as 1.23.4, would be 1
-.UNINDENT
-.UNINDENT
-.sp
-MEMCACHED_MINOR_VERSION
-.INDENT 0.0
-.INDENT 3.5
-.sp
-Major version value. Such as 1.23.4, would be 23
-.UNINDENT
-.UNINDENT
-.sp
-MEMCACHED_MICRO_VERSION
.INDENT 0.0
-.INDENT 3.5
-.sp
-Major version value. Such as 1.23.4, would be 4
-.UNINDENT
+.TP
+.B LIBMEMCACHED_VERSION_HEX
+.
+Hex value of the version number. "0x00048000" This can be used for comparing versions based on number.
.UNINDENT
.SH THREADS AND PROCESSES
.sp
.SH HOME
.sp
To find out more information please check:
-\fI\%https://launchpad.net/libmemcached\fP
-.SH AUTHOR
-.sp
-Brian Aker, <\fI\%brian@tangent.org\fP>
+\fI\%http://libmemcached.org/\fP
.SH SEE ALSO
.sp
-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)
+\fImemcached(1)\fP \fIlibmemcached_examples(3)\fP
+\fIlibmemcached(1)\fP \fImemcat(1)\fP \fImemcp(1)\fP
+\fImemflush(1)\fP \fImemrm(1)\fP \fImemslap(1)\fP
+\fImemstat(1)\fP \fImemcached_fetch(3)\fP
+\fImemcached_replace(3)\fP \fImemcached_server_list_free(3)\fP
+\fIlibmemcached_examples(3)\fP \fImemcached_clone(3)\fP
+\fImemcached_free(3)\fP \fImemcached_server_add(3)\fP
+\fImemcached_server_push(3)\fP \fImemcached_add(3)\fP
+\fImemcached_get(3)\fP \fImemcached_server_count(3)\fP
+\fImemcached_create(3)\fP \fImemcached_increment(3)\fP
+\fImemcached_server_list(3)\fP \fImemcached_set(3)\fP
+\fImemcached_decrement(3)\fP \fImemcached_mget(3)\fP
+\fImemcached_server_list_append(3)\fP \fImemcached_strerror(3)\fP
+\fImemcached_delete(3)\fP \fImemcached_quit(3)\fP
+\fImemcached_server_list_count(3)\fP \fImemcached_verbosity(3)\fP
+\fImemcached_server_add_unix_socket(3)\fP
+\fImemcached_result_create(3)\fP \fImemcached_result_free(3)\fP
+\fImemcached_result_key_value(3)\fP
+\fImemcached_result_key_length(3)\fP
+\fImemcached_result_value(3)\fP \fImemcached_result_length(3)\fP
+\fImemcached_result_flags(3)\fP \fImemcached_result_cas(3)\fP
+\fImemcached_result_st(3)\fP \fImemcached_append(3)\fP
+\fImemcached_prepend(3)\fP \fImemcached_fetch_result(3)\fP
+\fImemerror(1)\fP \fImemcached_get_by_key(3)\fP
+\fImemcached_mget_by_key(3)\fP \fImemcached_delete_by_key(3)\fP
+\fImemcached_fetch_execute(3)\fP \fImemcached_callback_get(3)\fP
+\fImemcached_callback_set(3)\fP \fImemcached_version(3)\fP
+\fImemcached_lib_version(3)\fP \fImemcached_result_set_value(3)\fP
+\fImemcached_dump(3)\fP \fImemdump(1)\fP
+\fImemcached_set_memory_allocators(3)\fP
+\fImemcached_get_memory_allocators(3)\fP
+\fImemcached_get_user_data(3)\fP \fImemcached_set_user_data(3)\fP
.SH AUTHOR
Brian Aker
.SH COPYRIGHT
-2011, Brian Aker
+2011, Brian Aker DataDifferential, http://datadifferential.com/
.\" Generated by docutils manpage writer.
.\"
.
projects / m6w6 / libmemcached / blobdiff