# General information about the project.
project = u'libmemcached'
-copyright = u'2011, Brian Aker'
+copyright = u'2011, Brian Aker DataDifferential, http://datadifferential.com/'
# The version info for the project you're documenting, acts as replacement for
# |version| and |release|, also used in various other places throughout the
# One entry per manual page. List of tuples
# (source start file, name, description, authors, manual section).
man_pages = [
+ ('libhashkit', 'libhashkit', u'libhashkit Documentation', [u'Brian Aker'], 3),
('hashkit_create', 'hashkit_clone', u'libhashkit Documentation', [u'Brian Aker'], 3),
('hashkit_create', 'hashkit_create', u'libhashkit Documentation', [u'Brian Aker'], 3),
('hashkit_create', 'hashkit_free', u'libhashkit Documentation', [u'Brian Aker'], 3),
# All paths should be given relative to the root
EXTRA_DIST+= \
+ docs/_static \
+ docs/_templates \
+ docs/conf.py \
docs/hashkit_clone.rst \
docs/hashkit_crc32.rst \
docs/hashkit_create.rst \
docs/hashkit_murmur.rst \
docs/hashkit_value.rst \
docs/index.rst \
- docs/libmemcached_examples.rst \
+ docs/libhashkit.rst \
docs/libmemcached.rst \
+ docs/libmemcached_examples.rst \
docs/libmemcachedutil.rst \
- docs/memcached_add_by_key.rst \
+ docs/memaslap.rst \
docs/memcached_add.rst \
+ docs/memcached_add_by_key.rst \
docs/memcached_analyze.rst \
- docs/memcached_append_by_key.rst \
docs/memcached_append.rst \
+ docs/memcached_append_by_key.rst \
docs/memcached_auto.rst \
- docs/memcached_behavior_get.rst \
docs/memcached_behavior.rst \
+ docs/memcached_behavior_get.rst \
docs/memcached_behavior_set.rst \
- docs/memcached_callback_get.rst \
docs/memcached_callback.rst \
+ docs/memcached_callback_get.rst \
docs/memcached_callback_set.rst \
- docs/memcached_cas_by_key.rst \
docs/memcached_cas.rst \
+ docs/memcached_cas_by_key.rst \
docs/memcached_clone.rst \
docs/memcached_create.rst \
docs/memcached_decrement.rst \
docs/memcached_decrement_with_initial.rst \
- docs/memcached_delete_by_key.rst \
docs/memcached_delete.rst \
+ docs/memcached_delete_by_key.rst \
docs/memcached_destroy_sasl_auth_data.rst \
docs/memcached_dump.rst \
+ docs/memcached_fetch.rst \
docs/memcached_fetch_execute.rst \
docs/memcached_fetch_result.rst \
- docs/memcached_fetch.rst \
- docs/memcached_flush_buffers.rst \
docs/memcached_flush.rst \
+ docs/memcached_flush_buffers.rst \
docs/memcached_free.rst \
docs/memcached_generate_hash_value.rst \
+ docs/memcached_get.rst \
docs/memcached_get_by_key.rst \
docs/memcached_get_memory_allocators.rst \
- docs/memcached_get.rst \
docs/memcached_get_sasl_callbacks.rst \
docs/memcached_get_user_data.rst \
docs/memcached_increment.rst \
docs/memcached_increment_with_initial.rst \
docs/memcached_lib_version.rst \
docs/memcached_memory_allocators.rst \
+ docs/memcached_mget.rst \
docs/memcached_mget_by_key.rst \
- docs/memcached_mget_execute_by_key.rst \
docs/memcached_mget_execute.rst \
- docs/memcached_mget.rst \
+ docs/memcached_mget_execute_by_key.rst \
+ docs/memcached_pool.rst \
docs/memcached_pool_behavior_get.rst \
docs/memcached_pool_behavior_set.rst \
docs/memcached_pool_create.rst \
docs/memcached_pool_destroy.rst \
docs/memcached_pool_push.rst \
- docs/memcached_pool.rst \
docs/memcached_pool_rst.rst \
- docs/memcached_prepend_by_key.rst \
docs/memcached_prepend.rst \
+ docs/memcached_prepend_by_key.rst \
docs/memcached_quit.rst \
- docs/memcached_replace_by_key.rst \
docs/memcached_replace.rst \
+ docs/memcached_replace_by_key.rst \
docs/memcached_result_cas.rst \
docs/memcached_result_create.rst \
docs/memcached_result_flags.rst \
docs/memcached_server_add_unix_socket.rst \
docs/memcached_server_count.rst \
docs/memcached_server_cursor.rst \
+ docs/memcached_server_list.rst \
docs/memcached_server_list_append.rst \
docs/memcached_server_list_count.rst \
docs/memcached_server_list_free.rst \
- docs/memcached_server_list.rst \
docs/memcached_server_push.rst \
+ docs/memcached_server_st.rst \
+ docs/memcached_servers.rst \
docs/memcached_servers_parse.rst \
docs/memcached_servers_reset.rst \
- docs/memcached_servers.rst \
- docs/memcached_server_st.rst \
+ docs/memcached_set.rst \
docs/memcached_set_by_key.rst \
- docs/memcached_set_memory_allocators_context.rst \
docs/memcached_set_memory_allocators.rst \
- docs/memcached_set.rst \
+ docs/memcached_set_memory_allocators_context.rst \
docs/memcached_set_sasl_callbacks.rst \
docs/memcached_set_user_data.rst \
+ docs/memcached_stat.rst \
docs/memcached_stat_execute.rst \
docs/memcached_stat_get_keys.rst \
docs/memcached_stat_get_value.rst \
- docs/memcached_stat.rst \
docs/memcached_stat_servername.rst \
docs/memcached_stats.rst \
docs/memcached_strerror.rst \
docs/memerror.rst \
docs/memflush.rst \
docs/memrm.rst \
- docs/memaslap.rst \
docs/memslap.rst \
- docs/memstat.rst \
- docs/_static \
- docs/_templates \
- docs/conf.py \
- docs/libmemcached.rst \
- docs/libmemcached_examples.rst \
- docs/libmemcachedutil.rst \
- docs/memcached_analyze.rst \
- docs/memcached_dump.rst \
- docs/memcached_flush.rst \
- docs/memcached_flush_buffers.rst \
- docs/memcached_generate_hash_value.rst \
- docs/memcached_quit.rst \
- docs/memcached_strerror.rst \
- docs/memcached_verbosity.rst \
- docs/memcapable.rst \
- docs/memcat.rst \
- docs/memcp.rst \
- docs/memdump.rst \
- docs/memerror.rst \
- docs/memflush.rst \
- docs/memrm.rst \
- docs/memslap.rst \
- docs/memaslap.rst \
docs/memstat.rst
# Makefile for Sphinx documentation
.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest
man_MANS+= \
- docs/man/hashkit_crc32.3 \
docs/man/hashkit_clone.3 \
+ docs/man/hashkit_crc32.3 \
docs/man/hashkit_create.3 \
docs/man/hashkit_fnv1_32.3 \
docs/man/hashkit_fnv1_64.3 \
docs/man/hashkit_md5.3 \
docs/man/hashkit_murmur.3 \
docs/man/hashkit_value.3 \
+ docs/man/libhashkit.3 \
docs/man/libmemcached.3 \
docs/man/libmemcached_examples.3 \
docs/man/libmemcachedutil.3 \
+ docs/man/memaslap.1 \
docs/man/memcached_add.3 \
docs/man/memcached_add_by_key.3 \
docs/man/memcached_analyze.3 \
docs/man/memerror.1 \
docs/man/memflush.1 \
docs/man/memrm.1 \
- docs/man/memaslap.1 \
docs/man/memslap.1 \
docs/man/memstat.1
-========================================
-Welcome to libmemcached's documentation!
-========================================
+=========================================
+Welcome to the libmemcached documentation
+=========================================
------------
Libmemcached
libmemcached
libmemcached_examples
libmemcached_configuration
- libmemcachedutil
memcached_analyze
memcached_auto
memcached_behavior
memcached_generate_hash_value
memcached_get
memcached_memory_allocators
- memcached_pool
memcached_quit
memcached_result_st
memcached_sasl
memcached_verbosity
memcached_version
+----------------
+Libmemcachedutil
+----------------
+
+.. toctree::
+ :maxdepth: 1
+
+ libmemcachedutil
+ memcached_pool
+
-------------------
Client Applications
-------------------
.. toctree::
:maxdepth: 1
+ libhashkit
hashkit_create
hashkit_functions
hashkit_value
--- /dev/null
+======================
+Introducing libhashkit
+======================
+
+
+-------
+LIBRARY
+-------
+
+
+C library collection of useful hashing algorithm (libhashkit, -lhashkit)
+
+
+--------
+SYNOPSIS
+--------
+
+
+.. code-block:: perl
+
+ cc [ flag ... ] file ... -lhashkit
+
+ #include <libhashkit/hashkit.h>
+
+
+
+-----------
+DESCRIPTION
+-----------
+
+
+\ **libhashkit**\ is a small and thread-safe client library that provides a collection of useful hashing algorithm. libhashkit is distributed with libmemcached.
+
+
+----
+HOME
+----
+
+
+To find out more information please check:
+`https://launchpad.net/libmemcached <https://launchpad.net/libmemcached>`_
+
+
+--------
+SEE ALSO
+--------
+
+:manpage:`libmemcached(3)`
+
-============
-libmemcached
-============
+===========
+Introducing
+===========
Client library for memcached
-=====================
-libmemcached examples
-=====================
-
+========
+Examples
+========
Examples for libmemcached
-
-----------
DESCRIPTION
-----------
------------------------------
-.. code-block:: perl
+.. code-block:: c
memcached_st *memc;
memcached_return_t rc;
-.. code-block:: perl
+.. code-block:: c
memcached_server_st *servers;
memcached_st *memc= memcached_create(NULL);
-.. code-block:: perl
+.. code-block:: c
char *key= "foo";
char *value;
-.. code-block:: perl
+.. code-block:: c
memcached_return_t rc;
char *keys[]= {"fudge", "son", "food"};
-================
-libmemcachedutil
-================
+===========
+Introducing
+===========
Utility library for libmemcached
-------
-C Client Library containing utility functions for libmemcached (libmemcachedutil, -lmemcachedutil)
+C Client Library containing utility functions for libmemcached (libmemcachedutil, -lmemcachedutil -lmemcached)
--------
.SH AUTHOR
Brian Aker
.SH COPYRIGHT
-2011, Brian Aker
+2011, Brian Aker DataDifferential, http://datadifferential.com/
.\" Generated by docutils manpage writer.
.\"
.
.SH AUTHOR
Brian Aker
.SH COPYRIGHT
-2011, Brian Aker
+2011, Brian Aker DataDifferential, http://datadifferential.com/
.\" Generated by docutils manpage writer.
.\"
.
.SH AUTHOR
Brian Aker
.SH COPYRIGHT
-2011, Brian Aker
+2011, Brian Aker DataDifferential, http://datadifferential.com/
.\" Generated by docutils manpage writer.
.\"
.
.SH AUTHOR
Brian Aker
.SH COPYRIGHT
-2011, Brian Aker
+2011, Brian Aker DataDifferential, http://datadifferential.com/
.\" Generated by docutils manpage writer.
.\"
.
.SH AUTHOR
Brian Aker
.SH COPYRIGHT
-2011, Brian Aker
+2011, Brian Aker DataDifferential, http://datadifferential.com/
.\" Generated by docutils manpage writer.
.\"
.
.SH AUTHOR
Brian Aker
.SH COPYRIGHT
-2011, Brian Aker
+2011, Brian Aker DataDifferential, http://datadifferential.com/
.\" Generated by docutils manpage writer.
.\"
.
.SH AUTHOR
Brian Aker
.SH COPYRIGHT
-2011, Brian Aker
+2011, Brian Aker DataDifferential, http://datadifferential.com/
.\" Generated by docutils manpage writer.
.\"
.
.SH AUTHOR
Brian Aker
.SH COPYRIGHT
-2011, Brian Aker
+2011, Brian Aker DataDifferential, http://datadifferential.com/
.\" Generated by docutils manpage writer.
.\"
.
.SH AUTHOR
Brian Aker
.SH COPYRIGHT
-2011, Brian Aker
+2011, Brian Aker DataDifferential, http://datadifferential.com/
.\" Generated by docutils manpage writer.
.\"
.
.SH AUTHOR
Brian Aker
.SH COPYRIGHT
-2011, Brian Aker
+2011, Brian Aker DataDifferential, http://datadifferential.com/
.\" Generated by docutils manpage writer.
.\"
.
.SH AUTHOR
Brian Aker
.SH COPYRIGHT
-2011, Brian Aker
+2011, Brian Aker DataDifferential, http://datadifferential.com/
.\" Generated by docutils manpage writer.
.\"
.
.SH AUTHOR
Brian Aker
.SH COPYRIGHT
-2011, Brian Aker
+2011, Brian Aker DataDifferential, http://datadifferential.com/
.\" Generated by docutils manpage writer.
.\"
.
.SH AUTHOR
Brian Aker
.SH COPYRIGHT
-2011, Brian Aker
+2011, Brian Aker DataDifferential, http://datadifferential.com/
.\" Generated by docutils manpage writer.
.\"
.
.SH AUTHOR
Brian Aker
.SH COPYRIGHT
-2011, Brian Aker
+2011, Brian Aker DataDifferential, http://datadifferential.com/
.\" Generated by docutils manpage writer.
.\"
.
.SH AUTHOR
Brian Aker
.SH COPYRIGHT
-2011, Brian Aker
+2011, Brian Aker DataDifferential, http://datadifferential.com/
.\" Generated by docutils manpage writer.
.\"
.
--- /dev/null
+.TH "LIBHASHKIT" "3" "April 08, 2011" "0.47" "libmemcached"
+.SH NAME
+libhashkit \- libhashkit Documentation
+.
+.nr rst2man-indent-level 0
+.
+.de1 rstReportMargin
+\\$1 \\n[an-margin]
+level \\n[rst2man-indent-level]
+level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
+-
+\\n[rst2man-indent0]
+\\n[rst2man-indent1]
+\\n[rst2man-indent2]
+..
+.de1 INDENT
+.\" .rstReportMargin pre:
+. RS \\$1
+. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin]
+. nr rst2man-indent-level +1
+.\" .rstReportMargin post:
+..
+.de UNINDENT
+. RE
+.\" indent \\n[an-margin]
+.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]]
+.nr rst2man-indent-level -1
+.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
+.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
+..
+.\" Man page generated from reStructeredText.
+.
+.SH LIBRARY
+.sp
+C library collection of useful hashing algorithm (libhashkit, \-lhashkit)
+.SH SYNOPSIS
+.sp
+.nf
+.ft C
+cc [ flag ... ] file ... \-lhashkit
+
+#include <libhashkit/hashkit.h>
+.ft P
+.fi
+.SH DESCRIPTION
+.sp
+\fBlibhashkit\fP is a small and thread\-safe client library that provides a collection of useful hashing algorithm. libhashkit is distributed with libmemcached.
+.SH HOME
+.sp
+To find out more information please check:
+\fI\%https://launchpad.net/libmemcached\fP
+.SH SEE ALSO
+.sp
+\fIlibmemcached(3)\fP
+.SH AUTHOR
+Brian Aker
+.SH COPYRIGHT
+2011, Brian Aker DataDifferential, http://datadifferential.com/
+.\" Generated by docutils manpage writer.
+.\"
+.
.SH AUTHOR
Brian Aker
.SH COPYRIGHT
-2011, Brian Aker
+2011, Brian Aker DataDifferential, http://datadifferential.com/
.\" Generated by docutils manpage writer.
.\"
.
.SH AUTHOR
Brian Aker
.SH COPYRIGHT
-2011, Brian Aker
+2011, Brian Aker DataDifferential, http://datadifferential.com/
.\" Generated by docutils manpage writer.
.\"
.
Utility library for libmemcached
.SH LIBRARY
.sp
-C Client Library containing utility functions for libmemcached (libmemcachedutil, \-lmemcachedutil)
+C Client Library containing utility functions for libmemcached (libmemcachedutil, \-lmemcachedutil \-lmemcached)
.SH SYNOPSIS
.sp
.nf
.SH AUTHOR
Brian Aker
.SH COPYRIGHT
-2011, Brian Aker
+2011, Brian Aker DataDifferential, http://datadifferential.com/
.\" Generated by docutils manpage writer.
.\"
.
..
.\" Man page generated from reStructeredText.
.
-.sp
-memaslap \- Load testing and benchmarking tool for memcached
.SH SYNOPSIS
-.sp
-.nf
-.ft C
-memaslap [options]
-.ft P
-.fi
+.INDENT 0.0
+.TP
+.B \-\-help
+.UNINDENT
.SH DESCRIPTION
.sp
\fBmemaslap\fP is a load generation and benchmark tool for memcached(1)
.sp
.nf
.ft C
-***************************************************************************
+\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-
#comments should start with \(aq#\(aq
#key
#start_len end_len proportion
Brian Aker, <\fI\%brian@tangent.org\fP>
.SH SEE ALSO
.sp
-\fImemcached(1)\fP \fIlibmemcached(3)\fP \fImemcached_strerror(3)\fP
+\fImemcached(1)\fP \fIlibmemcached(3)\fP
.SH AUTHOR
Brian Aker
.SH COPYRIGHT
-2011, Brian Aker
+2011, Brian Aker DataDifferential, http://datadifferential.com/
.\" Generated by docutils manpage writer.
.\"
.
.SH AUTHOR
Brian Aker
.SH COPYRIGHT
-2011, Brian Aker
+2011, Brian Aker DataDifferential, http://datadifferential.com/
.\" Generated by docutils manpage writer.
.\"
.
.SH AUTHOR
Brian Aker
.SH COPYRIGHT
-2011, Brian Aker
+2011, Brian Aker DataDifferential, http://datadifferential.com/
.\" Generated by docutils manpage writer.
.\"
.
.SH AUTHOR
Brian Aker
.SH COPYRIGHT
-2011, Brian Aker
+2011, Brian Aker DataDifferential, http://datadifferential.com/
.\" Generated by docutils manpage writer.
.\"
.
.SH AUTHOR
Brian Aker
.SH COPYRIGHT
-2011, Brian Aker
+2011, Brian Aker DataDifferential, http://datadifferential.com/
.\" Generated by docutils manpage writer.
.\"
.
.SH AUTHOR
Brian Aker
.SH COPYRIGHT
-2011, Brian Aker
+2011, Brian Aker DataDifferential, http://datadifferential.com/
.\" Generated by docutils manpage writer.
.\"
.
.SH AUTHOR
Brian Aker
.SH COPYRIGHT
-2011, Brian Aker
+2011, Brian Aker DataDifferential, http://datadifferential.com/
.\" Generated by docutils manpage writer.
.\"
.
.SH AUTHOR
Brian Aker
.SH COPYRIGHT
-2011, Brian Aker
+2011, Brian Aker DataDifferential, http://datadifferential.com/
.\" Generated by docutils manpage writer.
.\"
.
.SH AUTHOR
Brian Aker
.SH COPYRIGHT
-2011, Brian Aker
+2011, Brian Aker DataDifferential, http://datadifferential.com/
.\" Generated by docutils manpage writer.
.\"
.
.SH AUTHOR
Brian Aker
.SH COPYRIGHT
-2011, Brian Aker
+2011, Brian Aker DataDifferential, http://datadifferential.com/
.\" Generated by docutils manpage writer.
.\"
.
.SH LIBRARY
.sp
C Client Library for memcached (libmemcached, \-lmemcached)
-.SS SYNOPSIS
+.SH SYNOPSIS
.sp
-.nf
-.ft C
#include <libmemcached/memcached.h>
-
-memcached_return_t
- memcached_callback_set (memcached_st *ptr,
- memcached_callback_t flag,
- void *data);
-
-void *
- memcached_callback_get (memcached_st *ptr,
- memcached_callback_t flag,
- memcached_return_t *error);
-.ft P
-.fi
-.SS DESCRIPTION
+.INDENT 0.0
+.TP
+.B memcached_return_t memcached_callback_set (memcached_st *ptr, memcached_callback_t flag, void *data);
+.UNINDENT
+.INDENT 0.0
+.TP
+.B void * memcached_callback_get (memcached_st *ptr, memcached_callback_t flag, memcached_return_t *error);
+.UNINDENT
+.SH DESCRIPTION
.sp
libmemcached(3) can have callbacks set key execution points. These either
provide function calls at points in the code, or return pointers to
.sp
You can use MEMCACHED_CALLBACK_USER_DATA to provide custom context if required for any
of the callbacks
-.sp
-MEMCACHED_CALLBACK_CLEANUP_FUNCTION
.INDENT 0.0
-.INDENT 3.5
-.sp
+.TP
+.B MEMCACHED_CALLBACK_CLEANUP_FUNCTION
+.
When memcached_delete() is called this function will be excuted. At the
point of its execution all connections have been closed.
.UNINDENT
-.UNINDENT
-.sp
-MEMCACHED_CALLBACK_CLONE_FUNCTION
.INDENT 0.0
-.INDENT 3.5
-.sp
+.TP
+.B MEMCACHED_CALLBACK_CLONE_FUNCTION
+.
When memcached_delete() is called this function will be excuted. At the
point of its execution all connections have been closed.
.UNINDENT
-.UNINDENT
-.sp
-MEMCACHED_CALLBACK_PREFIX_KEY
.INDENT 0.0
-.INDENT 3.5
-.sp
+.TP
+.B MEMCACHED_CALLBACK_PREFIX_KEY
+.
You can set a value which will be used to create a domain for your keys.
The value specified here will be prefixed to each of your keys. The value can not
be greater then MEMCACHED_PREFIX_KEY_MAX_SIZE \- 1 and will reduce MEMCACHED_MAX_KEY by
.sp
If you set a value with the value being NULL then the prefix key is disabled.
.UNINDENT
-.UNINDENT
-.sp
-MEMCACHED_CALLBACK_USER_DATA
.INDENT 0.0
-.INDENT 3.5
-.sp
+.TP
+.B MEMCACHED_CALLBACK_USER_DATA
+.
This allows you to store a pointer to a specifc piece of data. This can be
retrieved from inside of memcached_fetch_execute(). Cloning a memcached_st
will copy the pointer to the clone.
.UNINDENT
-.UNINDENT
-.sp
-MEMCACHED_CALLBACK_MALLOC_FUNCTION
.INDENT 0.0
-.INDENT 3.5
-.sp
+.TP
+.B MEMCACHED_CALLBACK_MALLOC_FUNCTION
+.
DEPRECATED: use memcached_set_memory_allocators instead.
.UNINDENT
-.UNINDENT
-.sp
-MEMCACHED_CALLBACK_REALLOC_FUNCTION
.INDENT 0.0
-.INDENT 3.5
-.sp
+.TP
+.B MEMCACHED_CALLBACK_REALLOC_FUNCTION
+.
DEPRECATED: use memcached_set_memory_allocators instead.
.UNINDENT
-.UNINDENT
-.sp
-MEMCACHED_CALLBACK_FREE_FUNCTION
.INDENT 0.0
-.INDENT 3.5
-.sp
+.TP
+.B MEMCACHED_CALLBACK_FREE_FUNCTION
+.
DEPRECATED: use memcached_set_memory_allocators instead.
.UNINDENT
-.UNINDENT
-.sp
-MEMCACHED_CALLBACK_GET_FAILURE
.INDENT 0.0
-.INDENT 3.5
-.sp
+.TP
+.B MEMCACHED_CALLBACK_GET_FAILURE
+.
This function implements the read through cache behavior. On failure of retrieval this callback will be called.
You are responsible for populating the result object provided. This result object will then be stored in the server and
returned to the calling process. You must clone the memcached_st in order to
The prototype for this is:
memcached_return_t (*memcached_trigger_key)(memcached_st *ptr, char *key, size_t key_length, memcached_result_st *result);
.UNINDENT
-.UNINDENT
-.sp
-MEMCACHED_CALLBACK_DELETE_TRIGGER
.INDENT 0.0
-.INDENT 3.5
+.TP
+.B MEMCACHED_CALLBACK_DELETE_TRIGGER
+.UNINDENT
.sp
-This function implements a trigger upon successful deletion of a key. The memcached_st structure will need to be cloned
-in order to make use of it.
+This function implements a trigger upon successful deletion of a key. The memcached_st structure will need to be cloned in order to make use of it.
.sp
-The prototype for this is:
-typedef memcached_return_t (*memcached_trigger_delete_key)(memcached_st *ptr, char *key, size_t key_length);
-.UNINDENT
-.UNINDENT
+The prototype for this is: typedef memcached_return_t (*memcached_trigger_delete_key)(memcached_st *ptr, char *key, size_t key_length);
.SH RETURN
.sp
memcached_callback_get() return the function or structure that was provided.
.SH AUTHOR
.sp
Brian Aker, <\fI\%brian@tangent.org\fP>
-.SS SEE ALSO
+.SH SEE ALSO
.sp
\fImemcached(1)\fP \fIlibmemcached(3)\fP \fImemcached_strerror(3)\fP
.SH AUTHOR
Brian Aker
.SH COPYRIGHT
-2011, Brian Aker
+2011, Brian Aker DataDifferential, http://datadifferential.com/
.\" Generated by docutils manpage writer.
.\"
.
.SH LIBRARY
.sp
C Client Library for memcached (libmemcached, \-lmemcached)
-.SS SYNOPSIS
+.SH SYNOPSIS
.sp
-.nf
-.ft C
#include <libmemcached/memcached.h>
-
-memcached_return_t
- memcached_callback_set (memcached_st *ptr,
- memcached_callback_t flag,
- void *data);
-
-void *
- memcached_callback_get (memcached_st *ptr,
- memcached_callback_t flag,
- memcached_return_t *error);
-.ft P
-.fi
-.SS DESCRIPTION
+.INDENT 0.0
+.TP
+.B memcached_return_t memcached_callback_set (memcached_st *ptr, memcached_callback_t flag, void *data);
+.UNINDENT
+.INDENT 0.0
+.TP
+.B void * memcached_callback_get (memcached_st *ptr, memcached_callback_t flag, memcached_return_t *error);
+.UNINDENT
+.SH DESCRIPTION
.sp
libmemcached(3) can have callbacks set key execution points. These either
provide function calls at points in the code, or return pointers to
.sp
You can use MEMCACHED_CALLBACK_USER_DATA to provide custom context if required for any
of the callbacks
-.sp
-MEMCACHED_CALLBACK_CLEANUP_FUNCTION
.INDENT 0.0
-.INDENT 3.5
-.sp
+.TP
+.B MEMCACHED_CALLBACK_CLEANUP_FUNCTION
+.
When memcached_delete() is called this function will be excuted. At the
point of its execution all connections have been closed.
.UNINDENT
-.UNINDENT
-.sp
-MEMCACHED_CALLBACK_CLONE_FUNCTION
.INDENT 0.0
-.INDENT 3.5
-.sp
+.TP
+.B MEMCACHED_CALLBACK_CLONE_FUNCTION
+.
When memcached_delete() is called this function will be excuted. At the
point of its execution all connections have been closed.
.UNINDENT
-.UNINDENT
-.sp
-MEMCACHED_CALLBACK_PREFIX_KEY
.INDENT 0.0
-.INDENT 3.5
-.sp
+.TP
+.B MEMCACHED_CALLBACK_PREFIX_KEY
+.
You can set a value which will be used to create a domain for your keys.
The value specified here will be prefixed to each of your keys. The value can not
be greater then MEMCACHED_PREFIX_KEY_MAX_SIZE \- 1 and will reduce MEMCACHED_MAX_KEY by
.sp
If you set a value with the value being NULL then the prefix key is disabled.
.UNINDENT
-.UNINDENT
-.sp
-MEMCACHED_CALLBACK_USER_DATA
.INDENT 0.0
-.INDENT 3.5
-.sp
+.TP
+.B MEMCACHED_CALLBACK_USER_DATA
+.
This allows you to store a pointer to a specifc piece of data. This can be
retrieved from inside of memcached_fetch_execute(). Cloning a memcached_st
will copy the pointer to the clone.
.UNINDENT
-.UNINDENT
-.sp
-MEMCACHED_CALLBACK_MALLOC_FUNCTION
.INDENT 0.0
-.INDENT 3.5
-.sp
+.TP
+.B MEMCACHED_CALLBACK_MALLOC_FUNCTION
+.
DEPRECATED: use memcached_set_memory_allocators instead.
.UNINDENT
-.UNINDENT
-.sp
-MEMCACHED_CALLBACK_REALLOC_FUNCTION
.INDENT 0.0
-.INDENT 3.5
-.sp
+.TP
+.B MEMCACHED_CALLBACK_REALLOC_FUNCTION
+.
DEPRECATED: use memcached_set_memory_allocators instead.
.UNINDENT
-.UNINDENT
-.sp
-MEMCACHED_CALLBACK_FREE_FUNCTION
.INDENT 0.0
-.INDENT 3.5
-.sp
+.TP
+.B MEMCACHED_CALLBACK_FREE_FUNCTION
+.
DEPRECATED: use memcached_set_memory_allocators instead.
.UNINDENT
-.UNINDENT
-.sp
-MEMCACHED_CALLBACK_GET_FAILURE
.INDENT 0.0
-.INDENT 3.5
-.sp
+.TP
+.B MEMCACHED_CALLBACK_GET_FAILURE
+.
This function implements the read through cache behavior. On failure of retrieval this callback will be called.
You are responsible for populating the result object provided. This result object will then be stored in the server and
returned to the calling process. You must clone the memcached_st in order to
The prototype for this is:
memcached_return_t (*memcached_trigger_key)(memcached_st *ptr, char *key, size_t key_length, memcached_result_st *result);
.UNINDENT
-.UNINDENT
-.sp
-MEMCACHED_CALLBACK_DELETE_TRIGGER
.INDENT 0.0
-.INDENT 3.5
+.TP
+.B MEMCACHED_CALLBACK_DELETE_TRIGGER
+.UNINDENT
.sp
-This function implements a trigger upon successful deletion of a key. The memcached_st structure will need to be cloned
-in order to make use of it.
+This function implements a trigger upon successful deletion of a key. The memcached_st structure will need to be cloned in order to make use of it.
.sp
-The prototype for this is:
-typedef memcached_return_t (*memcached_trigger_delete_key)(memcached_st *ptr, char *key, size_t key_length);
-.UNINDENT
-.UNINDENT
+The prototype for this is: typedef memcached_return_t (*memcached_trigger_delete_key)(memcached_st *ptr, char *key, size_t key_length);
.SH RETURN
.sp
memcached_callback_get() return the function or structure that was provided.
.SH AUTHOR
.sp
Brian Aker, <\fI\%brian@tangent.org\fP>
-.SS SEE ALSO
+.SH SEE ALSO
.sp
\fImemcached(1)\fP \fIlibmemcached(3)\fP \fImemcached_strerror(3)\fP
.SH AUTHOR
Brian Aker
.SH COPYRIGHT
-2011, Brian Aker
+2011, Brian Aker DataDifferential, http://datadifferential.com/
.\" Generated by docutils manpage writer.
.\"
.
.SH LIBRARY
.sp
C Client Library for memcached (libmemcached, \-lmemcached)
-.SS SYNOPSIS
+.SH SYNOPSIS
.sp
-.nf
-.ft C
#include <libmemcached/memcached.h>
-
-memcached_return_t
- memcached_callback_set (memcached_st *ptr,
- memcached_callback_t flag,
- void *data);
-
-void *
- memcached_callback_get (memcached_st *ptr,
- memcached_callback_t flag,
- memcached_return_t *error);
-.ft P
-.fi
-.SS DESCRIPTION
+.INDENT 0.0
+.TP
+.B memcached_return_t memcached_callback_set (memcached_st *ptr, memcached_callback_t flag, void *data);
+.UNINDENT
+.INDENT 0.0
+.TP
+.B void * memcached_callback_get (memcached_st *ptr, memcached_callback_t flag, memcached_return_t *error);
+.UNINDENT
+.SH DESCRIPTION
.sp
libmemcached(3) can have callbacks set key execution points. These either
provide function calls at points in the code, or return pointers to
.sp
You can use MEMCACHED_CALLBACK_USER_DATA to provide custom context if required for any
of the callbacks
-.sp
-MEMCACHED_CALLBACK_CLEANUP_FUNCTION
.INDENT 0.0
-.INDENT 3.5
-.sp
+.TP
+.B MEMCACHED_CALLBACK_CLEANUP_FUNCTION
+.
When memcached_delete() is called this function will be excuted. At the
point of its execution all connections have been closed.
.UNINDENT
-.UNINDENT
-.sp
-MEMCACHED_CALLBACK_CLONE_FUNCTION
.INDENT 0.0
-.INDENT 3.5
-.sp
+.TP
+.B MEMCACHED_CALLBACK_CLONE_FUNCTION
+.
When memcached_delete() is called this function will be excuted. At the
point of its execution all connections have been closed.
.UNINDENT
-.UNINDENT
-.sp
-MEMCACHED_CALLBACK_PREFIX_KEY
.INDENT 0.0
-.INDENT 3.5
-.sp
+.TP
+.B MEMCACHED_CALLBACK_PREFIX_KEY
+.
You can set a value which will be used to create a domain for your keys.
The value specified here will be prefixed to each of your keys. The value can not
be greater then MEMCACHED_PREFIX_KEY_MAX_SIZE \- 1 and will reduce MEMCACHED_MAX_KEY by
.sp
If you set a value with the value being NULL then the prefix key is disabled.
.UNINDENT
-.UNINDENT
-.sp
-MEMCACHED_CALLBACK_USER_DATA
.INDENT 0.0
-.INDENT 3.5
-.sp
+.TP
+.B MEMCACHED_CALLBACK_USER_DATA
+.
This allows you to store a pointer to a specifc piece of data. This can be
retrieved from inside of memcached_fetch_execute(). Cloning a memcached_st
will copy the pointer to the clone.
.UNINDENT
-.UNINDENT
-.sp
-MEMCACHED_CALLBACK_MALLOC_FUNCTION
.INDENT 0.0
-.INDENT 3.5
-.sp
+.TP
+.B MEMCACHED_CALLBACK_MALLOC_FUNCTION
+.
DEPRECATED: use memcached_set_memory_allocators instead.
.UNINDENT
-.UNINDENT
-.sp
-MEMCACHED_CALLBACK_REALLOC_FUNCTION
.INDENT 0.0
-.INDENT 3.5
-.sp
+.TP
+.B MEMCACHED_CALLBACK_REALLOC_FUNCTION
+.
DEPRECATED: use memcached_set_memory_allocators instead.
.UNINDENT
-.UNINDENT
-.sp
-MEMCACHED_CALLBACK_FREE_FUNCTION
.INDENT 0.0
-.INDENT 3.5
-.sp
+.TP
+.B MEMCACHED_CALLBACK_FREE_FUNCTION
+.
DEPRECATED: use memcached_set_memory_allocators instead.
.UNINDENT
-.UNINDENT
-.sp
-MEMCACHED_CALLBACK_GET_FAILURE
.INDENT 0.0
-.INDENT 3.5
-.sp
+.TP
+.B MEMCACHED_CALLBACK_GET_FAILURE
+.
This function implements the read through cache behavior. On failure of retrieval this callback will be called.
You are responsible for populating the result object provided. This result object will then be stored in the server and
returned to the calling process. You must clone the memcached_st in order to
The prototype for this is:
memcached_return_t (*memcached_trigger_key)(memcached_st *ptr, char *key, size_t key_length, memcached_result_st *result);
.UNINDENT
-.UNINDENT
-.sp
-MEMCACHED_CALLBACK_DELETE_TRIGGER
.INDENT 0.0
-.INDENT 3.5
+.TP
+.B MEMCACHED_CALLBACK_DELETE_TRIGGER
+.UNINDENT
.sp
-This function implements a trigger upon successful deletion of a key. The memcached_st structure will need to be cloned
-in order to make use of it.
+This function implements a trigger upon successful deletion of a key. The memcached_st structure will need to be cloned in order to make use of it.
.sp
-The prototype for this is:
-typedef memcached_return_t (*memcached_trigger_delete_key)(memcached_st *ptr, char *key, size_t key_length);
-.UNINDENT
-.UNINDENT
+The prototype for this is: typedef memcached_return_t (*memcached_trigger_delete_key)(memcached_st *ptr, char *key, size_t key_length);
.SH RETURN
.sp
memcached_callback_get() return the function or structure that was provided.
.SH AUTHOR
.sp
Brian Aker, <\fI\%brian@tangent.org\fP>
-.SS SEE ALSO
+.SH SEE ALSO
.sp
\fImemcached(1)\fP \fIlibmemcached(3)\fP \fImemcached_strerror(3)\fP
.SH AUTHOR
Brian Aker
.SH COPYRIGHT
-2011, Brian Aker
+2011, Brian Aker DataDifferential, http://datadifferential.com/
.\" Generated by docutils manpage writer.
.\"
.
.SH AUTHOR
Brian Aker
.SH COPYRIGHT
-2011, Brian Aker
+2011, Brian Aker DataDifferential, http://datadifferential.com/
.\" Generated by docutils manpage writer.
.\"
.
.SH AUTHOR
Brian Aker
.SH COPYRIGHT
-2011, Brian Aker
+2011, Brian Aker DataDifferential, http://datadifferential.com/
.\" Generated by docutils manpage writer.
.\"
.
.SH LIBRARY
.sp
C Client Library for memcached (libmemcached, \-lmemcached)
-.SS SYNOPSIS
+.SH SYNOPSIS
.sp
-.nf
-.ft C
#include <libmemcached/memcached.h>
-
-memcached_st *memcached_create (memcached_st *ptr);
-
-void memcached_free (memcached_st *ptr);
-
-memcached_st *memcached_clone (memcached_st *destination, memcached_st *source);
-
-void memcached_servers_reset(memcached_st);
-.ft P
-.fi
-.SS DESCRIPTION
+.INDENT 0.0
+.TP
+.B memcached_st *memcached_create (memcached_st *ptr);
+.UNINDENT
+.INDENT 0.0
+.TP
+.B void memcached_free (memcached_st *ptr);
+.UNINDENT
+.INDENT 0.0
+.TP
+.B memcached_st *memcached_clone (memcached_st *destination, memcached_st *source);
+.UNINDENT
+.INDENT 0.0
+.TP
+.B void memcached_servers_reset(memcached_st);
+.UNINDENT
+.SH DESCRIPTION
.sp
memcached_create() is used to create a \fBmemcached_st\fP structure that will then
be used by other libmemcached(3) functions to communicate with the server. You
.SH AUTHOR
.sp
Brian Aker, <\fI\%brian@tangent.org\fP>
-.SS SEE ALSO
+.SH SEE ALSO
.sp
\fImemcached(1)\fP \fIlibmemcached(3)\fP \fImemcached_strerror(3)\fP
.SH AUTHOR
Brian Aker
.SH COPYRIGHT
-2011, Brian Aker
+2011, Brian Aker DataDifferential, http://datadifferential.com/
.\" Generated by docutils manpage writer.
.\"
.
.SH LIBRARY
.sp
C Client Library for memcached (libmemcached, \-lmemcached)
-.SS SYNOPSIS
+.SH SYNOPSIS
.sp
-.nf
-.ft C
#include <libmemcached/memcached.h>
-
-memcached_st *memcached_create (memcached_st *ptr);
-
-void memcached_free (memcached_st *ptr);
-
-memcached_st *memcached_clone (memcached_st *destination, memcached_st *source);
-
-void memcached_servers_reset(memcached_st);
-.ft P
-.fi
-.SS DESCRIPTION
+.INDENT 0.0
+.TP
+.B memcached_st *memcached_create (memcached_st *ptr);
+.UNINDENT
+.INDENT 0.0
+.TP
+.B void memcached_free (memcached_st *ptr);
+.UNINDENT
+.INDENT 0.0
+.TP
+.B memcached_st *memcached_clone (memcached_st *destination, memcached_st *source);
+.UNINDENT
+.INDENT 0.0
+.TP
+.B void memcached_servers_reset(memcached_st);
+.UNINDENT
+.SH DESCRIPTION
.sp
memcached_create() is used to create a \fBmemcached_st\fP structure that will then
be used by other libmemcached(3) functions to communicate with the server. You
.SH AUTHOR
.sp
Brian Aker, <\fI\%brian@tangent.org\fP>
-.SS SEE ALSO
+.SH SEE ALSO
.sp
\fImemcached(1)\fP \fIlibmemcached(3)\fP \fImemcached_strerror(3)\fP
.SH AUTHOR
Brian Aker
.SH COPYRIGHT
-2011, Brian Aker
+2011, Brian Aker DataDifferential, http://datadifferential.com/
.\" Generated by docutils manpage writer.
.\"
.
.SH AUTHOR
Brian Aker
.SH COPYRIGHT
-2011, Brian Aker
+2011, Brian Aker DataDifferential, http://datadifferential.com/
.\" Generated by docutils manpage writer.
.\"
.
.SH AUTHOR
Brian Aker
.SH COPYRIGHT
-2011, Brian Aker
+2011, Brian Aker DataDifferential, http://datadifferential.com/
.\" Generated by docutils manpage writer.
.\"
.
.SH LIBRARY
.sp
C Client Library for memcached (libmemcached, \-lmemcached)
-.SS SYNOPSIS
+.SH SYNOPSIS
.sp
.nf
.ft C
#include <libmemcached/memcached.h>
-memcached_return_t
- memcached_delete (memcached_st *ptr,
- const char *key, size_t key_length,
- time_t expiration);
+memcached_return_t memcached_delete (memcached_st *ptr, const char *key, size_t key_length, time_t expiration);
-memcached_return_t
-memcached_delete_by_key (memcached_st *ptr,
- const char *master_key, size_t master_key_length,
- const char *key, size_t key_length,
- time_t expiration);
+memcached_return_t memcached_delete_by_key (memcached_st *ptr, const char *master_key, size_t master_key_length, const char *key, size_t key_length, time_t expiration);
.ft P
.fi
-.SS DESCRIPTION
+.SH DESCRIPTION
.sp
memcached_delete() is used to delete a particular key.
memcached_delete_by_key() works the same, but it takes a master key to
.SH AUTHOR
.sp
Brian Aker, <\fI\%brian@tangent.org\fP>
-.SS SEE ALSO
+.SH SEE ALSO
.sp
\fImemcached(1)\fP \fIlibmemcached(3)\fP \fImemcached_strerror(3)\fP
.SH AUTHOR
Brian Aker
.SH COPYRIGHT
-2011, Brian Aker
+2011, Brian Aker DataDifferential, http://datadifferential.com/
.\" Generated by docutils manpage writer.
.\"
.
.SH LIBRARY
.sp
C Client Library for memcached (libmemcached, \-lmemcached)
-.SS SYNOPSIS
+.SH SYNOPSIS
.sp
.nf
.ft C
#include <libmemcached/memcached.h>
-memcached_return_t
- memcached_delete (memcached_st *ptr,
- const char *key, size_t key_length,
- time_t expiration);
+memcached_return_t memcached_delete (memcached_st *ptr, const char *key, size_t key_length, time_t expiration);
-memcached_return_t
-memcached_delete_by_key (memcached_st *ptr,
- const char *master_key, size_t master_key_length,
- const char *key, size_t key_length,
- time_t expiration);
+memcached_return_t memcached_delete_by_key (memcached_st *ptr, const char *master_key, size_t master_key_length, const char *key, size_t key_length, time_t expiration);
.ft P
.fi
-.SS DESCRIPTION
+.SH DESCRIPTION
.sp
memcached_delete() is used to delete a particular key.
memcached_delete_by_key() works the same, but it takes a master key to
.SH AUTHOR
.sp
Brian Aker, <\fI\%brian@tangent.org\fP>
-.SS SEE ALSO
+.SH SEE ALSO
.sp
\fImemcached(1)\fP \fIlibmemcached(3)\fP \fImemcached_strerror(3)\fP
.SH AUTHOR
Brian Aker
.SH COPYRIGHT
-2011, Brian Aker
+2011, Brian Aker DataDifferential, http://datadifferential.com/
.\" Generated by docutils manpage writer.
.\"
.
..
.\" Man page generated from reStructeredText.
.
-.sp
-memcached_set_sasl_callbacks, memcached_get_sasl_callbacks, memcached_sasl_set_auth_data, memcached_destroy_sasl_auth_data
-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-**
-.sp
-SASL tests
+.SH LIBRARY
.sp
C Client Library for memcached (libmemcached, \-lmemcached)
.SH SYNOPSIS
You as a client user have to initialize libsasl by using sasl_client_init
before enabling it in libmemcached, and you have to shut down libsasl by
calling sasl_done() when you are done using SASL from libmemcached.
+.SH RETURN
.sp
memcached_get_sasl_callbacks() returns the callbacks currently used
by this memcached handle.
memcached_get_sasl_set_auth_data() returns MEMCACHED_SUCCESS upon success.
+.SH HOME
.sp
To find out more information please check:
\fI\%http://libmemcached.org/\fP
+.SH AUTHOR
+.sp
+Brian Aker, <\fI\%brian@tangent.org\fP>
.sp
Trond Norbye, <\fI\%trond.norbye@gmail.com\fP>
.SH SEE ALSO
.SH AUTHOR
Brian Aker
.SH COPYRIGHT
-2011, Brian Aker
+2011, Brian Aker DataDifferential, http://datadifferential.com/
.\" Generated by docutils manpage writer.
.\"
.
.SH LIBRARY
.sp
C Client Library for memcached (libmemcached, \-lmemcached)
-.SS SYNOPSIS
+.SH SYNOPSIS
.sp
.nf
.ft C
void *context);
.ft P
.fi
-.SS DESCRIPTION
+.SH DESCRIPTION
.sp
memcached_dump() is used to get a list of keys found memcached(1) servers.
Because memcached(1) does not guarentee to dump all keys you can not assume
.SH AUTHOR
.sp
Brian Aker, <\fI\%brian@tangent.org\fP>
-.SS SEE ALSO
+.SH SEE ALSO
.sp
\fImemcached(1)\fP \fIlibmemcached(3)\fP \fImemcached_strerror(3)\fP
.SH AUTHOR
Brian Aker
.SH COPYRIGHT
-2011, Brian Aker
+2011, Brian Aker DataDifferential, http://datadifferential.com/
.\" Generated by docutils manpage writer.
.\"
.
.SH AUTHOR
Brian Aker
.SH COPYRIGHT
-2011, Brian Aker
+2011, Brian Aker DataDifferential, http://datadifferential.com/
.\" Generated by docutils manpage writer.
.\"
.
.SH AUTHOR
Brian Aker
.SH COPYRIGHT
-2011, Brian Aker
+2011, Brian Aker DataDifferential, http://datadifferential.com/
.\" Generated by docutils manpage writer.
.\"
.
.SH AUTHOR
Brian Aker
.SH COPYRIGHT
-2011, Brian Aker
+2011, Brian Aker DataDifferential, http://datadifferential.com/
.\" Generated by docutils manpage writer.
.\"
.
.\" Man page generated from reStructeredText.
.
.sp
-memcached_flush
-\-\-\-\-\-\-\-\-\-\-\-\-\-\-*
-.sp
Wipe contents of memcached servers
+.SH LIBRARY
.sp
C Client Library for memcached (libmemcached, \-lmemcached)
.SH SYNOPSIS
flush). The operation is not atomic to multiple servers, just atomic to a
single server. That is, it will flush the servers in the order that they were
added.
+.SH RETURN
.sp
A value of type \fBmemcached_return_t\fP is returned
On success that value will be \fBMEMCACHED_SUCCESS\fP.
Use memcached_strerror() to translate this value to a printable string.
+.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>
.SH SEE ALSO
.SH AUTHOR
Brian Aker
.SH COPYRIGHT
-2011, Brian Aker
+2011, Brian Aker DataDifferential, http://datadifferential.com/
.\" Generated by docutils manpage writer.
.\"
.
.\" Man page generated from reStructeredText.
.
.sp
-memcached_flush_buffers
-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-*
-.sp
Flush buffers and send buffered commands
+.SH LIBRARY
.sp
C Client Library for memcached (libmemcached, \-lmemcached)
.SH SYNOPSIS
.sp
-.nf
-.ft C
#include <libmemcached/memcached.h>
-
-memcached_return_t
- memcached_flush_buffers (memcached_st *ptr);
-.ft P
-.fi
+.INDENT 0.0
+.TP
+.B memcached_return_t memcached_flush_buffers (memcached_st *ptr);
+.UNINDENT
.SH DESCRIPTION
.sp
memcached_flush_buffers() is used in conjunction with
MEMCACHED_BEHAVIOR_BUFFER_REQUESTS (see memcached_behavior(3)) to flush
all buffers by sending the buffered commands to the server for processing.
+.SH RETURN
.sp
A value of type \fBmemcached_return_t\fP is returned
On success that value will be \fBMEMCACHED_SUCCESS\fP.
Use memcached_strerror() to translate this value to a printable string.
+.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>
.sp
Trond Norbye, <\fI\%trond.norbye@gmail.com\fP>
.SH SEE ALSO
.SH AUTHOR
Brian Aker
.SH COPYRIGHT
-2011, Brian Aker
+2011, Brian Aker DataDifferential, http://datadifferential.com/
.\" Generated by docutils manpage writer.
.\"
.
.SH LIBRARY
.sp
C Client Library for memcached (libmemcached, \-lmemcached)
-.SS SYNOPSIS
+.SH SYNOPSIS
.sp
-.nf
-.ft C
#include <libmemcached/memcached.h>
-
-memcached_st *memcached_create (memcached_st *ptr);
-
-void memcached_free (memcached_st *ptr);
-
-memcached_st *memcached_clone (memcached_st *destination, memcached_st *source);
-
-void memcached_servers_reset(memcached_st);
-.ft P
-.fi
-.SS DESCRIPTION
+.INDENT 0.0
+.TP
+.B memcached_st *memcached_create (memcached_st *ptr);
+.UNINDENT
+.INDENT 0.0
+.TP
+.B void memcached_free (memcached_st *ptr);
+.UNINDENT
+.INDENT 0.0
+.TP
+.B memcached_st *memcached_clone (memcached_st *destination, memcached_st *source);
+.UNINDENT
+.INDENT 0.0
+.TP
+.B void memcached_servers_reset(memcached_st);
+.UNINDENT
+.SH DESCRIPTION
.sp
memcached_create() is used to create a \fBmemcached_st\fP structure that will then
be used by other libmemcached(3) functions to communicate with the server. You
.SH AUTHOR
.sp
Brian Aker, <\fI\%brian@tangent.org\fP>
-.SS SEE ALSO
+.SH SEE ALSO
.sp
\fImemcached(1)\fP \fIlibmemcached(3)\fP \fImemcached_strerror(3)\fP
.SH AUTHOR
Brian Aker
.SH COPYRIGHT
-2011, Brian Aker
+2011, Brian Aker DataDifferential, http://datadifferential.com/
.\" Generated by docutils manpage writer.
.\"
.
.\" Man page generated from reStructeredText.
.
.sp
-memcached_generate_hash_value
-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-**
-.sp
Hash a key value
+.SH LIBRARY
.sp
C Client Library for memcached (libmemcached, \-lmemcached)
.SH SYNOPSIS
of the memcached_st structure.
.sp
As of version 0.36 all hash methods have been placed into the library
-libmemcached(3) which is linked with libmemcached(3).
+libhashkit(3) which is linked with libmemcached(3). For more information please see its documentation.
+.SH RETURN
.sp
A 32\-bit integer which is the result of hashing the given key.
For 64\-bit hash algorithms, only the least\-significant 32 bits are
returned.
+.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>
.SH SEE ALSO
.SH AUTHOR
Brian Aker
.SH COPYRIGHT
-2011, Brian Aker
+2011, Brian Aker DataDifferential, http://datadifferential.com/
.\" Generated by docutils manpage writer.
.\"
.
.SH AUTHOR
Brian Aker
.SH COPYRIGHT
-2011, Brian Aker
+2011, Brian Aker DataDifferential, http://datadifferential.com/
.\" Generated by docutils manpage writer.
.\"
.
.SH AUTHOR
Brian Aker
.SH COPYRIGHT
-2011, Brian Aker
+2011, Brian Aker DataDifferential, http://datadifferential.com/
.\" Generated by docutils manpage writer.
.\"
.
.SH AUTHOR
Brian Aker
.SH COPYRIGHT
-2011, Brian Aker
+2011, Brian Aker DataDifferential, http://datadifferential.com/
.\" Generated by docutils manpage writer.
.\"
.
..
.\" Man page generated from reStructeredText.
.
-.sp
-memcached_set_sasl_callbacks, memcached_get_sasl_callbacks, memcached_sasl_set_auth_data, memcached_destroy_sasl_auth_data
-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-**
-.sp
-SASL tests
+.SH LIBRARY
.sp
C Client Library for memcached (libmemcached, \-lmemcached)
.SH SYNOPSIS
You as a client user have to initialize libsasl by using sasl_client_init
before enabling it in libmemcached, and you have to shut down libsasl by
calling sasl_done() when you are done using SASL from libmemcached.
+.SH RETURN
.sp
memcached_get_sasl_callbacks() returns the callbacks currently used
by this memcached handle.
memcached_get_sasl_set_auth_data() returns MEMCACHED_SUCCESS upon success.
+.SH HOME
.sp
To find out more information please check:
\fI\%http://libmemcached.org/\fP
+.SH AUTHOR
+.sp
+Brian Aker, <\fI\%brian@tangent.org\fP>
.sp
Trond Norbye, <\fI\%trond.norbye@gmail.com\fP>
.SH SEE ALSO
.SH AUTHOR
Brian Aker
.SH COPYRIGHT
-2011, Brian Aker
+2011, Brian Aker DataDifferential, http://datadifferential.com/
.\" Generated by docutils manpage writer.
.\"
.
.SH AUTHOR
Brian Aker
.SH COPYRIGHT
-2011, Brian Aker
+2011, Brian Aker DataDifferential, http://datadifferential.com/
.\" Generated by docutils manpage writer.
.\"
.
.SH AUTHOR
Brian Aker
.SH COPYRIGHT
-2011, Brian Aker
+2011, Brian Aker DataDifferential, http://datadifferential.com/
.\" Generated by docutils manpage writer.
.\"
.
.SH AUTHOR
Brian Aker
.SH COPYRIGHT
-2011, Brian Aker
+2011, Brian Aker DataDifferential, http://datadifferential.com/
.\" Generated by docutils manpage writer.
.\"
.
.SH AUTHOR
Brian Aker
.SH COPYRIGHT
-2011, Brian Aker
+2011, Brian Aker DataDifferential, http://datadifferential.com/
.\" Generated by docutils manpage writer.
.\"
.
.SH AUTHOR
Brian Aker
.SH COPYRIGHT
-2011, Brian Aker
+2011, Brian Aker DataDifferential, http://datadifferential.com/
.\" Generated by docutils manpage writer.
.\"
.
.SH AUTHOR
Brian Aker
.SH COPYRIGHT
-2011, Brian Aker
+2011, Brian Aker DataDifferential, http://datadifferential.com/
.\" Generated by docutils manpage writer.
.\"
.
.SH AUTHOR
Brian Aker
.SH COPYRIGHT
-2011, Brian Aker
+2011, Brian Aker DataDifferential, http://datadifferential.com/
.\" Generated by docutils manpage writer.
.\"
.
.SH AUTHOR
Brian Aker
.SH COPYRIGHT
-2011, Brian Aker
+2011, Brian Aker DataDifferential, http://datadifferential.com/
.\" Generated by docutils manpage writer.
.\"
.
.SH AUTHOR
Brian Aker
.SH COPYRIGHT
-2011, Brian Aker
+2011, Brian Aker DataDifferential, http://datadifferential.com/
.\" Generated by docutils manpage writer.
.\"
.
..
.\" Man page generated from reStructeredText.
.
+.SH SYNOPSIS
.sp
-Manage pools
-.SH LIBRARY
-.sp
-C Client Library for memcached (libmemcachedutil, \-lmemcachedutil)
-.SS SYNOPSIS
-.sp
-.nf
-.ft C
#include <libmemcached/memcached_pool.h>
-
-memcached_pool_st * memcached_pool_create(memcached_st* mmc, int initial, int max);
-
-memcached_st * memcached_pool_destroy(memcached_pool_st* pool);
-
-memcached_st * memcached_pool_pop (memcached_pool_st* pool, bool block, memcached_return_t *rc);
-
-memcached_return_t memcached_pool_push(memcached_pool_st* pool, memcached_st *mmc);
-
-memcached_st *memcached_create (memcached_st *ptr);
-
-memcached_return_t memcached_pool_behavior_set(memcached_pool_st *pool, memcached_behavior_t flag, uint64_t data)
-
-memcached_return_t memcached_pool_behavior_get(memcached_pool_st *pool, memcached_behavior_t flag, uint64_t *value)
-.ft P
-.fi
-.SS DESCRIPTION
+.INDENT 0.0
+.TP
+.B memcached_pool_st * memcached_pool_create(memcached_st* mmc, int initial, int max);
+.UNINDENT
+.INDENT 0.0
+.TP
+.B memcached_st * memcached_pool_destroy(memcached_pool_st* pool);
+.UNINDENT
+.INDENT 0.0
+.TP
+.B memcached_st * memcached_pool_pop (memcached_pool_st* pool, bool block, memcached_return_t *rc);
+.UNINDENT
+.INDENT 0.0
+.TP
+.B memcached_return_t memcached_pool_push(memcached_pool_st* pool, memcached_st *mmc);
+.UNINDENT
+.INDENT 0.0
+.TP
+.B memcached_st *memcached_create (memcached_st *ptr);
+.UNINDENT
+.INDENT 0.0
+.TP
+.B memcached_return_t memcached_pool_behavior_set(memcached_pool_st\fI\ *pool\fP, memcached_behavior_t\fI\ flag\fP, uint64_t\fI\ data\fP)
+.UNINDENT
+.INDENT 0.0
+.TP
+.B memcached_return_t memcached_pool_behavior_get(memcached_pool_st\fI\ *pool\fP, memcached_behavior_t\fI\ flag\fP, uint64_t\fI\ *value\fP)
+.UNINDENT
+.sp
+Compile and link with \-lmemcachedutil \-lmemcached
+.SH DESCRIPTION
.sp
memcached_pool_create() is used to create a connection pool of objects you
may use to remove the overhead of using memcached_clone for short
\fI\%https://launchpad.net/libmemcached\fP
.SH AUTHOR
.sp
+Brian Aker, <\fI\%brian@tangent.org\fP>
+.sp
Trond Norbye, <\fI\%trond.norbye@gmail.com\fP>
-.SS SEE ALSO
+.SH SEE ALSO
.sp
\fImemcached(1)\fP \fIlibmemcached(3)\fP \fImemcached_strerror(3)\fP
.SH AUTHOR
Brian Aker
.SH COPYRIGHT
-2011, Brian Aker
+2011, Brian Aker DataDifferential, http://datadifferential.com/
.\" Generated by docutils manpage writer.
.\"
.
..
.\" Man page generated from reStructeredText.
.
+.SH SYNOPSIS
.sp
-Manage pools
-.SH LIBRARY
-.sp
-C Client Library for memcached (libmemcachedutil, \-lmemcachedutil)
-.SS SYNOPSIS
-.sp
-.nf
-.ft C
#include <libmemcached/memcached_pool.h>
-
-memcached_pool_st * memcached_pool_create(memcached_st* mmc, int initial, int max);
-
-memcached_st * memcached_pool_destroy(memcached_pool_st* pool);
-
-memcached_st * memcached_pool_pop (memcached_pool_st* pool, bool block, memcached_return_t *rc);
-
-memcached_return_t memcached_pool_push(memcached_pool_st* pool, memcached_st *mmc);
-
-memcached_st *memcached_create (memcached_st *ptr);
-
-memcached_return_t memcached_pool_behavior_set(memcached_pool_st *pool, memcached_behavior_t flag, uint64_t data)
-
-memcached_return_t memcached_pool_behavior_get(memcached_pool_st *pool, memcached_behavior_t flag, uint64_t *value)
-.ft P
-.fi
-.SS DESCRIPTION
+.INDENT 0.0
+.TP
+.B memcached_pool_st * memcached_pool_create(memcached_st* mmc, int initial, int max);
+.UNINDENT
+.INDENT 0.0
+.TP
+.B memcached_st * memcached_pool_destroy(memcached_pool_st* pool);
+.UNINDENT
+.INDENT 0.0
+.TP
+.B memcached_st * memcached_pool_pop (memcached_pool_st* pool, bool block, memcached_return_t *rc);
+.UNINDENT
+.INDENT 0.0
+.TP
+.B memcached_return_t memcached_pool_push(memcached_pool_st* pool, memcached_st *mmc);
+.UNINDENT
+.INDENT 0.0
+.TP
+.B memcached_st *memcached_create (memcached_st *ptr);
+.UNINDENT
+.INDENT 0.0
+.TP
+.B memcached_return_t memcached_pool_behavior_set(memcached_pool_st\fI\ *pool\fP, memcached_behavior_t\fI\ flag\fP, uint64_t\fI\ data\fP)
+.UNINDENT
+.INDENT 0.0
+.TP
+.B memcached_return_t memcached_pool_behavior_get(memcached_pool_st\fI\ *pool\fP, memcached_behavior_t\fI\ flag\fP, uint64_t\fI\ *value\fP)
+.UNINDENT
+.sp
+Compile and link with \-lmemcachedutil \-lmemcached
+.SH DESCRIPTION
.sp
memcached_pool_create() is used to create a connection pool of objects you
may use to remove the overhead of using memcached_clone for short
\fI\%https://launchpad.net/libmemcached\fP
.SH AUTHOR
.sp
+Brian Aker, <\fI\%brian@tangent.org\fP>
+.sp
Trond Norbye, <\fI\%trond.norbye@gmail.com\fP>
-.SS SEE ALSO
+.SH SEE ALSO
.sp
\fImemcached(1)\fP \fIlibmemcached(3)\fP \fImemcached_strerror(3)\fP
.SH AUTHOR
Brian Aker
.SH COPYRIGHT
-2011, Brian Aker
+2011, Brian Aker DataDifferential, http://datadifferential.com/
.\" Generated by docutils manpage writer.
.\"
.
..
.\" Man page generated from reStructeredText.
.
+.SH SYNOPSIS
.sp
-Manage pools
-.SH LIBRARY
-.sp
-C Client Library for memcached (libmemcachedutil, \-lmemcachedutil)
-.SS SYNOPSIS
-.sp
-.nf
-.ft C
#include <libmemcached/memcached_pool.h>
-
-memcached_pool_st * memcached_pool_create(memcached_st* mmc, int initial, int max);
-
-memcached_st * memcached_pool_destroy(memcached_pool_st* pool);
-
-memcached_st * memcached_pool_pop (memcached_pool_st* pool, bool block, memcached_return_t *rc);
-
-memcached_return_t memcached_pool_push(memcached_pool_st* pool, memcached_st *mmc);
-
-memcached_st *memcached_create (memcached_st *ptr);
-
-memcached_return_t memcached_pool_behavior_set(memcached_pool_st *pool, memcached_behavior_t flag, uint64_t data)
-
-memcached_return_t memcached_pool_behavior_get(memcached_pool_st *pool, memcached_behavior_t flag, uint64_t *value)
-.ft P
-.fi
-.SS DESCRIPTION
+.INDENT 0.0
+.TP
+.B memcached_pool_st * memcached_pool_create(memcached_st* mmc, int initial, int max);
+.UNINDENT
+.INDENT 0.0
+.TP
+.B memcached_st * memcached_pool_destroy(memcached_pool_st* pool);
+.UNINDENT
+.INDENT 0.0
+.TP
+.B memcached_st * memcached_pool_pop (memcached_pool_st* pool, bool block, memcached_return_t *rc);
+.UNINDENT
+.INDENT 0.0
+.TP
+.B memcached_return_t memcached_pool_push(memcached_pool_st* pool, memcached_st *mmc);
+.UNINDENT
+.INDENT 0.0
+.TP
+.B memcached_st *memcached_create (memcached_st *ptr);
+.UNINDENT
+.INDENT 0.0
+.TP
+.B memcached_return_t memcached_pool_behavior_set(memcached_pool_st\fI\ *pool\fP, memcached_behavior_t\fI\ flag\fP, uint64_t\fI\ data\fP)
+.UNINDENT
+.INDENT 0.0
+.TP
+.B memcached_return_t memcached_pool_behavior_get(memcached_pool_st\fI\ *pool\fP, memcached_behavior_t\fI\ flag\fP, uint64_t\fI\ *value\fP)
+.UNINDENT
+.sp
+Compile and link with \-lmemcachedutil \-lmemcached
+.SH DESCRIPTION
.sp
memcached_pool_create() is used to create a connection pool of objects you
may use to remove the overhead of using memcached_clone for short
\fI\%https://launchpad.net/libmemcached\fP
.SH AUTHOR
.sp
+Brian Aker, <\fI\%brian@tangent.org\fP>
+.sp
Trond Norbye, <\fI\%trond.norbye@gmail.com\fP>
-.SS SEE ALSO
+.SH SEE ALSO
.sp
\fImemcached(1)\fP \fIlibmemcached(3)\fP \fImemcached_strerror(3)\fP
.SH AUTHOR
Brian Aker
.SH COPYRIGHT
-2011, Brian Aker
+2011, Brian Aker DataDifferential, http://datadifferential.com/
.\" Generated by docutils manpage writer.
.\"
.
..
.\" Man page generated from reStructeredText.
.
+.SH SYNOPSIS
.sp
-Manage pools
-.SH LIBRARY
-.sp
-C Client Library for memcached (libmemcachedutil, \-lmemcachedutil)
-.SS SYNOPSIS
-.sp
-.nf
-.ft C
#include <libmemcached/memcached_pool.h>
-
-memcached_pool_st * memcached_pool_create(memcached_st* mmc, int initial, int max);
-
-memcached_st * memcached_pool_destroy(memcached_pool_st* pool);
-
-memcached_st * memcached_pool_pop (memcached_pool_st* pool, bool block, memcached_return_t *rc);
-
-memcached_return_t memcached_pool_push(memcached_pool_st* pool, memcached_st *mmc);
-
-memcached_st *memcached_create (memcached_st *ptr);
-
-memcached_return_t memcached_pool_behavior_set(memcached_pool_st *pool, memcached_behavior_t flag, uint64_t data)
-
-memcached_return_t memcached_pool_behavior_get(memcached_pool_st *pool, memcached_behavior_t flag, uint64_t *value)
-.ft P
-.fi
-.SS DESCRIPTION
+.INDENT 0.0
+.TP
+.B memcached_pool_st * memcached_pool_create(memcached_st* mmc, int initial, int max);
+.UNINDENT
+.INDENT 0.0
+.TP
+.B memcached_st * memcached_pool_destroy(memcached_pool_st* pool);
+.UNINDENT
+.INDENT 0.0
+.TP
+.B memcached_st * memcached_pool_pop (memcached_pool_st* pool, bool block, memcached_return_t *rc);
+.UNINDENT
+.INDENT 0.0
+.TP
+.B memcached_return_t memcached_pool_push(memcached_pool_st* pool, memcached_st *mmc);
+.UNINDENT
+.INDENT 0.0
+.TP
+.B memcached_st *memcached_create (memcached_st *ptr);
+.UNINDENT
+.INDENT 0.0
+.TP
+.B memcached_return_t memcached_pool_behavior_set(memcached_pool_st\fI\ *pool\fP, memcached_behavior_t\fI\ flag\fP, uint64_t\fI\ data\fP)
+.UNINDENT
+.INDENT 0.0
+.TP
+.B memcached_return_t memcached_pool_behavior_get(memcached_pool_st\fI\ *pool\fP, memcached_behavior_t\fI\ flag\fP, uint64_t\fI\ *value\fP)
+.UNINDENT
+.sp
+Compile and link with \-lmemcachedutil \-lmemcached
+.SH DESCRIPTION
.sp
memcached_pool_create() is used to create a connection pool of objects you
may use to remove the overhead of using memcached_clone for short
\fI\%https://launchpad.net/libmemcached\fP
.SH AUTHOR
.sp
+Brian Aker, <\fI\%brian@tangent.org\fP>
+.sp
Trond Norbye, <\fI\%trond.norbye@gmail.com\fP>
-.SS SEE ALSO
+.SH SEE ALSO
.sp
\fImemcached(1)\fP \fIlibmemcached(3)\fP \fImemcached_strerror(3)\fP
.SH AUTHOR
Brian Aker
.SH COPYRIGHT
-2011, Brian Aker
+2011, Brian Aker DataDifferential, http://datadifferential.com/
.\" Generated by docutils manpage writer.
.\"
.
..
.\" Man page generated from reStructeredText.
.
+.SH SYNOPSIS
.sp
-Manage pools
-.SH LIBRARY
-.sp
-C Client Library for memcached (libmemcachedutil, \-lmemcachedutil)
-.SS SYNOPSIS
-.sp
-.nf
-.ft C
#include <libmemcached/memcached_pool.h>
-
-memcached_pool_st * memcached_pool_create(memcached_st* mmc, int initial, int max);
-
-memcached_st * memcached_pool_destroy(memcached_pool_st* pool);
-
-memcached_st * memcached_pool_pop (memcached_pool_st* pool, bool block, memcached_return_t *rc);
-
-memcached_return_t memcached_pool_push(memcached_pool_st* pool, memcached_st *mmc);
-
-memcached_st *memcached_create (memcached_st *ptr);
-
-memcached_return_t memcached_pool_behavior_set(memcached_pool_st *pool, memcached_behavior_t flag, uint64_t data)
-
-memcached_return_t memcached_pool_behavior_get(memcached_pool_st *pool, memcached_behavior_t flag, uint64_t *value)
-.ft P
-.fi
-.SS DESCRIPTION
+.INDENT 0.0
+.TP
+.B memcached_pool_st * memcached_pool_create(memcached_st* mmc, int initial, int max);
+.UNINDENT
+.INDENT 0.0
+.TP
+.B memcached_st * memcached_pool_destroy(memcached_pool_st* pool);
+.UNINDENT
+.INDENT 0.0
+.TP
+.B memcached_st * memcached_pool_pop (memcached_pool_st* pool, bool block, memcached_return_t *rc);
+.UNINDENT
+.INDENT 0.0
+.TP
+.B memcached_return_t memcached_pool_push(memcached_pool_st* pool, memcached_st *mmc);
+.UNINDENT
+.INDENT 0.0
+.TP
+.B memcached_st *memcached_create (memcached_st *ptr);
+.UNINDENT
+.INDENT 0.0
+.TP
+.B memcached_return_t memcached_pool_behavior_set(memcached_pool_st\fI\ *pool\fP, memcached_behavior_t\fI\ flag\fP, uint64_t\fI\ data\fP)
+.UNINDENT
+.INDENT 0.0
+.TP
+.B memcached_return_t memcached_pool_behavior_get(memcached_pool_st\fI\ *pool\fP, memcached_behavior_t\fI\ flag\fP, uint64_t\fI\ *value\fP)
+.UNINDENT
+.sp
+Compile and link with \-lmemcachedutil \-lmemcached
+.SH DESCRIPTION
.sp
memcached_pool_create() is used to create a connection pool of objects you
may use to remove the overhead of using memcached_clone for short
\fI\%https://launchpad.net/libmemcached\fP
.SH AUTHOR
.sp
+Brian Aker, <\fI\%brian@tangent.org\fP>
+.sp
Trond Norbye, <\fI\%trond.norbye@gmail.com\fP>
-.SS SEE ALSO
+.SH SEE ALSO
.sp
\fImemcached(1)\fP \fIlibmemcached(3)\fP \fImemcached_strerror(3)\fP
.SH AUTHOR
Brian Aker
.SH COPYRIGHT
-2011, Brian Aker
+2011, Brian Aker DataDifferential, http://datadifferential.com/
.\" Generated by docutils manpage writer.
.\"
.
..
.\" Man page generated from reStructeredText.
.
+.SH SYNOPSIS
.sp
-Manage pools
-.SH LIBRARY
-.sp
-C Client Library for memcached (libmemcachedutil, \-lmemcachedutil)
-.SS SYNOPSIS
-.sp
-.nf
-.ft C
#include <libmemcached/memcached_pool.h>
-
-memcached_pool_st * memcached_pool_create(memcached_st* mmc, int initial, int max);
-
-memcached_st * memcached_pool_destroy(memcached_pool_st* pool);
-
-memcached_st * memcached_pool_pop (memcached_pool_st* pool, bool block, memcached_return_t *rc);
-
-memcached_return_t memcached_pool_push(memcached_pool_st* pool, memcached_st *mmc);
-
-memcached_st *memcached_create (memcached_st *ptr);
-
-memcached_return_t memcached_pool_behavior_set(memcached_pool_st *pool, memcached_behavior_t flag, uint64_t data)
-
-memcached_return_t memcached_pool_behavior_get(memcached_pool_st *pool, memcached_behavior_t flag, uint64_t *value)
-.ft P
-.fi
-.SS DESCRIPTION
+.INDENT 0.0
+.TP
+.B memcached_pool_st * memcached_pool_create(memcached_st* mmc, int initial, int max);
+.UNINDENT
+.INDENT 0.0
+.TP
+.B memcached_st * memcached_pool_destroy(memcached_pool_st* pool);
+.UNINDENT
+.INDENT 0.0
+.TP
+.B memcached_st * memcached_pool_pop (memcached_pool_st* pool, bool block, memcached_return_t *rc);
+.UNINDENT
+.INDENT 0.0
+.TP
+.B memcached_return_t memcached_pool_push(memcached_pool_st* pool, memcached_st *mmc);
+.UNINDENT
+.INDENT 0.0
+.TP
+.B memcached_st *memcached_create (memcached_st *ptr);
+.UNINDENT
+.INDENT 0.0
+.TP
+.B memcached_return_t memcached_pool_behavior_set(memcached_pool_st\fI\ *pool\fP, memcached_behavior_t\fI\ flag\fP, uint64_t\fI\ data\fP)
+.UNINDENT
+.INDENT 0.0
+.TP
+.B memcached_return_t memcached_pool_behavior_get(memcached_pool_st\fI\ *pool\fP, memcached_behavior_t\fI\ flag\fP, uint64_t\fI\ *value\fP)
+.UNINDENT
+.sp
+Compile and link with \-lmemcachedutil \-lmemcached
+.SH DESCRIPTION
.sp
memcached_pool_create() is used to create a connection pool of objects you
may use to remove the overhead of using memcached_clone for short
\fI\%https://launchpad.net/libmemcached\fP
.SH AUTHOR
.sp
+Brian Aker, <\fI\%brian@tangent.org\fP>
+.sp
Trond Norbye, <\fI\%trond.norbye@gmail.com\fP>
-.SS SEE ALSO
+.SH SEE ALSO
.sp
\fImemcached(1)\fP \fIlibmemcached(3)\fP \fImemcached_strerror(3)\fP
.SH AUTHOR
Brian Aker
.SH COPYRIGHT
-2011, Brian Aker
+2011, Brian Aker DataDifferential, http://datadifferential.com/
.\" Generated by docutils manpage writer.
.\"
.
..
.\" Man page generated from reStructeredText.
.
+.SH SYNOPSIS
.sp
-Manage pools
-.SH LIBRARY
-.sp
-C Client Library for memcached (libmemcachedutil, \-lmemcachedutil)
-.SS SYNOPSIS
-.sp
-.nf
-.ft C
#include <libmemcached/memcached_pool.h>
-
-memcached_pool_st * memcached_pool_create(memcached_st* mmc, int initial, int max);
-
-memcached_st * memcached_pool_destroy(memcached_pool_st* pool);
-
-memcached_st * memcached_pool_pop (memcached_pool_st* pool, bool block, memcached_return_t *rc);
-
-memcached_return_t memcached_pool_push(memcached_pool_st* pool, memcached_st *mmc);
-
-memcached_st *memcached_create (memcached_st *ptr);
-
-memcached_return_t memcached_pool_behavior_set(memcached_pool_st *pool, memcached_behavior_t flag, uint64_t data)
-
-memcached_return_t memcached_pool_behavior_get(memcached_pool_st *pool, memcached_behavior_t flag, uint64_t *value)
-.ft P
-.fi
-.SS DESCRIPTION
+.INDENT 0.0
+.TP
+.B memcached_pool_st * memcached_pool_create(memcached_st* mmc, int initial, int max);
+.UNINDENT
+.INDENT 0.0
+.TP
+.B memcached_st * memcached_pool_destroy(memcached_pool_st* pool);
+.UNINDENT
+.INDENT 0.0
+.TP
+.B memcached_st * memcached_pool_pop (memcached_pool_st* pool, bool block, memcached_return_t *rc);
+.UNINDENT
+.INDENT 0.0
+.TP
+.B memcached_return_t memcached_pool_push(memcached_pool_st* pool, memcached_st *mmc);
+.UNINDENT
+.INDENT 0.0
+.TP
+.B memcached_st *memcached_create (memcached_st *ptr);
+.UNINDENT
+.INDENT 0.0
+.TP
+.B memcached_return_t memcached_pool_behavior_set(memcached_pool_st\fI\ *pool\fP, memcached_behavior_t\fI\ flag\fP, uint64_t\fI\ data\fP)
+.UNINDENT
+.INDENT 0.0
+.TP
+.B memcached_return_t memcached_pool_behavior_get(memcached_pool_st\fI\ *pool\fP, memcached_behavior_t\fI\ flag\fP, uint64_t\fI\ *value\fP)
+.UNINDENT
+.sp
+Compile and link with \-lmemcachedutil \-lmemcached
+.SH DESCRIPTION
.sp
memcached_pool_create() is used to create a connection pool of objects you
may use to remove the overhead of using memcached_clone for short
\fI\%https://launchpad.net/libmemcached\fP
.SH AUTHOR
.sp
+Brian Aker, <\fI\%brian@tangent.org\fP>
+.sp
Trond Norbye, <\fI\%trond.norbye@gmail.com\fP>
-.SS SEE ALSO
+.SH SEE ALSO
.sp
\fImemcached(1)\fP \fIlibmemcached(3)\fP \fImemcached_strerror(3)\fP
.SH AUTHOR
Brian Aker
.SH COPYRIGHT
-2011, Brian Aker
+2011, Brian Aker DataDifferential, http://datadifferential.com/
.\" Generated by docutils manpage writer.
.\"
.
.SH AUTHOR
Brian Aker
.SH COPYRIGHT
-2011, Brian Aker
+2011, Brian Aker DataDifferential, http://datadifferential.com/
.\" Generated by docutils manpage writer.
.\"
.
.SH AUTHOR
Brian Aker
.SH COPYRIGHT
-2011, Brian Aker
+2011, Brian Aker DataDifferential, http://datadifferential.com/
.\" Generated by docutils manpage writer.
.\"
.
.SH LIBRARY
.sp
C Client Library for memcached (libmemcached, \-lmemcached)
-.SS SYNOPSIS
+.SH SYNOPSIS
.sp
.nf
.ft C
void memcached_quit (memcached_st *ptr);
.ft P
.fi
-.SS DESCRIPTION
+.SH DESCRIPTION
.sp
memcached_quit() will disconnect you from all currently connected servers.
It will also reset the state of the connection (ie, any memcached_fetch() you
.SH AUTHOR
.sp
Brian Aker, <\fI\%brian@tangent.org\fP>
-.SS SEE ALSO
+.SH SEE ALSO
.sp
\fImemcached(1)\fP \fIlibmemcached(3)\fP \fImemcached_strerror(3)\fP
.SH AUTHOR
Brian Aker
.SH COPYRIGHT
-2011, Brian Aker
+2011, Brian Aker DataDifferential, http://datadifferential.com/
.\" Generated by docutils manpage writer.
.\"
.
.SH AUTHOR
Brian Aker
.SH COPYRIGHT
-2011, Brian Aker
+2011, Brian Aker DataDifferential, http://datadifferential.com/
.\" Generated by docutils manpage writer.
.\"
.
.SH AUTHOR
Brian Aker
.SH COPYRIGHT
-2011, Brian Aker
+2011, Brian Aker DataDifferential, http://datadifferential.com/
.\" Generated by docutils manpage writer.
.\"
.
.SH AUTHOR
Brian Aker
.SH COPYRIGHT
-2011, Brian Aker
+2011, Brian Aker DataDifferential, http://datadifferential.com/
.\" Generated by docutils manpage writer.
.\"
.
.SH AUTHOR
Brian Aker
.SH COPYRIGHT
-2011, Brian Aker
+2011, Brian Aker DataDifferential, http://datadifferential.com/
.\" Generated by docutils manpage writer.
.\"
.
.SH AUTHOR
Brian Aker
.SH COPYRIGHT
-2011, Brian Aker
+2011, Brian Aker DataDifferential, http://datadifferential.com/
.\" Generated by docutils manpage writer.
.\"
.
.SH AUTHOR
Brian Aker
.SH COPYRIGHT
-2011, Brian Aker
+2011, Brian Aker DataDifferential, http://datadifferential.com/
.\" Generated by docutils manpage writer.
.\"
.
.SH AUTHOR
Brian Aker
.SH COPYRIGHT
-2011, Brian Aker
+2011, Brian Aker DataDifferential, http://datadifferential.com/
.\" Generated by docutils manpage writer.
.\"
.
.SH AUTHOR
Brian Aker
.SH COPYRIGHT
-2011, Brian Aker
+2011, Brian Aker DataDifferential, http://datadifferential.com/
.\" Generated by docutils manpage writer.
.\"
.
.SH AUTHOR
Brian Aker
.SH COPYRIGHT
-2011, Brian Aker
+2011, Brian Aker DataDifferential, http://datadifferential.com/
.\" Generated by docutils manpage writer.
.\"
.
.SH AUTHOR
Brian Aker
.SH COPYRIGHT
-2011, Brian Aker
+2011, Brian Aker DataDifferential, http://datadifferential.com/
.\" Generated by docutils manpage writer.
.\"
.
.SH AUTHOR
Brian Aker
.SH COPYRIGHT
-2011, Brian Aker
+2011, Brian Aker DataDifferential, http://datadifferential.com/
.\" Generated by docutils manpage writer.
.\"
.
..
.\" Man page generated from reStructeredText.
.
-.sp
-memcached_set_sasl_callbacks, memcached_get_sasl_callbacks, memcached_sasl_set_auth_data, memcached_destroy_sasl_auth_data
-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-**
-.sp
-SASL tests
+.SH LIBRARY
.sp
C Client Library for memcached (libmemcached, \-lmemcached)
.SH SYNOPSIS
You as a client user have to initialize libsasl by using sasl_client_init
before enabling it in libmemcached, and you have to shut down libsasl by
calling sasl_done() when you are done using SASL from libmemcached.
+.SH RETURN
.sp
memcached_get_sasl_callbacks() returns the callbacks currently used
by this memcached handle.
memcached_get_sasl_set_auth_data() returns MEMCACHED_SUCCESS upon success.
+.SH HOME
.sp
To find out more information please check:
\fI\%http://libmemcached.org/\fP
+.SH AUTHOR
+.sp
+Brian Aker, <\fI\%brian@tangent.org\fP>
.sp
Trond Norbye, <\fI\%trond.norbye@gmail.com\fP>
.SH SEE ALSO
.SH AUTHOR
Brian Aker
.SH COPYRIGHT
-2011, Brian Aker
+2011, Brian Aker DataDifferential, http://datadifferential.com/
.\" Generated by docutils manpage writer.
.\"
.
..
.\" Man page generated from reStructeredText.
.
-.sp
-memcached_set_sasl_callbacks, memcached_get_sasl_callbacks, memcached_sasl_set_auth_data, memcached_destroy_sasl_auth_data
-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-**
-.sp
-SASL tests
+.SH LIBRARY
.sp
C Client Library for memcached (libmemcached, \-lmemcached)
.SH SYNOPSIS
You as a client user have to initialize libsasl by using sasl_client_init
before enabling it in libmemcached, and you have to shut down libsasl by
calling sasl_done() when you are done using SASL from libmemcached.
+.SH RETURN
.sp
memcached_get_sasl_callbacks() returns the callbacks currently used
by this memcached handle.
memcached_get_sasl_set_auth_data() returns MEMCACHED_SUCCESS upon success.
+.SH HOME
.sp
To find out more information please check:
\fI\%http://libmemcached.org/\fP
+.SH AUTHOR
+.sp
+Brian Aker, <\fI\%brian@tangent.org\fP>
.sp
Trond Norbye, <\fI\%trond.norbye@gmail.com\fP>
.SH SEE ALSO
.SH AUTHOR
Brian Aker
.SH COPYRIGHT
-2011, Brian Aker
+2011, Brian Aker DataDifferential, http://datadifferential.com/
.\" Generated by docutils manpage writer.
.\"
.
.SH AUTHOR
Brian Aker
.SH COPYRIGHT
-2011, Brian Aker
+2011, Brian Aker DataDifferential, http://datadifferential.com/
.\" Generated by docutils manpage writer.
.\"
.
.SH AUTHOR
Brian Aker
.SH COPYRIGHT
-2011, Brian Aker
+2011, Brian Aker DataDifferential, http://datadifferential.com/
.\" Generated by docutils manpage writer.
.\"
.
.SH AUTHOR
Brian Aker
.SH COPYRIGHT
-2011, Brian Aker
+2011, Brian Aker DataDifferential, http://datadifferential.com/
.\" Generated by docutils manpage writer.
.\"
.
.SH AUTHOR
Brian Aker
.SH COPYRIGHT
-2011, Brian Aker
+2011, Brian Aker DataDifferential, http://datadifferential.com/
.\" Generated by docutils manpage writer.
.\"
.
.SH AUTHOR
Brian Aker
.SH COPYRIGHT
-2011, Brian Aker
+2011, Brian Aker DataDifferential, http://datadifferential.com/
.\" Generated by docutils manpage writer.
.\"
.
.SH AUTHOR
Brian Aker
.SH COPYRIGHT
-2011, Brian Aker
+2011, Brian Aker DataDifferential, http://datadifferential.com/
.\" Generated by docutils manpage writer.
.\"
.
.SH AUTHOR
Brian Aker
.SH COPYRIGHT
-2011, Brian Aker
+2011, Brian Aker DataDifferential, http://datadifferential.com/
.\" Generated by docutils manpage writer.
.\"
.
.SH AUTHOR
Brian Aker
.SH COPYRIGHT
-2011, Brian Aker
+2011, Brian Aker DataDifferential, http://datadifferential.com/
.\" Generated by docutils manpage writer.
.\"
.
.SH AUTHOR
Brian Aker
.SH COPYRIGHT
-2011, Brian Aker
+2011, Brian Aker DataDifferential, http://datadifferential.com/
.\" Generated by docutils manpage writer.
.\"
.
.SH AUTHOR
Brian Aker
.SH COPYRIGHT
-2011, Brian Aker
+2011, Brian Aker DataDifferential, http://datadifferential.com/
.\" Generated by docutils manpage writer.
.\"
.
.SH AUTHOR
Brian Aker
.SH COPYRIGHT
-2011, Brian Aker
+2011, Brian Aker DataDifferential, http://datadifferential.com/
.\" Generated by docutils manpage writer.
.\"
.
.SH AUTHOR
Brian Aker
.SH COPYRIGHT
-2011, Brian Aker
+2011, Brian Aker DataDifferential, http://datadifferential.com/
.\" Generated by docutils manpage writer.
.\"
.
.SH LIBRARY
.sp
C Client Library for memcached (libmemcached, \-lmemcached)
-.SS SYNOPSIS
+.SH SYNOPSIS
.sp
-.nf
-.ft C
#include <libmemcached/memcached.h>
-
-memcached_st *memcached_create (memcached_st *ptr);
-
-void memcached_free (memcached_st *ptr);
-
-memcached_st *memcached_clone (memcached_st *destination, memcached_st *source);
-
-void memcached_servers_reset(memcached_st);
-.ft P
-.fi
-.SS DESCRIPTION
+.INDENT 0.0
+.TP
+.B memcached_st *memcached_create (memcached_st *ptr);
+.UNINDENT
+.INDENT 0.0
+.TP
+.B void memcached_free (memcached_st *ptr);
+.UNINDENT
+.INDENT 0.0
+.TP
+.B memcached_st *memcached_clone (memcached_st *destination, memcached_st *source);
+.UNINDENT
+.INDENT 0.0
+.TP
+.B void memcached_servers_reset(memcached_st);
+.UNINDENT
+.SH DESCRIPTION
.sp
memcached_create() is used to create a \fBmemcached_st\fP structure that will then
be used by other libmemcached(3) functions to communicate with the server. You
.SH AUTHOR
.sp
Brian Aker, <\fI\%brian@tangent.org\fP>
-.SS SEE ALSO
+.SH SEE ALSO
.sp
\fImemcached(1)\fP \fIlibmemcached(3)\fP \fImemcached_strerror(3)\fP
.SH AUTHOR
Brian Aker
.SH COPYRIGHT
-2011, Brian Aker
+2011, Brian Aker DataDifferential, http://datadifferential.com/
.\" Generated by docutils manpage writer.
.\"
.
.SH AUTHOR
Brian Aker
.SH COPYRIGHT
-2011, Brian Aker
+2011, Brian Aker DataDifferential, http://datadifferential.com/
.\" Generated by docutils manpage writer.
.\"
.
.SH AUTHOR
Brian Aker
.SH COPYRIGHT
-2011, Brian Aker
+2011, Brian Aker DataDifferential, http://datadifferential.com/
.\" Generated by docutils manpage writer.
.\"
.
.SH AUTHOR
Brian Aker
.SH COPYRIGHT
-2011, Brian Aker
+2011, Brian Aker DataDifferential, http://datadifferential.com/
.\" Generated by docutils manpage writer.
.\"
.
.SH AUTHOR
Brian Aker
.SH COPYRIGHT
-2011, Brian Aker
+2011, Brian Aker DataDifferential, http://datadifferential.com/
.\" Generated by docutils manpage writer.
.\"
.
..
.\" Man page generated from reStructeredText.
.
-.sp
-memcached_set_sasl_callbacks, memcached_get_sasl_callbacks, memcached_sasl_set_auth_data, memcached_destroy_sasl_auth_data
-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-**
-.sp
-SASL tests
+.SH LIBRARY
.sp
C Client Library for memcached (libmemcached, \-lmemcached)
.SH SYNOPSIS
You as a client user have to initialize libsasl by using sasl_client_init
before enabling it in libmemcached, and you have to shut down libsasl by
calling sasl_done() when you are done using SASL from libmemcached.
+.SH RETURN
.sp
memcached_get_sasl_callbacks() returns the callbacks currently used
by this memcached handle.
memcached_get_sasl_set_auth_data() returns MEMCACHED_SUCCESS upon success.
+.SH HOME
.sp
To find out more information please check:
\fI\%http://libmemcached.org/\fP
+.SH AUTHOR
+.sp
+Brian Aker, <\fI\%brian@tangent.org\fP>
.sp
Trond Norbye, <\fI\%trond.norbye@gmail.com\fP>
.SH SEE ALSO
.SH AUTHOR
Brian Aker
.SH COPYRIGHT
-2011, Brian Aker
+2011, Brian Aker DataDifferential, http://datadifferential.com/
.\" Generated by docutils manpage writer.
.\"
.
.SH AUTHOR
Brian Aker
.SH COPYRIGHT
-2011, Brian Aker
+2011, Brian Aker DataDifferential, http://datadifferential.com/
.\" Generated by docutils manpage writer.
.\"
.
.SH AUTHOR
Brian Aker
.SH COPYRIGHT
-2011, Brian Aker
+2011, Brian Aker DataDifferential, http://datadifferential.com/
.\" Generated by docutils manpage writer.
.\"
.
.SH AUTHOR
Brian Aker
.SH COPYRIGHT
-2011, Brian Aker
+2011, Brian Aker DataDifferential, http://datadifferential.com/
.\" Generated by docutils manpage writer.
.\"
.
.SH AUTHOR
Brian Aker
.SH COPYRIGHT
-2011, Brian Aker
+2011, Brian Aker DataDifferential, http://datadifferential.com/
.\" Generated by docutils manpage writer.
.\"
.
.SH AUTHOR
Brian Aker
.SH COPYRIGHT
-2011, Brian Aker
+2011, Brian Aker DataDifferential, http://datadifferential.com/
.\" Generated by docutils manpage writer.
.\"
.
.SH AUTHOR
Brian Aker
.SH COPYRIGHT
-2011, Brian Aker
+2011, Brian Aker DataDifferential, http://datadifferential.com/
.\" Generated by docutils manpage writer.
.\"
.
.SH AUTHOR
Brian Aker
.SH COPYRIGHT
-2011, Brian Aker
+2011, Brian Aker DataDifferential, http://datadifferential.com/
.\" Generated by docutils manpage writer.
.\"
.
.SH AUTHOR
Brian Aker
.SH COPYRIGHT
-2011, Brian Aker
+2011, Brian Aker DataDifferential, http://datadifferential.com/
.\" Generated by docutils manpage writer.
.\"
.
.SH AUTHOR
Brian Aker
.SH COPYRIGHT
-2011, Brian Aker
+2011, Brian Aker DataDifferential, http://datadifferential.com/
.\" Generated by docutils manpage writer.
.\"
.
.SH AUTHOR
Brian Aker
.SH COPYRIGHT
-2011, Brian Aker
+2011, Brian Aker DataDifferential, http://datadifferential.com/
.\" Generated by docutils manpage writer.
.\"
.
.SH AUTHOR
Brian Aker
.SH COPYRIGHT
-2011, Brian Aker
+2011, Brian Aker DataDifferential, http://datadifferential.com/
.\" Generated by docutils manpage writer.
.\"
.
.SH AUTHOR
Brian Aker
.SH COPYRIGHT
-2011, Brian Aker
+2011, Brian Aker DataDifferential, http://datadifferential.com/
.\" Generated by docutils manpage writer.
.\"
.
.sp
Copy a set of keys to stdout
.SH SYNOPSIS
-.sp
-.nf
-.ft C
-memcat [options] key key ...
-.ft P
-.fi
+.INDENT 0.0
+.TP
+.B \-\-help
+.UNINDENT
.SH DESCRIPTION
.sp
\fBmemcat\fP outputs to stdout the value a single or multiple set of keys
.SH AUTHOR
Brian Aker
.SH COPYRIGHT
-2011, Brian Aker
+2011, Brian Aker DataDifferential, http://datadifferential.com/
.\" Generated by docutils manpage writer.
.\"
.
.sp
Copies files to a collection of memcached servers
.SH SYNOPSIS
-.sp
-.nf
-.ft C
-memcp [options] file file <servers>
-.ft P
-.fi
+.INDENT 0.0
+.TP
+.B \-\-help
+.UNINDENT
.SH DESCRIPTION
.sp
\fBmemcp\fP copies one or more files into memcached(1) servers.
.SH AUTHOR
Brian Aker
.SH COPYRIGHT
-2011, Brian Aker
+2011, Brian Aker DataDifferential, http://datadifferential.com/
.\" Generated by docutils manpage writer.
.\"
.
.sp
Dump a list of keys from a server.
.SH SYNOPSIS
+.INDENT 0.0
+.TP
+.B \-\-help
+.UNINDENT
.SH DESCRIPTION
.sp
\fBmemdump\fP currently dumps a list of "keys" from all servers that
.SH AUTHOR
Brian Aker
.SH COPYRIGHT
-2011, Brian Aker
+2011, Brian Aker DataDifferential, http://datadifferential.com/
.\" Generated by docutils manpage writer.
.\"
.
.sp
Translate a memcached error code to a string
.SH SYNOPSIS
-.sp
-.nf
-.ft C
-memerror [options] error_code
-.ft P
-.fi
+.INDENT 0.0
+.TP
+.B \-\-help
+.UNINDENT
.SH DESCRIPTION
.sp
\fBmemerror\fP translate an error code from libmemcached(3) to a human
.SH AUTHOR
Brian Aker
.SH COPYRIGHT
-2011, Brian Aker
+2011, Brian Aker DataDifferential, http://datadifferential.com/
.\" Generated by docutils manpage writer.
.\"
.
.
.sp
Reset a server or list of servers
-.sp
-.nf
-.ft C
-memflush [options]
-.ft P
-.fi
+.SH SYNOPSIS
+.INDENT 0.0
+.TP
+.B \-\-help
+.UNINDENT
+.SH DESCRIPTION
.sp
\fBmemflush\fP resets the contents of memcached(1) servers.
This means all data in these servers will be deleted.
Brian Aker, <\fI\%brian@tangent.org\fP>
.sp
Mark Atwood <\fI\%mark@fallenpegasus.com\fP>
+.SH SEE ALSO
.sp
memcached(1) libmemcached(3)
.SH AUTHOR
Brian Aker
.SH COPYRIGHT
-2011, Brian Aker
+2011, Brian Aker DataDifferential, http://datadifferential.com/
.\" Generated by docutils manpage writer.
.\"
.
.sp
memrm \- Remove a key(s) from a collection of memcached servers
.SH SYNOPSIS
-.sp
-.nf
-.ft C
-memrm [options] key key ...
-.ft P
-.fi
+.INDENT 0.0
+.TP
+.B \-\-help
+.UNINDENT
.SH DESCRIPTION
.sp
\fBmemrm\fP removes items, specified by key, from memcached(1) servers.
.SH AUTHOR
Brian Aker
.SH COPYRIGHT
-2011, Brian Aker
+2011, Brian Aker DataDifferential, http://datadifferential.com/
.\" Generated by docutils manpage writer.
.\"
.
..
.\" Man page generated from reStructeredText.
.
-.sp
-memslap \- Load testing and benchmarking tool for memcached
.SH SYNOPSIS
.SH DESCRIPTION
.sp
environment variable \fBMEMCACHED_SERVERS\fP.
.SH SEE ALSO
.sp
-\fImemcached(1)\fP \fIlibmemcached(3)\fP \fImemcached_strerror(3)\fP
+\fImemcached(1)\fP \fIlibmemcached(3)\fP
.SH AUTHOR
Brian Aker
.SH COPYRIGHT
-2011, Brian Aker
+2011, Brian Aker DataDifferential, http://datadifferential.com/
.\" Generated by docutils manpage writer.
.\"
.
.sp
memstat \- Display the operating status of a single or group of memcached servers
.SH SYNOPSIS
-.sp
-.nf
-.ft C
-memstat [options]
-.ft P
-.fi
+.INDENT 0.0
+.TP
+.B \-\-help
+.UNINDENT
.SH DESCRIPTION
.sp
\fBmemstat\fP dumps the state of memcached(1) servers.
etc..).
.sp
For a full list of operations run the tool with the \fB\-\-help\fP option.
-.SS HOME
+.SH HOME
.sp
To find out more information please check:
\fI\%http://launchpad.org/libmemcached\fP
.SH AUTHOR
Brian Aker
.SH COPYRIGHT
-2011, Brian Aker
+2011, Brian Aker DataDifferential, http://datadifferential.com/
.\" Generated by docutils manpage writer.
.\"
.
-========
-memaslap
-========
+==================================================
+memaslap - Load testing and benchmarking a server
+==================================================
-memaslap - Load testing and benchmarking tool for memcached
-
-
-********
+--------
SYNOPSIS
-********
-
-
+--------
-.. code-block:: perl
-
- memaslap [options]
+.. program:: memaslap
+.. option:: --help
-
-***********
+-----------
DESCRIPTION
-***********
+-----------
\ **memaslap**\ is a load generation and benchmark tool for memcached(1)
environment variable \ ``MEMCACHED_SERVERS``\ .
-********
+--------
FEATURES
-********
+--------
Memslap is developed to for the following purposes:
-*******
+-------
DETAILS
-*******
+-------
Effective implementation of network.
-*****
+-----
USAGE
-*****
+-----
Below are some usage samples:
-******************
+------------------
Configuration file
-******************
+------------------
This section describes the format of the configuration file. By default
.. code-block:: perl
- ***************************************************************************
+ ---------------------------------------------------------------------------
#comments should start with '#'
#key
#start_len end_len proportion
-****************
+----------------
Format of output
-****************
+----------------
At the beginning, memaslap displays some configuration information as follows:
-*******
+-------
OPTIONS
-*******
+-------
-s, --servers=
Display the version of the application and then exit.
-********
+--------
EXAMPLES
-********
+--------
memaslap -s 127.0.0.1:11211 -S 5s
memaslap -s 127.0.0.1:11211,127.0.0.1:11212 -F config -t 2m -p 2
-****
+----
HOME
-****
+----
To find out more information please check:
`http://launchpad.org/libmemcached <http://launchpad.org/libmemcached>`_
-*******
+-------
AUTHORS
-*******
+-------
Mingqiang Zhuang <mingqiangzhuang@hengtiansoft.com> (Schooner Technolgy)
Brian Aker, <brian@tangent.org>
-********
+--------
SEE ALSO
-********
-
+--------
-:manpage:`memcached(1)` :manpage:`libmemcached(3)` :manpage:`memcached_strerror(3)`
+:manpage:`memcached(1)` :manpage:`libmemcached(3)`
=================
-memcached_analyze
+Anaylzing servers
=================
Get and set a callback
-*******
+-------
LIBRARY
-*******
+-------
C Client Library for memcached (libmemcached, -lmemcached)
SYNOPSIS
--------
-
-
-.. code-block:: perl
-
- #include <libmemcached/memcached.h>
+#include <libmemcached/memcached.h>
- memcached_return_t
- memcached_callback_set (memcached_st *ptr,
- memcached_callback_t flag,
- void *data);
+.. c:function:: memcached_return_t memcached_callback_set (memcached_st *ptr, memcached_callback_t flag, void *data);
- void *
- memcached_callback_get (memcached_st *ptr,
- memcached_callback_t flag,
- memcached_return_t *error);
+.. c:function:: void * memcached_callback_get (memcached_st *ptr, memcached_callback_t flag, memcached_return_t *error);
of the callbacks
-MEMCACHED_CALLBACK_CLEANUP_FUNCTION
+.. c:var:: MEMCACHED_CALLBACK_CLEANUP_FUNCTION
When memcached_delete() is called this function will be excuted. At the
point of its execution all connections have been closed.
-MEMCACHED_CALLBACK_CLONE_FUNCTION
+.. c:var:: MEMCACHED_CALLBACK_CLONE_FUNCTION
When memcached_delete() is called this function will be excuted. At the
point of its execution all connections have been closed.
-MEMCACHED_CALLBACK_PREFIX_KEY
+.. c:var:: MEMCACHED_CALLBACK_PREFIX_KEY
You can set a value which will be used to create a domain for your keys.
The value specified here will be prefixed to each of your keys. The value can not
If you set a value with the value being NULL then the prefix key is disabled.
-MEMCACHED_CALLBACK_USER_DATA
+.. c:var:: MEMCACHED_CALLBACK_USER_DATA
This allows you to store a pointer to a specifc piece of data. This can be
retrieved from inside of memcached_fetch_execute(). Cloning a memcached_st
-MEMCACHED_CALLBACK_MALLOC_FUNCTION
+.. c:var:: MEMCACHED_CALLBACK_MALLOC_FUNCTION
DEPRECATED: use memcached_set_memory_allocators instead.
-MEMCACHED_CALLBACK_REALLOC_FUNCTION
+.. c:var:: MEMCACHED_CALLBACK_REALLOC_FUNCTION
DEPRECATED: use memcached_set_memory_allocators instead.
-MEMCACHED_CALLBACK_FREE_FUNCTION
+.. c:var:: MEMCACHED_CALLBACK_FREE_FUNCTION
DEPRECATED: use memcached_set_memory_allocators instead.
-MEMCACHED_CALLBACK_GET_FAILURE
+.. c:var:: MEMCACHED_CALLBACK_GET_FAILURE
This function implements the read through cache behavior. On failure of retrieval this callback will be called.
You are responsible for populating the result object provided. This result object will then be stored in the server and
-MEMCACHED_CALLBACK_DELETE_TRIGGER
+.. c:var:: MEMCACHED_CALLBACK_DELETE_TRIGGER
- This function implements a trigger upon successful deletion of a key. The memcached_st structure will need to be cloned
- in order to make use of it.
+This function implements a trigger upon successful deletion of a key. The memcached_st structure will need to be cloned in order to make use of it.
- The prototype for this is:
- typedef memcached_return_t (\*memcached_trigger_delete_key)(memcached_st \*ptr, char \*key, size_t key_length);
+The prototype for this is: typedef memcached_return_t (\*memcached_trigger_delete_key)(memcached_st \*ptr, char \*key, size_t key_length);
-******
+------
RETURN
-******
+------
memcached_callback_get() return the function or structure that was provided.
otherwise MEMCACHED_FAILURE on error.
-****
+----
HOME
-****
+----
To find out more information please check:
`https://launchpad.net/libmemcached <https://launchpad.net/libmemcached>`_
-******
+------
AUTHOR
-******
+------
Brian Aker, <brian@tangent.org>
Create a memcached_st structure
-*******
+-------
LIBRARY
-*******
+-------
C Client Library for memcached (libmemcached, -lmemcached)
SYNOPSIS
--------
-
-
-.. code-block:: perl
-
- #include <libmemcached/memcached.h>
+#include <libmemcached/memcached.h>
- memcached_st *memcached_create (memcached_st *ptr);
+.. c:function:: memcached_st *memcached_create (memcached_st *ptr);
- void memcached_free (memcached_st *ptr);
+.. c:function:: void memcached_free (memcached_st *ptr);
- memcached_st *memcached_clone (memcached_st *destination, memcached_st *source);
+.. c:function:: memcached_st *memcached_clone (memcached_st *destination, memcached_st *source);
- void memcached_servers_reset(memcached_st);
+.. c:function:: void memcached_servers_reset(memcached_st);
heap allocated structures.
-******
+------
RETURN
-******
+------
memcached_create() returns a pointer to the memcached_st that was created
(or initialized). On an allocation failure, it returns NULL.
-****
+----
HOME
-****
+----
To find out more information please check:
`https://launchpad.net/libmemcached <https://launchpad.net/libmemcached>`_
-******
+------
AUTHOR
-******
+------
Brian Aker, <brian@tangent.org>
-.. highlight:: perl
-
-
-memcached_delete
-----------------
+===========================
+Deleting data from a server
+===========================
Delete a key
-*******
+-------
LIBRARY
-*******
+-------
C Client Library for memcached (libmemcached, -lmemcached)
#include <libmemcached/memcached.h>
- memcached_return_t
- memcached_delete (memcached_st *ptr,
- const char *key, size_t key_length,
- time_t expiration);
+ memcached_return_t memcached_delete (memcached_st *ptr, const char *key, size_t key_length, time_t expiration);
- memcached_return_t
- memcached_delete_by_key (memcached_st *ptr,
- const char *master_key, size_t master_key_length,
- const char *key, size_t key_length,
- time_t expiration);
+ memcached_return_t memcached_delete_by_key (memcached_st *ptr, const char *master_key, size_t master_key_length, const char *key, size_t key_length, time_t expiration);
the 1.4 version.
-******
+------
RETURN
-******
+------
A value of type \ ``memcached_return_t``\ is returned
means that the message was queued for delivery.
-****
+----
HOME
-****
+----
To find out more information please check:
`https://launchpad.net/libmemcached <https://launchpad.net/libmemcached>`_
-******
+------
AUTHOR
-******
+------
Brian Aker, <brian@tangent.org>
-.. highlight:: perl
-
-
-memcached_dump
---------------
+==========================
+Dumping data from a server
+==========================
Get a list of keys found on memcached servers
-*******
+-------
LIBRARY
-*******
+-------
C Client Library for memcached (libmemcached, -lmemcached)
Currently the binar protocol is not testsed.
-******
+------
RETURN
-******
+------
A value of type \ ``memcached_return_t``\ is returned
Use memcached_strerror() to translate this value to a printable string.
-****
+----
HOME
-****
+----
To find out more information please check:
`https://launchpad.net/libmemcached <https://launchpad.net/libmemcached>`_
-******
+------
AUTHOR
-******
+------
Brian Aker, <brian@tangent.org>
-.. highlight:: perl
-
-
-memcached_flush
---------------*
+=====================================
+Wiping clean the contents of a server
+=====================================
Wipe contents of memcached servers
-*******
+-------
LIBRARY
-*******
+-------
C Client Library for memcached (libmemcached, -lmemcached)
added.
-******
+------
RETURN
-******
+------
A value of type \ ``memcached_return_t``\ is returned
Use memcached_strerror() to translate this value to a printable string.
-****
+----
HOME
-****
+----
To find out more information please check:
`https://launchpad.net/libmemcached <https://launchpad.net/libmemcached>`_
-******
+------
AUTHOR
-******
+------
Brian Aker, <brian@tangent.org>
-.. highlight:: perl
-
-
-memcached_flush_buffers
-----------------------*
+=======================
+Flushing client buffers
+=======================
Flush buffers and send buffered commands
-*******
+-------
LIBRARY
-*******
+-------
C Client Library for memcached (libmemcached, -lmemcached)
SYNOPSIS
--------
-
-
-.. code-block:: perl
-
- #include <libmemcached/memcached.h>
+#include <libmemcached/memcached.h>
- memcached_return_t
- memcached_flush_buffers (memcached_st *ptr);
+.. c:function:: memcached_return_t memcached_flush_buffers (memcached_st *ptr);
all buffers by sending the buffered commands to the server for processing.
-******
+------
RETURN
-******
+------
A value of type \ ``memcached_return_t``\ is returned
Use memcached_strerror() to translate this value to a printable string.
-****
+----
HOME
-****
+----
To find out more information please check:
`https://launchpad.net/libmemcached <https://launchpad.net/libmemcached>`_
-******
+------
AUTHOR
-******
+------
+
+Brian Aker, <brian@tangent.org>
Trond Norbye, <trond.norbye@gmail.com>
-.. highlight:: perl
-
-
-memcached_generate_hash_value
----------------------------**
+===============================
+Generating hash values directly
+===============================
Hash a key value
-*******
+-------
LIBRARY
-*******
+-------
C Client Library for memcached (libmemcached, -lmemcached)
of the memcached_st structure.
As of version 0.36 all hash methods have been placed into the library
-libmemcached(3) which is linked with libmemcached(3).
+libhashkit(3) which is linked with libmemcached(3). For more information please see its documentation.
-******
+------
RETURN
-******
+------
A 32-bit integer which is the result of hashing the given key.
returned.
-****
+----
HOME
-****
+----
To find out more information please check:
`https://launchpad.net/libmemcached <https://launchpad.net/libmemcached>`_
-******
+------
AUTHOR
-******
+------
Brian Aker, <brian@tangent.org>
Working with memcached pools
============================
-
-Manage pools
-
-
-*******
-LIBRARY
-*******
-
-
-C Client Library for memcached (libmemcachedutil, -lmemcachedutil)
-
-
--------
SYNOPSIS
--------
+#include <libmemcached/memcached_pool.h>
-
-.. code-block:: perl
-
- #include <libmemcached/memcached_pool.h>
+.. c:function:: memcached_pool_st * memcached_pool_create(memcached_st* mmc, int initial, int max);
- memcached_pool_st * memcached_pool_create(memcached_st* mmc, int initial, int max);
+.. c:function:: memcached_st * memcached_pool_destroy(memcached_pool_st* pool);
- memcached_st * memcached_pool_destroy(memcached_pool_st* pool);
+.. c:function:: memcached_st * memcached_pool_pop (memcached_pool_st* pool, bool block, memcached_return_t *rc);
- memcached_st * memcached_pool_pop (memcached_pool_st* pool, bool block, memcached_return_t *rc);
+.. c:function:: memcached_return_t memcached_pool_push(memcached_pool_st* pool, memcached_st *mmc);
- memcached_return_t memcached_pool_push(memcached_pool_st* pool, memcached_st *mmc);
+.. c:function:: memcached_st *memcached_create (memcached_st *ptr);
- memcached_st *memcached_create (memcached_st *ptr);
+.. c:function:: memcached_return_t memcached_pool_behavior_set(memcached_pool_st *pool, memcached_behavior_t flag, uint64_t data)
- memcached_return_t memcached_pool_behavior_set(memcached_pool_st *pool, memcached_behavior_t flag, uint64_t data)
-
- memcached_return_t memcached_pool_behavior_get(memcached_pool_st *pool, memcached_behavior_t flag, uint64_t *value)
+.. c:function:: memcached_return_t memcached_pool_behavior_get(memcached_pool_st *pool, memcached_behavior_t flag, uint64_t *value)
+Compile and link with -lmemcachedutil -lmemcached
-----------
used to get/set behavior flags on all connections in the pool.
-******
+------
RETURN
-******
+------
memcached_pool_create() returns a pointer to the newly created
returns MEMCACHED_SUCCESS upon success.
-****
+----
HOME
-****
+----
To find out more information please check:
`https://launchpad.net/libmemcached <https://launchpad.net/libmemcached>`_
-******
+------
AUTHOR
-******
+------
+
+Brian Aker, <brian@tangent.org>
Trond Norbye, <trond.norbye@gmail.com>
-.. highlight:: perl
-
-
-memcached_quit
---------------
+====================================
+Disconnecting a client from a server
+====================================
Disconnect from all servers
-*******
+-------
LIBRARY
-*******
+-------
C Client Library for memcached (libmemcached, -lmemcached)
reset connections during the middle of a memcached_fetch().
-******
+------
RETURN
-******
+------
A value of type \ ``memcached_return``\ is returned
Use memcached_strerror() to translate this value to a printable string.
-****
+----
HOME
-****
+----
To find out more information please check:
`https://launchpad.net/libmemcached <https://launchpad.net/libmemcached>`_
-******
+------
AUTHOR
-******
+------
Brian Aker, <brian@tangent.org>
-.. highlight:: perl
+============
+SASL support
+============
-memcached_set_sasl_callbacks, memcached_get_sasl_callbacks, memcached_sasl_set_auth_data, memcached_destroy_sasl_auth_data
-------------------------------------------------------------------------------------------------------------------------**
-
-
-SASL tests
-
-
-*******
+-------
LIBRARY
-*******
+-------
C Client Library for memcached (libmemcached, -lmemcached)
calling sasl_done() when you are done using SASL from libmemcached.
-******
+------
RETURN
-******
+------
memcached_get_sasl_callbacks() returns the callbacks currently used
memcached_get_sasl_set_auth_data() returns MEMCACHED_SUCCESS upon success.
-****
+----
HOME
-****
+----
To find out more information please check:
`http://libmemcached.org/ <http://libmemcached.org/>`_
-******
+------
AUTHOR
-******
+------
+
+Brian Aker, <brian@tangent.org>
Trond Norbye, <trond.norbye@gmail.com>
-.. code-block:: perl
-
- memcat [options] key key ...
+.. program:: memcat
+.. option:: --help
-----------
SYNOPSIS
--------
+.. program:: memcp
-
-.. code-block:: perl
-
- memcp [options] file file <servers>
-
+.. option:: --help
-----------
-=======
-memdump
-=======
+=============================
+memdump - Dumping your server
+=============================
Dump a list of keys from a server.
SYNOPSIS
--------
-.. program:: memdump [options]
+.. program:: memdump
+
+.. option:: --help
-----------
DESCRIPTION
SYNOPSIS
--------
+.. program:: memerror
-
-.. code-block:: perl
-
- memerror [options] error_code
-
-
+.. option:: --help
-----------
DESCRIPTION
----------------------------------------
+=======================================
memflush - flush all data from a server
----------------------------------------
+=======================================
Reset a server or list of servers
SYNOPSIS
--------
+.. program:: memflush
-
-.. code-block:: perl
-
- memflush [options]
-
-
+.. option:: --help
-----------
DESCRIPTION
For a full list of operations run the tool with the \ **--help**\ option.
-****
+----
HOME
-****
+----
To find out more information please check:
`https://launchpad.net/libmemcached <https://launchpad.net/libmemcached>`_
-******
+------
AUTHOR
-******
+------
Brian Aker, <brian@tangent.org>
SEE ALSO
--------
-
memcached(1) libmemcached(3)
-
-.. code-block:: perl
+.. program:: memrm
- memrm [options] key key ...
+.. option:: --help
-=======
-memslap
-=======
-
-
-memslap - Load testing and benchmarking tool for memcached
+=================================================
+memslap - Load testing and benchmarking a server
+=================================================
--------
--------
-:manpage:`memcached(1)` :manpage:`libmemcached(3)` :manpage:`memcached_strerror(3)`
+:manpage:`memcached(1)` :manpage:`libmemcached(3)`
-=======
-memstat
-=======
+=========================================
+memstat - Gather statistics from a server
+=========================================
memstat - Display the operating status of a single or group of memcached servers
SYNOPSIS
--------
+.. program:: memstat
-
-.. code-block:: perl
-
- memstat [options]
-
-
+.. option:: --help
-----------
DESCRIPTION
For a full list of operations run the tool with the \ **--help**\ option.
-****
+----
HOME
-****
+----
To find out more information please check: