dist_man_MANS=
MAINTAINERCLEANFILES=
+if IS_VCS_CHECKOUT
+SUBDIRS= docs
+endif
+
#includes additional rules from aminclude.am
@INC_AMINCLUDE@
include libmemcachedutil-1.0/include.am
include clients/include.am
-include docs/include.am
+
include man/include.am
if BUILD_LIBMEMCACHED_PROTOCOL
@echo "Files that need to be either removed or checked in:"
@bzr unknowns
-clean-local: clean-libtest-check clean-docs-check clean-rpm
+clean-local: clean-libtest-check clean-rpm
lcov: lcov-clean check
maintainer-clean-local:
find . -type f -name '*~' -exec rm -f '{}' \;
- -rm -f man/*.1
- -rm -f man/*.3
- -rm -f man/*.8
- -rm -rf man/.doctrees/
+ -$(RM) $(dist_man_MANS)
-rm -f Makefile.in
-rm -f aclocal.m4
-rm -f build-aux/compile
AX_AM_JOBSERVER([yes])
AC_CONFIG_FILES([Makefile
- docs/conf.py
+ docs/source/conf.py
libmemcached-1.0/configure.h
support/libmemcached.pc
support/libmemcached.spec
--- /dev/null
+# Makefile for Sphinx documentation
+
+# You can set these variables from the command line.
+SPHINXOPTS =
+SPHINXBUILD = sphinx-build
+PAPER =
+BUILDDIR = build
+
+# Custom rules used by top level make
+MANGOAL:= $(BUILDDIR)/man/.dirstamp
+HTMLGOAL:= $(BUILDDIR)/html/.dirstamp
+
+.PHONY: all distclean distcheck maintainer-clean check test
+all: $(MANGOAL) $(HTMLGOAL)
+
+maintainer-clean distclean: clean
+
+distcheck check distdir:
+
+RST_FILES= $(shell find source -type f -name '*.rst')
+
+.DEFAULT_GOAL:= all
+
+.NOTPARALLEL:
+
+SOURCES=
+SOURCES+= $(RST_FILES)
+SOURCES+= source/conf.py
+SOURCES+= Makefile
+
+$(MANGOAL): $(SOURCES)
+ @$(MAKE) $(AM_MAKEFLAGS) man
+ @touch $@
+
+$(HTMLGOAL): $(SOURCES)
+ @$(MAKE) $(AM_MAKEFLAGS) html
+ @touch $@
+
+# User-friendly check for sphinx-build
+ifeq ($(shell which $(SPHINXBUILD) >/dev/null 2>&1; echo $$?), 1)
+$(error The '$(SPHINXBUILD)' command was not found. Make sure you have Sphinx installed, then set the SPHINXBUILD environment variable to point to the full path of the '$(SPHINXBUILD)' executable. Alternatively you can add the directory with the executable to your PATH. If you don't have Sphinx installed, grab it from http://sphinx-doc.org/)
+endif
+
+# Internal variables.
+PAPEROPT_a4 = -D latex_paper_size=a4
+PAPEROPT_letter = -D latex_paper_size=letter
+ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) source
+# the i18n builder cannot share the environment and doctrees with the others
+I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) source
+
+.PHONY: help clean dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text changes linkcheck doctest gettext
+
+help:
+ @echo "Please use \`make <target>' where <target> is one of"
+ @echo " html to make standalone HTML files"
+ @echo " dirhtml to make HTML files named index.html in directories"
+ @echo " singlehtml to make a single large HTML file"
+ @echo " pickle to make pickle files"
+ @echo " json to make JSON files"
+ @echo " htmlhelp to make HTML files and a HTML help project"
+ @echo " qthelp to make HTML files and a qthelp project"
+ @echo " devhelp to make HTML files and a Devhelp project"
+ @echo " epub to make an epub"
+ @echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
+ @echo " latexpdf to make LaTeX files and run them through pdflatex"
+ @echo " latexpdfja to make LaTeX files and run them through platex/dvipdfmx"
+ @echo " text to make text files"
+ @echo " man to make manual pages"
+ @echo " texinfo to make Texinfo files"
+ @echo " info to make Texinfo files and run them through makeinfo"
+ @echo " gettext to make PO message catalogs"
+ @echo " changes to make an overview of all changed/added/deprecated items"
+ @echo " xml to make Docutils-native XML files"
+ @echo " pseudoxml to make pseudoxml-XML files for display purposes"
+ @echo " linkcheck to check all external links for integrity"
+ @echo " doctest to run all doctests embedded in the documentation (if enabled)"
+
+clean:
+ @$(RM) -r $(BUILDDIR)/*
+
+html: $(SOURCES)
+ $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
+
+dirhtml:
+ $(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml
+ @echo
+ @echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."
+
+singlehtml:
+ $(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml
+ @echo
+ @echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml."
+
+pickle:
+ $(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle
+
+json:
+ $(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json
+ @echo
+ @echo "Build finished; now you can process the JSON files."
+
+htmlhelp:
+ $(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp
+ @echo
+ @echo "Build finished; now you can run HTML Help Workshop with the" \
+ ".hhp project file in $(BUILDDIR)/htmlhelp."
+
+qthelp:
+ $(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp
+ @echo
+ @echo "Build finished; now you can run "qcollectiongenerator" with the" \
+ ".qhcp project file in $(BUILDDIR)/qthelp, like this:"
+ @echo "# qcollectiongenerator $(BUILDDIR)/qthelp/gearmand.qhcp"
+ @echo "To view the help file:"
+ @echo "# assistant -collectionFile $(BUILDDIR)/qthelp/gearmand.qhc"
+
+devhelp:
+ $(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp
+ @echo
+ @echo "Build finished."
+ @echo "To view the help file:"
+ @echo "# mkdir -p $$HOME/.local/share/devhelp/gearmand"
+ @echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/gearmand"
+ @echo "# devhelp"
+
+epub:
+ $(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub
+ @echo
+ @echo "Build finished. The epub file is in $(BUILDDIR)/epub."
+
+latex:
+ $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
+ @echo
+ @echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex."
+ @echo "Run \`make' in that directory to run these through (pdf)latex" \
+ "(use \`make latexpdf' here to do that automatically)."
+
+latexpdf:
+ $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
+ @echo "Running LaTeX files through pdflatex..."
+ $(MAKE) -C $(BUILDDIR)/latex all-pdf
+ @echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
+
+latexpdfja:
+ $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
+ @echo "Running LaTeX files through platex and dvipdfmx..."
+ $(MAKE) -C $(BUILDDIR)/latex all-pdf-ja
+ @echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
+
+text:
+ $(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text
+ @echo
+ @echo "Build finished. The text files are in $(BUILDDIR)/text."
+
+man: $(SOURCES)
+ $(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man
+
+texinfo:
+ $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
+ @echo
+ @echo "Build finished. The Texinfo files are in $(BUILDDIR)/texinfo."
+ @echo "Run \`make' in that directory to run these through makeinfo" \
+ "(use \`make info' here to do that automatically)."
+
+info:
+ $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
+ @echo "Running Texinfo files through makeinfo..."
+ make -C $(BUILDDIR)/texinfo info
+ @echo "makeinfo finished; the Info files are in $(BUILDDIR)/texinfo."
+
+gettext:
+ $(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale
+ @echo
+ @echo "Build finished. The message catalogs are in $(BUILDDIR)/locale."
+
+changes:
+ $(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes
+ @echo
+ @echo "The overview file is in $(BUILDDIR)/changes."
+
+linkcheck:
+ $(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck
+ @echo
+ @echo "Link check complete; look for any errors in the above output " \
+ "or in $(BUILDDIR)/linkcheck/output.txt."
+
+doctest:
+ @$(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest
+ @echo "Testing of doctests in the sources finished, look at the " \
+ "results in $(BUILDDIR)/doctest/output.txt."
+
+xml:
+ $(SPHINXBUILD) -b xml $(ALLSPHINXOPTS) $(BUILDDIR)/xml
+ @echo
+ @echo "Build finished. The XML files are in $(BUILDDIR)/xml."
+
+pseudoxml:
+ $(SPHINXBUILD) -b pseudoxml $(ALLSPHINXOPTS) $(BUILDDIR)/pseudoxml
+ @echo
+ @echo "Build finished. The pseudo-XML files are in $(BUILDDIR)/pseudoxml."
+++ /dev/null
-==================================================
-memaslap - Load testing and benchmarking a server
-==================================================
-
-
---------
-SYNOPSIS
---------
-
-memaslap [options]
-
-.. program:: memaslap
-
-.. option:: --help
-
-.. envvar:: MEMCACHED_SERVERS
-
------------
-DESCRIPTION
------------
-
-
-:program:`memaslap` is a load generation and benchmark tool for memcached
-servers. It generates configurable workload such as threads, concurrencies,
-connections, run time, overwrite, miss rate, key size, value size, get/set
-proportion, expected throughput, and so on. Furthermore, it also testss data
-verification, expire-time verification, UDP, binary protocol, facebook test,
-replication test, multi-get and reconnection, etc.
-
-Memaslap manages network connections like memcached with
-libevent. Each thread of memaslap is bound with a CPU core, all
-the threads don't communicate with each other, and there are several socket
-connections in each thread. Each connection keeps key size distribution,
-value size distribution, and command distribution by itself.
-
-You can specify servers via the :option:`memslap --servers` option or via the
-environment variable :envvar:`MEMCACHED_SERVERS`.
-
-
---------
-FEATURES
---------
-
-
-Memslap is developed to for the following purposes:
-
-
-Manages network connections with libevent asynchronously.
-
-
-
-Set both TCP and UDP up to use non-blocking IO.
-
-
-
-Improves parallelism: higher performance in multi-threads environments.
-
-
-
-Improves time efficiency: faster processing speed.
-
-
-
-Generates key and value more efficiently; key size distribution and value size distribution are configurable.
-
-
-
-Supports get, multi-get, and set commands; command distribution is configurable.
-
-
-
-Supports controllable miss rate and overwrite rate.
-
-
-
-Supports data and expire-time verification.
-
-
-
-Supports dumping statistic information periodically.
-
-
-
-Supports thousands of TCP connections.
-
-
-
-Supports binary protocol.
-
-
-
-Supports facebook test (set with TCP and multi-get with UDP) and replication test.
-
-
-
-
--------
-DETAILS
--------
-
-
-Effective implementation of network.
-____________________________________
-
-
-For memaslap, both TCP and UDP use non-blocking network IO. All
-the network events are managed by libevent as memcached. The network module
-of memaslap is similar to memcached. Libevent can ensure
-memaslap can handle network very efficiently.
-
-
-Effective implementation of multi-threads and concurrency
-_________________________________________________________
-
-
-Memslap has the similar implementation of multi-threads to
-memcached. Memslap creates one or more self-governed threads;
-each thread is bound with one CPU core if the system testss setting CPU
-core affinity.
-
-In addition, each thread has a libevent to manage the events of the network;
-each thread has one or more self-governed concurrencies; and each
-concurrency has one or more socket connections. All the concurrencies don’t
-communicate with each other even though they are in the same thread.
-
-Memslap can create thousands of socket connections, and each
-concurrency has tens of socket connections. Each concurrency randomly or
-sequentially selects one socket connection from its socket connection pool
-to run, so memaslap can ensure each concurrency handles one
-socket connection at any given time. Users can specify the number of
-concurrency and socket connections of each concurrency according to their
-expected workload.
-
-
-Effective implementation of generating key and value
-____________________________________________________
-
-
-In order to improve time efficiency and space efficiency,
-memaslap creates a random characters table with 10M characters. All the
-suffixes of keys and values are generated from this random characters table.
-
-Memslap uses the offset in the character table and the length
-of the string to identify a string. It can save much memory.
-Each key contains two parts, a prefix and a suffix. The prefix is an
-uint64_t, 8 bytes. In order to verify the data set before,
-memaslap need to ensure each key is unique, so it uses the prefix to identify
-a key. The prefix cannot include illegal characters, such as ‘\r’, ‘\n’,
-‘\0’ and ‘ ‘. And memaslap has an algorithm to ensure that.
-
-Memslap doesn’t generate all the objects (key-value pairs) at
-the beginning. It only generates enough objects to fill the task window
-(default 10K objects) of each concurrency. Each object has the following
-basic information, key prefix, key suffix offset in the character table, key
-length, value offset in the character table, and value length.
-
-In the work process, each concurrency sequentially or randomly selects an
-object from the window to do set operation or get operation. At the same
-time, each concurrency kicks objects out of its window and adds new object
-into it.
-
-
-Simple but useful task scheduling
-_________________________________
-
-
-Memslap uses libevent to schedule all the concurrencies of
-threads, and each concurrency schedules tasks based on the local task
-window. Memslap assumes that if each concurrency keeps the same
-key distribution, value distribution and commands distribution, from
-outside, memaslap keeps all the distribution as a whole.
-Each task window includes a lot of objects, each object stores its basic
-information, such as key, value, expire time, and so on. At any time, all
-the objects in the window keep the same and fixed key and value
-distribution. If an object is overwritten, the value of the object will be
-updated. Memslap verifies the data or expire-time according to
-the object information stored in the task window.
-
-Libevent selects which concurrency to handle based on a specific network
-event. Then the concurrency selects which command (get or set) to operate
-based on the command distribution. If it needs to kick out an old object and
-add a new object, in order to keep the same key and value distribution, the
-new object must have the same key length and value length.
-
-If memcached server has two cache layers (memory and SSD), running
-memaslap with different window sizes can get different cache
-miss rates. If memaslap adds enough objects into the windows at
-the beginning, and the cache of memcached cannot store all the objects
-initialized, then memaslap will get some objects from the second
-cache layer. It causes the first cache layer to miss. So the user can
-specify the window size to get the expected miss rate of the first cache
-layer.
-
-
-Useful implementation of multi-servers , UDP, TCP, multi-get and binary protocol
-________________________________________________________________________________
-
-
-Because each thread is self-governed, memaslap can assign
-different threads to handle different memcached servers. This is just one of
-the ways in which memaslap tests multiple servers. The only
-limitation is that the number of servers cannot be greater than the number
-of threads. The other way to test multiple servers is for replication
-test. Each concurrency has one socket connection to each memcached server.
-For the implementation, memaslap can set some objects to one
-memcached server, and get these objects from the other servers.
-
-By default, Memslap does single get. If the user specifies
-multi-get option, memaslap will collect enough get commands and
-pack and send the commands together.
-
-Memslap testss both the ASCII protocol and binary protocol,
-but it runs on the ASCII protocol by default.
-Memslap by default runs on the TCP protocol, but it also
-tests UDP. Because UDP is unreliable, dropped packages and out-of-order
-packages may occur. Memslap creates a memory buffer to handle
-these problems. Memslap tries to read all the response data of
-one command from the server and reorders the response data. If some packages
-get lost, the waiting timeout mechanism can ensure half-baked packages will
-be discarded and the next command will be sent.
-
-
-
------
-USAGE
------
-
-
-Below are some usage samples:
-
-
-memaslap -s 127.0.0.1:11211 -S 5s
-
-
-
-memaslap -s 127.0.0.1:11211 -t 2m -v 0.2 -e 0.05 -b
-
-
-
-memaslap -s 127.0.0.1:11211 -F config -t 2m -w 40k -S 20s -o 0.2
-
-
-
-memaslap -s 127.0.0.1:11211 -F config -t 2m -T 4 -c 128 -d 20 -P 40k
-
-
-
-memaslap -s 127.0.0.1:11211 -F config -t 2m -d 50 -a -n 40
-
-
-
-memaslap -s 127.0.0.1:11211,127.0.0.1:11212 -F config -t 2m
-
-
-
-memaslap -s 127.0.0.1:11211,127.0.0.1:11212 -F config -t 2m -p 2
-
-
-
-The user must specify one server at least to run memaslap. The
-rest of the parameters have default values, as shown below:
-
-Thread number = 1 Concurrency = 16
-
-Run time = 600 seconds Configuration file = NULL
-
-Key size = 64 Value size = 1024
-
-Get/set = 9:1 Window size = 10k
-
-Execute number = 0 Single get = true
-
-Multi-get = false Number of sockets of each concurrency = 1
-
-Reconnect = false Data verification = false
-
-Expire-time verification = false ASCII protocol = true
-
-Binary protocol = false Dumping statistic information
-
-periodically = false
-
-Overwrite proportion = 0% UDP = false
-
-TCP = true Limit throughput = false
-
-Facebook test = false Replication test = false
-
-Key size, value size and command distribution.
-______________________________________________
-
-
-All the distributions are read from the configuration file specified by user
-with “—cfg_cmd” option. If the user does not specify a configuration file,
-memaslap will run with the default distribution (key size = 64,
-value size = 1024, get/set = 9:1). For information on how to edit the
-configuration file, refer to the “Configuration File” section.
-
-The minimum key size is 16 bytes; the maximum key size is 250 bytes. The
-precision of proportion is 0.001. The proportion of distribution will be
-rounded to 3 decimal places.
-
-The minimum value size is 1 bytes; the maximum value size is 1M bytes. The
-precision of proportion is 0.001. The proportion of distribution will be
-rounded to 3 decimal places.
-Currently, memaslap only testss set and get commands. And it
-testss 100% set and 100% get. For 100% get, it will preset some objects to
-the server.
-
-
-Multi-thread and concurrency
-____________________________
-
-
-The high performance of memaslap benefits from the special
-schedule of thread and concurrency. It’s important to specify the proper
-number of them. The default number of threads is 1; the default number of
-concurrency is 16. The user can use “—threads” and “--concurrency” to
-specify these variables.
-
-If the system tests setting CPU affinity and the number of threads
-specified by the user is greater than 1, memaslap will try to
-bind each thread to a different CPU core. So if you want to get the best
-performance memaslap, it is better to specify the number of
-thread equal to the number of CPU cores. The number of threads specified by
-the user can also be less or greater than the number of CPU cores. Because
-of the limitation of implementation, the number of concurrencies could be
-the multiple of the number of threads.
-
-1. For 8 CPU cores system
-
-For example:
-
---threads=2 --concurrency=128
-
---threads=8 --concurrency=128
-
---threads=8 --concurrency=256
-
---threads=12 --concurrency=144
-
-2. For 16 CPU cores system
-
-For example:
-
---threads=8 --concurrency=128
-
---threads=16 --concurrency=256
-
---threads=16 --concurrency=512
-
---threads=24 --concurrency=288
-
-The memaslap performs very well, when
-used to test the performance of memcached servers.
-Most of the time, the bottleneck is the network or
-the server. If for some reason the user wants to
-limit the performance of memaslap, there
-are two ways to do this:
-
-Decrease the number of threads and concurrencies.
-Use the option “--tps” that memaslap
-provides to limit the throughput. This option allows
-the user to get the expected throughput. For
-example, assume that the maximum throughput is 50
-kops/s for a specific configuration, you can specify
-the throughput equal to or less than the maximum
-throughput using “--tps” option.
-
-
-Window size
-___________
-
-
-Most of the time, the user does not need to specify the window size. The
-default window size is 10k. For Schooner Memcached, the user can specify
-different window sizes to get different cache miss rates based on the test
-case. Memslap testss cache miss rate between 0% and 100%.
-If you use this utility to test the performance of Schooner Memcached, you
-can specify a proper window size to get the expected cache miss rate. The
-formula for calculating window size is as follows:
-
-Assume that the key size is 128 bytes, and the value size is 2048 bytes, and
-concurrency=128.
-
-1. Small cache cache_size=1M, 100% cache miss (all data get from SSD).
-win_size=10k
-
-2. cache_size=4G
-
-(1). cache miss rate 0%
-
-win_size=8k
-
-(2). cache miss rate 5%
-
-win_size=11k
-
-3. cache_size=16G
-
-(1). cache miss rate 0%
-
-win_size=32k
-
-(2). cache miss
-
-rate 5%
-
-win_size=46k
-
-The formula for calculating window size for cache miss rate 0%:
-
-cache_size / concurrency / (key_size + value_size) \* 0.5
-
-The formula for calculating window size for cache miss rate 5%:
-
-cache_size / concurrency / (key_size + value_size) \* 0.7
-
-
-Verification
-____________
-
-
-Memslap testss both data verification and expire-time
-verification. The user can use "--verify=" or "-v" to specify the proportion
-of data verification. In theory, it testss 100% data verification. The
-user can use "--exp_verify=" or "-e" to specify the proportion of
-expire-time verification. In theory, it testss 100% expire-time
-verification. Specify the "--verbose" options to get more detailed error
-information.
-
-For example: --exp_verify=0.01 –verify=0.1 , it means that 1% of the objects
-set with expire-time, 10% of the objects gotten will be verified. If the
-objects are gotten, memaslap will verify the expire-time and
-value.
-
-
-multi-servers and multi-config
-_______________________________
-
-
-Memslap testss multi-servers based on self-governed thread.
-There is a limitation that the number of servers cannot be greater than the
-number of threads. Memslap assigns one thread to handle one
-server at least. The user can use the "--servers=" or "-s" option to specify
-multi-servers.
-
-For example:
-
---servers=10.1.1.1:11211,10.1.1.2:11212,10.1.1.3:11213 --threads=6 --concurrency=36
-
-The above command means that there are 6 threads, with each thread having 6
-concurrencies and that threads 0 and 3 handle server 0 (10.1.1.1); threads 1
-and 4 handle server 1 (10.1.1.2); and thread 2 and 5 handle server 2
-(10.1.1.3).
-
-All the threads and concurrencies in memaslap are self-governed.
-
-So is memaslap. The user can start up several
-memaslap instances. The user can run memaslap on different client
-machines to communicate with the same memcached server at the same. It is
-recommended that the user start different memaslap on different
-machines using the same configuration.
-
-
-Run with execute number mode or time mode
-_________________________________________
-
-
-The default memaslap runs with time mode. The default run time
-is 10 minutes. If it times out, memaslap will exit. Do not
-specify both execute number mode and time mode at the same time; just
-specify one instead.
-
-For example:
-
---time=30s (It means the test will run 30 seconds.)
-
---execute_number=100000 (It means that after running 100000 commands, the test will exit.)
-
-
-Dump statistic information periodically.
-________________________________________
-
-
-The user can use "--stat_freq=" or "-S" to specify the frequency.
-
-For example:
-
---stat_freq=20s
-
-Memslap will dump the statistics of the commands (get and set) at the frequency of every 20
-seconds.
-
-For more information on the format of dumping statistic information, refer to “Format of Output” section.
-
-
-Multi-get
-_________
-
-
-The user can use "--division=" or "-d" to specify multi-get keys count.
-Memslap by default does single get with TCP. Memslap also testss data
-verification and expire-time verification for multi-get.
-
-Memslap testss multi-get with both TCP and UDP. Because of
-the different implementation of the ASCII protocol and binary protocol,
-there are some differences between the two. For the ASCII protocol,
-memaslap sends one “multi-get” to the server once. For the
-binary protocol, memaslap sends several single get commands
-together as “multi-get” to the server.
-
-
-UDP and TCP
-___________
-
-
-Memslap testss both UDP and TCP. For TCP,
-memaslap does not reconnect the memcached server if socket connections are
-lost. If all the socket connections are lost or memcached server crashes,
-memaslap will exit. If the user specifies the “--reconnect”
-option when socket connections are lost, it will reconnect them.
-
-User can use “--udp” to enable the UDP feature, but UDP comes with some
-limitations:
-
-UDP cannot set data more than 1400 bytes.
-
-UDP is not testsed by the binary protocol because the binary protocol of
-memcached does not tests that.
-
-UDP doesn’t tests reconnection.
-
-
-Facebook test
-_____________
-
-
-Set data with TCP and multi-get with UDP. Specify the following options:
-
-"--facebook --division=50"
-
-If you want to create thousands of TCP connections, specify the
-
-"--conn_sock=" option.
-
-For example: --facebook --division=50 --conn_sock=200
-
-The above command means that memaslap will do facebook test,
-each concurrency has 200 socket TCP connections and one UDP socket.
-
-Memslap sets objects with the TCP socket, and multi-gets 50
-objects once with the UDP socket.
-
-If you specify "--division=50", the key size must be less that 25 bytes
-because the UDP packet size is 1400 bytes.
-
-
-Replication test
-________________
-
-
-For replication test, the user must specify at least two memcached servers.
-The user can use “—rep_write=” option to enable feature.
-
-For example:
-
---servers=10.1.1.1:11211,10.1.1.2:11212 –rep_write=2
-
-The above command means that there are 2 replication memcached servers,
-memaslap will set objects to both server 0 and server 1, get
-objects which are set to server 0 before from server 1, and also get objects
-which are set to server 1 before from server 0. If server 0 crashes,
-memaslap will only get objects from server 1. If server 0 comes
-back to life again, memaslap will reconnect server 0. If both
-server 0 and server 1 crash, memaslap will exit.
-
-
-Supports thousands of TCP connections
-_____________________________________
-
-
-Start memaslap with "--conn_sock=" or "-n" to enable this
-feature. Make sure that your system can tests opening thousands of files
-and creating thousands of sockets. However, this feature does not tests
-reconnection if sockets disconnect.
-
-For example:
-
---threads=8 --concurrency=128 --conn_sock=128
-
-The above command means that memaslap starts up 8 threads, each
-thread has 16 concurrencies, each concurrency has 128 TCP socket
-connections, and the total number of TCP socket connections is 128 \* 128 =
-16384.
-
-
-Supports binary protocol
-________________________
-
-
-Start memaslap with "--binary" or "-B" options to enable this
-feature. It testss all the above features except UDP, because the latest
-memcached 1.3.3 does not implement binary UDP protocol.
-
-For example:
-
---binary
-
-Since memcached 1.3.3 doesn't implement binary UDP protocol,
-memaslap does not tests UDP. In addition, memcached 1.3.3 does not tests
-multi-get. If you specify "--division=50" option, it just sends 50 get
-commands together as “mulit-get” to the server.
-
-
-
-------------------
-Configuration file
-------------------
-
-
-This section describes the format of the configuration file. By default
-when no configuration file is specified memaslap reads the default
-one located at ~/.memaslap.cnf.
-
-Below is a sample configuration file:
-
-
-.. code-block:: perl
-
- ---------------------------------------------------------------------------
- #comments should start with '#'
- #key
- #start_len end_len proportion
- #
- #key length range from start_len to end_len
- #start_len must be equal to or greater than 16
- #end_len must be equal to or less than 250
- #start_len must be equal to or greater than end_len
- #memaslap will generate keys according to the key range
- #proportion: indicates keys generated from one range accounts for the total
- generated keys
- #
- #example1: key range 16~100 accounts for 80%
- # key range 101~200 accounts for 10%
- # key range 201~250 accounts for 10%
- # total should be 1 (0.8+0.1+0.1 = 1)
- #
- # 16 100 0.8
- # 101 200 0.1
- # 201 249 0.1
- #
- #example2: all keys length are 128 bytes
- #
- # 128 128 1
- key
- 128 128 1
- #value
- #start_len end_len proportion
- #
- #value length range from start_len to end_len
- #start_len must be equal to or greater than 1
- #end_len must be equal to or less than 1M
- #start_len must be equal to or greater than end_len
- #memaslap will generate values according to the value range
- #proportion: indicates values generated from one range accounts for the
- total generated values
- #
- #example1: value range 1~1000 accounts for 80%
- # value range 1001~10000 accounts for 10%
- # value range 10001~100000 accounts for 10%
- # total should be 1 (0.8+0.1+0.1 = 1)
- #
- # 1 1000 0.8
- # 1001 10000 0.1
- # 10001 100000 0.1
- #
- #example2: all value length are 128 bytes
- #
- # 128 128 1
- value
- 2048 2048 1
- #cmd
- #cmd_type cmd_proportion
- #
- #currently memaslap only testss get and set command.
- #
- #cmd_type
- #set 0
- #get 1
- #
- #example: set command accounts for 50%
- # get command accounts for 50%
- # total should be 1 (0.5+0.5 = 1)
- #
- # cmd
- # 0 0.5
- # 1 0.5
- cmd
- 0 0.1
- 1.0 0.9
-
-
-
-----------------
-Format of output
-----------------
-
-
-At the beginning, memaslap displays some configuration information as follows:
-
-
-servers : 127.0.0.1:11211
-
-
-
-threads count: 1
-
-
-
-concurrency: 16
-
-
-
-run time: 20s
-
-
-
-windows size: 10k
-
-
-
-set proportion: set_prop=0.10
-
-
-
-get proportion: get_prop=0.90
-
-
-
-Where
-_____
-
-
-
-servers : "servers"
-
- The servers used by memaslap.
-
-
-
-threads count
-
- The number of threads memaslap runs with.
-
-
-
-concurrency
-
- The number of concurrencies memaslap runs with.
-
-
-
-run time
-
- How long to run memaslap.
-
-
-
-windows size
-
- The task window size of each concurrency.
-
-
-
-set proportion
-
- The proportion of set command.
-
-
-
-get proportion
-
- The proportion of get command.
-
-
-
-The output of dynamic statistics is something like this:
-
-
-.. code-block:: perl
-
- ---------------------------------------------------------------------------------------------------------------------------------
- Get Statistics
- Type Time(s) Ops TPS(ops/s) Net(M/s) Get_miss Min(us) Max(us)
- Avg(us) Std_dev Geo_dist
- Period 5 345826 69165 65.3 0 27 2198 203
- 95.43 177.29
- Global 20 1257935 62896 71.8 0 26 3791 224
- 117.79 192.60
-
-
- Set Statistics
- Type Time(s) Ops TPS(ops/s) Net(M/s) Get_miss Min(us) Max(us)
- Avg(us) Std_dev Geo_dist
- Period 5 38425 7685 7.3 0 42 628 240
- 88.05 220.21
- Global 20 139780 6989 8.0 0 37 3790 253
- 117.93 224.83
-
-
- Total Statistics
- Type Time(s) Ops TPS(ops/s) Net(M/s) Get_miss Min(us) Max(us)
- Avg(us) Std_dev Geo_dist
- Period 5 384252 76850 72.5 0 27 2198 207
- 94.72 181.18
- Global 20 1397720 69886 79.7 0 26 3791 227
- 117.93 195.60
- ---------------------------------------------------------------------------------------------------------------------------------
-
-
-
-Where
-_____
-
-
-
-Get Statistics
-
- Statistics information of get command
-
-
-
-Set Statistics
-
- Statistics information of set command
-
-
-
-Total Statistics
-
- Statistics information of both get and set command
-
-
-
-Period
-
- Result within a period
-
-
-
-Global
-
- Accumulated results
-
-
-
-Ops
-
- Total operations
-
-
-
-TPS
-
- Throughput, operations/second
-
-
-
-Net
-
- The rate of network
-
-
-
-Get_miss
-
- How many objects can’t be gotten
-
-
-
-Min
-
- The minimum response time
-
-
-
-Max
-
- The maximum response time
-
-
-
-Avg:
-
- The average response time
-
-
-
-Std_dev
-
- Standard deviation of response time
-
-
-
-Geo_dist
-
- Geometric distribution based on natural exponential function
-
-
-
-At the end, memaslap will output something like this:
-
-
-.. code-block:: perl
-
- ---------------------------------------------------------------------------------------------------------------------------------
- Get Statistics (1257956 events)
- Min: 26
- Max: 3791
- Avg: 224
- Geo: 192.60
- Std: 116.23
- Log2 Dist:
- 4: 0 10 84490 215345
- 8: 484890 459823 12543 824
- 12: 31
-
- Set Statistics (139782 events)
- Min: 37
- Max: 3790
- Avg: 253
- Geo: 224.84
- Std: 116.83
- Log2 Dist:
- 4: 0 0 4200 16988
- 8: 50784 65574 2064 167
- 12: 5
-
- Total Statistics (1397738 events)
- Min: 26
- Max: 3791
- Avg: 227
- Geo: 195.60
- Std: 116.60
- Log2 Dist:
- 4: 0 10 88690 232333
- 8: 535674 525397 14607 991
- 12: 36
-
- cmd_get: 1257969
- cmd_set: 139785
- get_misses: 0
- verify_misses: 0
- verify_failed: 0
- expired_get: 0
- unexpired_unget: 0
- written_bytes: 242516030
- read_bytes: 1003702556
- object_bytes: 152086080
- packet_disorder: 0
- packet_drop: 0
- udp_timeout: 0
-
- Run time: 20.0s Ops: 1397754 TPS: 69817 Net_rate: 59.4M/s
- ---------------------------------------------------------------------------------------------------------------------------------
-
-
-
-Where
-_____
-
-
-
-Get Statistics
-
- Get statistics of response time
-
-
-
-Set Statistics
-
- Set statistics of response time
-
-
-
-Total Statistics
-
- Both get and set statistics of response time
-
-
-
-Min
-
- The accumulated and minimum response time
-
-
-
-Max
-
- The accumulated and maximum response time
-
-
-
-Avg
-
- The accumulated and average response time
-
-
-
-Std
-
- Standard deviation of response time
-
-
-
-Log2 Dist
-
- Geometric distribution based on logarithm 2
-
-
-
-cmd_get
-
- Total get commands done
-
-
-
-cmd_set
-
- Total set commands done
-
-
-
-get_misses
-
- How many objects can’t be gotten from server
-
-
-
-verify_misses
-
- How many objects need to verify but can’t get them
-
-
-
-verify_failed
-
- How many objects with insistent value
-
-
-
-expired_get
-
- How many objects are expired but we get them
-
-
-
-unexpired_unget
-
- How many objects are unexpired but we can’t get them
-
-
-
-written_bytes
-
- Total written bytes
-
-
-
-read_bytes
-
- Total read bytes
-
-
-
-object_bytes
-
- Total object bytes
-
-
-
-packet_disorder
-
- How many UDP packages are disorder
-
-
-
-packet_drop
-
- How many UDP packages are lost
-
-
-
-udp_timeout
-
- How many times UDP time out happen
-
-
-
-Run time
-
- Total run time
-
-
-
-Ops
-
- Total operations
-
-
-
-TPS
-
- Throughput, operations/second
-
-
-
-Net_rate
-
- The average rate of network
-
-
-
-
-
--------
-OPTIONS
--------
-
-
--s, --servers=
- List one or more servers to connect. Servers count must be less than
- threads count. e.g.: --servers=localhost:1234,localhost:11211
-
--T, --threads=
- Number of threads to startup, better equal to CPU numbers. Default 8.
-
--c, --concurrency=
- Number of concurrency to simulate with load. Default 128.
-
--n, --conn_sock=
- Number of TCP socks per concurrency. Default 1.
-
--x, --execute_number=
- Number of operations(get and set) to execute for the
- given test. Default 1000000.
-
--t, --time=
- How long the test to run, suffix: s-seconds, m-minutes, h-hours,
- d-days e.g.: --time=2h.
-
--F, --cfg_cmd=
- Load the configure file to get command,key and value distribution list.
-
--w, --win_size=
- Task window size of each concurrency, suffix: K, M e.g.: --win_size=10k.
- Default 10k.
-
--X, --fixed_size=
- Fixed length of value.
-
--v, --verify=
- The proportion of date verification, e.g.: --verify=0.01
-
--d, --division=
- Number of keys to multi-get once. Default 1, means single get.
-
--S, --stat_freq=
- Frequency of dumping statistic information. suffix: s-seconds,
- m-minutes, e.g.: --resp_freq=10s.
-
--e, --exp_verify=
- The proportion of objects with expire time, e.g.: --exp_verify=0.01.
- Default no object with expire time
-
--o, --overwrite=
- The proportion of objects need overwrite, e.g.: --overwrite=0.01.
- Default never overwrite object.
-
--R, --reconnect
- Reconnect tests, when connection is closed it will be reconnected.
-
--U, --udp
- UDP tests, default memaslap uses TCP, TCP port and UDP port of
- server must be same.
-
--a, --facebook
- Whether it enables facebook test feature, set with TCP and multi-get with UDP.
-
--B, --binary
- Whether it enables binary protocol. Default with ASCII protocol.
-
--P, --tps=
- Expected throughput, suffix: K, e.g.: --tps=10k.
-
--p, --rep_write=
- The first nth servers can write data, e.g.: --rep_write=2.
-
--b, --verbose
- Whether it outputs detailed information when verification fails.
-
--h, --help
- Display this message and then exit.
-
--V, --version
- 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 -t 2m -v 0.2 -e 0.05 -b
-
-memaslap -s 127.0.0.1:11211 -F config -t 2m -w 40k -S 20s -o 0.2
-
-memaslap -s 127.0.0.1:11211 -F config -t 2m -T 4 -c 128 -d 20 -P 40k
-
-memaslap -s 127.0.0.1:11211 -F config -t 2m -d 50 -a -n 40
-
-memaslap -s 127.0.0.1:11211,127.0.0.1:11212 -F config -t 2m
-
-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://libmemcached.org/ <http://libmemcached.org/>`_
-
-
--------
-AUTHORS
--------
-
-
-Mingqiang Zhuang <mingqiangzhuang@hengtiansoft.com> (Schooner Technolgy)
-Brian Aker, <brian@tangent.org>
-
-
---------
-SEE ALSO
---------
-
-:manpage:`memcached(1)` :manpage:`libmemcached(3)`
+++ /dev/null
-=======================================================================
-memcapable - Checking a Memcached server capibilities and compatibility
-=======================================================================
-
---------
-SYNOPSIS
---------
-
-memcapable [options]
-
-.. program:: memcapable
-
------------
-DESCRIPTION
------------
-
-:program:`memcapable` connects to the specified memcached server and tries to
-determine its capabilities by running the various commands and verifying
-the response.
-
-
------------
-LIMITATIONS
------------
-
-
-The current version of memcapable will only verify the binary protocol.
-
-
--------
-OPTIONS
--------
-
-
-.. option:: -h hostname
-
-Specify the hostname to connect to. The default is \ *localhost*\
-
-.. option:: -p port
-
-Specify the port number to connect to. The default is \ *11211*\
-
-.. option:: -c
-
-Generate a coredump when it detects an error from the server.
-
-.. option:: -v
-
-Print out the comparison when it detects an error from the server.
-
-.. option:: -t n
-
-Set the timeout from an IO operation to/from the server to \ *n*\ seconds.
-
-
-----
-HOME
-----
-
-
-To find out more information please check:
-`http://libmemcached.org/ <http://libmemcached.org/>`_
-
-
-------
-AUTHOR
-------
-
-
-Trond Norbye, <trond.norbye@gmail.com>
-
-
---------
-SEE ALSO
---------
-
-:manpage:`memcached(1)` :manpage:`libmemcached(3)`
-
+++ /dev/null
-=================================
-memcat - "cat" data from a server
-=================================
-
-
-
---------
-SYNOPSIS
---------
-
-memcat [options] key
-
-Copy a set of keys to stdout
-
-
-.. program:: memcat
-
-
------------
-DESCRIPTION
------------
-
-
-:program:`memcat` outputs to stdout the value a single or multiple set of keys
-stored in a memcached(1) server. If any key is not found an error is returned.
-
-It is similar to the standard UNIX cat(1) utility.
-
-
--------
-OPTIONS
--------
-
-
-You can specify servers via the option:
-
-.. cmdoption:: --servers
-
-or via the environment variable:
-
-.. envvar:: `MEMCACHED_SERVERS`
-
-For a full list of operations run the tool with the option:
-
-.. cmdoption:: --help
-
-
-----
-HOME
-----
-
-
-To find out more information please check:
-`http://libmemcached.org/ <http://libmemcached.org/>`_
-
-
-------
-AUTHOR
-------
-
-
-Brian Aker, <brian@tangent.org>
-
-Mark Atwood <mark@fallenpegasus.com>
-
-
---------
-SEE ALSO
---------
-
-
-:manpage:`memcached(1)` :manpage:`libmemcached(3)`
-
+++ /dev/null
-=============================
-memcp - Copy data to a server
-=============================
-
-
-Copies files to a collection of memcached servers
-
-
---------
-SYNOPSIS
---------
-
-memcp [options] [file] [server]
-
-.. program:: memcp
-
-
------------
-DESCRIPTION
------------
-
-
-:program:`memcp` copies one or more files into memcached(1) servers.
-It is similar to the standard UNIX cp(1) command.
-
-The key names will be the names of the files,
-without any directory path.
-
-
--------
-OPTIONS
--------
-
-
-You can specify servers via the option:
-
-.. option:: --servers
-
-or via the environment variable:
-
-.. envvar:: `MEMCACHED_SERVERS`
-
-If you do not specify either these, the final value in the command line list is the name of a server(s).
-
-For a full list of operations run the tool with the option:
-
-.. option:: --help
-
-
-----
-HOME
-----
-
-
-To find out more information please check:
-`http://libmemcached.org/ <http://libmemcached.org/>`_
-
-
-------
-AUTHOR
-------
-
-
-Brian Aker, <brian@tangent.org>
-
-Mark Atwood, <mark@fallenpegasus.com>
-
-
---------
-SEE ALSO
---------
-
-
-:manpage:`memcached(1)` :manpage:`libmemcached(3)`
-
+++ /dev/null
-=============================
-memdump - Dumping your server
-=============================
-
-
-Dump a list of keys from a server.
-
-
---------
-SYNOPSIS
---------
-
-memdump [options]
-
-.. program:: memdump
-
------------
-DESCRIPTION
------------
-
-
-:program:`memdump` dumps a list of "keys" from all servers that
-it is told to fetch from. Because memcached does not guarentee to
-provide all keys it is not possible to get a complete "dump".
-
-
--------
-OPTIONS
--------
-
-
-For a full list of operations run the tool with option:
-
-.. option:: --help
-
-
-----
-HOME
-----
-
-
-To find out more information please check:
-`http://libmemcached.org/ <http://libmemcached.org/>`_
-
-
-------
-AUTHOR
-------
-
-
-Brian Aker, <brian@tangent.org>
-
-
---------
-SEE ALSO
---------
-
-:manpage:`memcached(1)` :manpage:`libmemcached(3)`
+++ /dev/null
-==============================================
-memerror - translate an error code to a string
-==============================================
-
-
-Translates a memcached error code into a string
-
-
---------
-SYNOPSIS
---------
-
-memerror [options] [error code]
-
-.. program:: memerror
-
------------
-DESCRIPTION
------------
-
-
-:program:`memerror` translates an error code from libmemcached(3) into a human
-readable string.
-
-
--------
-OPTIONS
--------
-
-
-For a full list of operations run the tool with option:
-
-.. option:: --help
-
-
-----
-HOME
-----
-
-
-To find out more infoerroration please check:
-`http://libmemcached.org/ <http://libmemcached.org/>`_
-
-
-------
-AUTHOR
-------
-
-
-Brian Aker, <brian@tangent.org>
-
-
---------
-SEE ALSO
---------
-
-
-:manpage:`memcached(1)` :manpage:`libmemcached(3)`
+++ /dev/null
-===========================================
-memexist - Check for the existance of a key
-===========================================
-
-
---------
-SYNOPSIS
---------
-
-memexist [options] [key]
-
-.. program:: memexist
-
-
------------
-DESCRIPTION
------------
-
-:program:`memexist` checks for the existance of a key within a cluster.
-
-
--------
-OPTIONS
--------
-
-
-You can specify servers via the option:
-
-.. option:: --servers
-
-or via the environment variable:
-
-.. envvar:: `MEMCACHED_SERVERS`
-
-If you do not specify either these, the final value in the command line list is the name of a server(s).
-
-For a full list of operations run the tool with the option:
-
-.. option:: --help
-
-
-----
-HOME
-----
-
-
-To find out more information please check:
-`http://libmemcached.org/ <http://libmemcached.org/>`_
-
-
-------
-AUTHOR
-------
-
-
-Brian Aker, <brian@tangent.org>
-
---------
-SEE ALSO
---------
-
-
-:manpage:`memcached(1)` :manpage:`libmemcached(3)`
-
+++ /dev/null
-=======================================
-memflush - flush all data from a server
-=======================================
-
-
-Reset a server or list of servers
-
-
---------
-SYNOPSIS
---------
-
-memflush [options]
-
-.. program:: memflush
-
------------
-DESCRIPTION
------------
-
-
-:program:`memflush` resets the contents of memcached(1) servers.
-This means that all data in the specified servers will be deleted.
-
-
--------
-OPTIONS
--------
-
-
-You can specify servers via the option:
-
-.. option:: --servers
-
-or via the environment variable:
-
-.. envvar:: `MEMCACHED_SERVERS`
-
-For a full list of operations run the tool with option:
-
-.. option:: --help
-
-
-----
-HOME
-----
-
-
-To find out more information please check:
-`http://libmemcached.org/ <http://libmemcached.org/>`_
-
-
-------
-AUTHOR
-------
-
-
-Brian Aker, <brian@tangent.org>
-
-Mark Atwood <mark@fallenpegasus.com>
-
-
---------
-SEE ALSO
---------
-
-:manpage:`memcached(1)` :manpage:`libmemcached(3)`
+++ /dev/null
-=================================
-memparse - Parse an option string
-=================================
-
-
-Copies files to a collection of memcached servers
-
-
---------
-SYNOPSIS
---------
-
-memparse [options] "option string"
-
-.. program:: memparse
-
-
------------
-DESCRIPTION
------------
-
-
-:program:`memparse` can be used to validate an option string.
-
--------
-OPTIONS
--------
-
-For a full list of operations run the tool with the option:
-
-.. option:: --help
-
-
-----
-HOME
-----
-
-
-To find out more information please check:
-`http://libmemcached.org/ <http://libmemcached.org/>`_
-
-
-------
-AUTHOR
-------
-
-
-Brian Aker, <brian@tangent.org>
-
---------
-SEE ALSO
---------
-
-
-:manpage:`memcached(1)` :manpage:`libmemcached(3)`
-
+++ /dev/null
-===============================================
-memping - Test to see if a server is available.
-===============================================
-
-
---------
-SYNOPSIS
---------
-
-memping [options] [server]
-
-.. program:: memping
-
-
------------
-DESCRIPTION
------------
-
-
-:program:`memping` can be used to ping a memcached server to see if it is taking connections.
-
--------
-OPTIONS
--------
-
-
-You can specify servers via the option:
-
-.. option:: --servers
-
-or via the environment variable:
-
-.. envvar:: `MEMCACHED_SERVERS`
-
-If you do not specify either these, the final value in the command line list is the name of a server(s).
-
-For a full list of operations run the tool with the option:
-
-.. option:: --help
-
-
-----
-HOME
-----
-
-
-To find out more information please check:
-`http://libmemcached.org/ <http://libmemcached.org/>`_
-
-
-------
-AUTHOR
-------
-
-Brian Aker, <brian@tangent.org>
-
---------
-SEE ALSO
---------
-
-:manpage:`memcached(1)` :manpage:`libmemcached(3)`
+++ /dev/null
-=================================
-memrm - Remove data from a server
-=================================
-
-
-memrm - Remove a key(s) from a collection of memcached servers
-
-
---------
-SYNOPSIS
---------
-
-memrm [options] [key]
-
-.. program:: memrm
-
-
------------
-DESCRIPTION
------------
-
-
-:program:`memrm` removes items, specified by key, from memcached(1) servers.
-
-
--------
-OPTIONS
--------
-
-
-You can specify servers via the option:
-
-.. option:: --servers
-
-or via the environment variable:
-
-.. envvar:: `MEMCACHED_SERVERS`
-
-For a full list of operations run the tool with the
-
-.. option:: --help
-
-
-
-
-----
-HOME
-----
-
-
-To find out more information please check:
-`http://libmemcached.org/ <http://libmemcached.org/>`_
-
-
-------
-AUTHOR
-------
-
-
-Brian Aker, <brian@tangent.org>
-
-Mark Atwood, <mark@fallenpegasus.com>
-
-
---------
-SEE ALSO
---------
-
-
-:manpage:`memcached(1)` :manpage:`libmemcached(3)`
-
+++ /dev/null
-=================================================
-memslap - Load testing and benchmarking a server
-=================================================
-
-
---------
-SYNOPSIS
---------
-
-memslap [options]
-
-.. program:: memslap
-
------------
-DESCRIPTION
------------
-
-
-:program:`memslap` is a load generation and benchmark tool for memcached(1)
-servers. It generates configurable workload such as threads, concurrencies, connections, run time, overwrite, miss rate, key size, value size, get/set proportion, expected throughput, and so on.
-
-
--------
-OPTIONS
--------
-
-
-You can specify servers via the option:
-
-.. option:: --servers
-
-or via the environment variable:
-
-.. envvar:: `MEMCACHED_SERVERS`
-
-For a full list of operations run the tool with:
-
-.. option:: --help
-
-
-----
-HOME
-----
-
-
-To find out more information please check:
-'http://libmemcached.org/ <http://libmemcached.org/>'_
-
-
-------
-AUTHOR
-------
-
-
-Brian Aker, <brian@tangent.org>
-
-
---------
-SEE ALSO
---------
-
-
-:manpage:`memcached(1)` :manpage:`libmemcached(3)`
+++ /dev/null
-=========================================
-memstat - Gather statistics from a server
-=========================================
-
-
-memstat - Display the operating status of a single or group of memcached servers
-
-
---------
-SYNOPSIS
---------
-
-memstat [options]
-
-.. program:: memstat
-
------------
-DESCRIPTION
------------
-
-
-:program:`memstat` dumps the state of memcached(1) servers.
-It displays all data to stdout.
-
-
--------
-OPTIONS
--------
-
-
-You can specify servers via the option:
-
-.. option:: --servers
-
-or via the environment variable:
-
-.. envvar:: 'MEMCACHED_SERVERS, --args'
-
-which can be used to specify the "argument" sent to the stats command (ie slab, size, items, etc..).
-
-For a full list of operations run the tool with:
-
-.. option:: --help
-
-.. option:: --analyze
-
-----
-HOME
-----
-
-
-To find out more information please check:
-`http://libmemcached.org/ <http://libmemcached.org/>`_
-
-
---------
-SEE ALSO
---------
-
-
-:manpage:`memcached(1)` :manpage:`libmemcached(3)`
-
+++ /dev/null
-=========================
-memtouch - Touches a key.
-=========================
-
-
---------
-SYNOPSIS
---------
-
-memtouch [options] key
-
-.. program:: memtouch
-
-
------------
-DESCRIPTION
------------
-
-
-:program:`memtouch` does a "touch" on the specified key.
-
--------
-OPTIONS
--------
-
-
-You can specify servers via the option:
-
-.. option:: --servers
-
-or via the environment variable:
-
-.. envvar:: `MEMCACHED_SERVERS`
-
-If you do not specify either these, the final value in the command line list is the name of a server(s).
-
-For a full list of operations run the tool with the option:
-
-.. option:: --help
-
-
-----
-HOME
-----
-
-
-To find out more information please check:
-`http://libmemcached.org/ <http://libmemcached.org/>`_
-
-
-------
-AUTHOR
-------
-
-Brian Aker, <brian@tangent.org>
-
---------
-SEE ALSO
---------
-
-
-:manpage:`memcached(1)` :manpage:`libmemcached(3)`
-
+++ /dev/null
-=======================
-MEMCACHED_AUTH_CONTINUE
-=======================
-
-.. c:type:: MEMCACHED_AUTH_CONTINUE
-
-Authentication has been paused.
+++ /dev/null
-======================
-MEMCACHED_AUTH_FAILURE
-======================
-
-.. c:type:: MEMCACHED_AUTH_FAILURE
-
-The credentials provided are not valid for this server.
+++ /dev/null
-======================
-MEMCACHED_AUTH_PROBLEM
-======================
-
-.. c:type:: MEMCACHED_AUTH_PROBLEM
-
-An unknown issue has occured during authentication.
+++ /dev/null
-==========================
-MEMCACHED_BAD_KEY_PROVIDED
-==========================
-
-.. c:type:: MEMCACHED_BAD_KEY_PROVIDED
-
-The key provided is not a valid key.
+++ /dev/null
-==================
-MEMCACHED_BUFFERED
-==================
-
-.. c:type:: MEMCACHED_BUFFERED
-
-The request has been buffered.
+++ /dev/null
-======================
-MEMCACHED_CLIENT_ERROR
-======================
-
-.. c:type:: MEMCACHED_CLIENT_ERROR
-
-An unknown client error has occured internally.
+++ /dev/null
-=================================
-MEMCACHED_CONNECTION_BIND_FAILURE
-=================================
-
-.. c:type:: MEMCACHED_CONNECTION_BIND_FAILURE
-.. deprecated:: <0.30
-
-We were not able to bind() to the socket.
+++ /dev/null
-============================
-MEMCACHED_CONNECTION_FAILURE
-============================
-
-.. c:type:: MEMCACHED_CONNECTION_FAILURE
-
-A unknown error has occured while trying to connect to a server.
+++ /dev/null
-==========================================
-MEMCACHED_CONNECTION_SOCKET_CREATE_FAILURE
-==========================================
-
-.. c:type:: MEMCACHED_CONNECTION_SOCKET_CREATE_FAILURE
-.. deprecated:: <0.30
-
-An error has occurred while trying to connect to a server. It is likely that either the number of file descriptors need to be increased or you are out of memory.
+++ /dev/null
-=============================
-MEMCACHED_DATA_DOES_NOT_EXIST
-=============================
-
-.. c:type:: MEMCACHED_DATA_DOES_NOT_EXIST
-
-The data requested with the key given was not found.
+++ /dev/null
-=====================
-MEMCACHED_DATA_EXISTS
-=====================
-
-.. c:type:: MEMCACHED_DATA_EXISTS
-
-The data requested with the key given was not found.
+++ /dev/null
-=================
-MEMCACHED_DELETED
-=================
-
-.. c:type:: MEMCACHED_DELETED
-
-The object requested by the key has been deleted.
+++ /dev/null
-====================
-MEMCACHED_DEPRECATED
-====================
-
-.. c:type:: MEMCACHED_DEPRECATED
-
-The method that was requested has been deprecated.
+++ /dev/null
-===============
-MEMCACHED_E2BIG
-===============
-
-.. c:type:: MEMCACHED_E2BIG
-
-Item is too large for the server to store.
+++ /dev/null
-=============
-MEMCACHED_END
-=============
-
-.. c:type:: MEMCACHED_END
-
-The server has completed returning all of the objects requested.
+++ /dev/null
-===============
-MEMCACHED_ERRNO
-===============
-
-.. c:type:: MEMCACHED_ERRNO
-
-An error has occurred in the driver which has set errno.
+++ /dev/null
-=================
-MEMCACHED_FAILURE
-=================
-
-.. c:type:: MEMCACHED_FAILURE
-.. deprecated:: <0.30
-
-A unknown failure has occurred in the server.
+++ /dev/null
-==========================
-MEMCACHED_FAIL_UNIX_SOCKET
-==========================
-
-.. c:type:: MEMCACHED_FAIL_UNIX_SOCKET
-
-A connection was not established with the server via a unix domain socket.
+++ /dev/null
-===========================
-MEMCACHED_FETCH_NOTFINISHED
-===========================
-
-.. c:type:: MEMCACHED_FETCH_NOTFINISHED
-
-A request has been made, but the server has not finished the fetch of the last request.
+++ /dev/null
-=============================
-MEMCACHED_HOST_LOOKUP_FAILURE
-=============================
-
-.. c:type:: MEMCACHED_HOST_LOOKUP_FAILURE
-
-A DNS failure has occurred.
+++ /dev/null
-===========================
-MEMCACHED_INVALID_ARGUMENTS
-===========================
-
-.. c:type:: MEMCACHED_INVALID_ARGUMENTS
-
-The arguments supplied to the given function were not valid.
+++ /dev/null
-===============================
-MEMCACHED_INVALID_HOST_PROTOCOL
-===============================
-
-.. c:type:: MEMCACHED_INVALID_HOST_PROTOCOL
-
-The server you are connecting too has an invalid protocol. Most likely you are connecting to an older server that does not speak the binary protocol.
+++ /dev/null
-==============
-MEMCACHED_ITEM
-==============
-
-.. c:type:: MEMCACHED_ITEM
-
-An item has been fetched (this is an internal error only).
+++ /dev/null
-=====================
-MEMCACHED_KEY_TOO_BIG
-=====================
-
-.. c:type:: MEMCACHED_KEY_TOO_BIG
-
-The key that has been provided is too large for the given server.
+++ /dev/null
-========================
-MEMCACHED_MAXIMUM_RETURN
-========================
-
-.. c:type:: MEMCACHED_MAXIMUM_RETURN
-
-This in an internal only state.
+++ /dev/null
-===================================
-MEMCACHED_MEMORY_ALLOCATION_FAILURE
-===================================
-
-.. c:type:: MEMCACHED_MEMORY_ALLOCATION_FAILURE
-
-An error has occurred while trying to allocate memory.
+++ /dev/null
-==================
-MEMCACHED_NOTFOUND
-==================
-
-.. c:type:: MEMCACHED_NOTFOUND
-
-The object requested was not found.
+++ /dev/null
-===================
-MEMCACHED_NOTSTORED
-===================
-
-.. c:type:: MEMCACHED_NOTSTORED
-
-The request to store an object failed.
+++ /dev/null
-=======================
-MEMCACHED_NOT_SUPPORTED
-=======================
-
-.. c:type:: MEMCACHED_NOT_SUPPORTED
-
-The given method is not supported in the server.
+++ /dev/null
-=========================
-MEMCACHED_NO_KEY_PROVIDED
-=========================
-
-.. c:type:: MEMCACHED_NO_KEY_PROVIDED
-.. deprecated:: <0.30
- Use :c:type:`MEMCACHED_BAD_KEY_PROVIDED` instead.
-
-No key was provided.
+++ /dev/null
-====================
-MEMCACHED_NO_SERVERS
-====================
-
-.. c:type:: MEMCACHED_NO_SERVERS
-
-No servers have been added to the memcached_st object.
+++ /dev/null
-=====================
-MEMCACHED_PARSE_ERROR
-=====================
-
-.. c:type:: MEMCACHED_PARSE_ERROR
-
-An error has occurred while trying to parse the configuration string. You should use memparse to determine what the error was.
+++ /dev/null
-==========================
-MEMCACHED_PARSE_USER_ERROR
-==========================
-
-.. c:type:: MEMCACHED_PARSE_USER_ERROR
-
-An error has occurred in parsing the configuration string.
+++ /dev/null
-======================
-MEMCACHED_PARTIAL_READ
-======================
-
-.. c:type:: MEMCACHED_PARTIAL_READ
-
-The read was only partcially successful.
+++ /dev/null
-========================
-MEMCACHED_PROTOCOL_ERROR
-========================
-
-.. c:type:: MEMCACHED_PROTOCOL_ERROR
-
-An unknown error has occurred in the protocol.
+++ /dev/null
-======================
-MEMCACHED_READ_FAILURE
-======================
-
-.. c:type:: MEMCACHED_READ_FAILURE
-
-A read failure has occurred.
+++ /dev/null
-======================
-MEMCACHED_SERVER_ERROR
-======================
-
-.. c:type:: MEMCACHED_SERVER_ERROR
-
-An unknown error has occurred in the server.
+++ /dev/null
-============================
-MEMCACHED_SERVER_MARKED_DEAD
-============================
-
-.. c:type:: MEMCACHED_SERVER_MARKED_DEAD
-
-The requested server has been marked dead.
+++ /dev/null
-=====================
-MEMCACHED_SOME_ERRORS
-=====================
-
-.. c:type:: MEMCACHED_SOME_ERRORS
-
-A multi request has been made, and some underterminate number of errors have occurred.
+++ /dev/null
-==============
-MEMCACHED_STAT
-==============
-
-.. c:type:: MEMCACHED_STAT
-
-A "stat" command has been returned in the protocol.
+++ /dev/null
-================
-MEMCACHED_STORED
-================
-
-.. c:type:: MEMCACHED_STORED
-
-The requested object has been successfully stored on the server.
+++ /dev/null
-=================
-MEMCACHED_SUCCESS
-=================
-
-.. c:type:: MEMCACHED_SUCCESS
-
-The request was successfully executed.
+++ /dev/null
-=================
-MEMCACHED_TIMEOUT
-=================
-
-.. c:type:: MEMCACHED_TIMEOUT
-
-Operation has timed out.
+++ /dev/null
-==============================
-MEMCACHED_UNKNOWN_READ_FAILURE
-==============================
-
-.. c:type:: MEMCACHED_UNKNOWN_READ_FAILURE
-
-An unknown read failure only occurs when either there is a bug in the server, or in rare cases where an ethernet nic is reporting dubious information.
+++ /dev/null
-==========================
-MEMCACHED_UNKNOWN_STAT_KEY
-==========================
-
-.. c:type:: MEMCACHED_UNKNOWN_STAT_KEY
-
-The server you are communicating with has a stat key which has not be defined in the protocol.
+++ /dev/null
-===============
-MEMCACHED_VALUE
-===============
-
-.. c:type:: MEMCACHED_VALUE
-
-A value has been returned from the server (this is an internal condition only).
+++ /dev/null
-=======================
-MEMCACHED_WRITE_FAILURE
-=======================
-
-.. c:type:: MEMCACHED_WRITE_FAILURE
-
-An error has occured while trying to write to a server.
+++ /dev/null
-# -*- coding: utf-8 -*-
-#
-# libmemcached documentation build configuration file, created by
-# sphinx-quickstart on Sun Mar 6 12:05:53 2011.
-#
-# This file is execfile()d with the current directory set to its containing dir.
-#
-# Note that not all possible configuration values are present in this
-# autogenerated file.
-#
-# All configuration values have a default; values that are commented out
-# serve to show the default.
-
-import sys, os
-
-# If extensions (or modules to document with autodoc) are in another directory,
-# add these directories to sys.path here. If the directory is relative to the
-# documentation root, use os.path.abspath to make it absolute, like shown here.
-#sys.path.insert(0, os.path.abspath('.'))
-
-# -- General configuration -----------------------------------------------------
-
-# If your documentation needs a minimal Sphinx version, state it here.
-#needs_sphinx = '1.0'
-
-# Add any Sphinx extension module names here, as strings. They can be extensions
-# coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
-extensions = []
-
-#extensions = ['sphinxcontrib.googleanalytics']
-
-# Google
-#googleanalytics_id = 'UA-15307604-2'
-#googleanalytics_enabled = 'True'
-
-# Add any paths that contain templates here, relative to this directory.
-templates_path = ['_templates']
-
-# The suffix of source filenames.
-source_suffix = '.rst'
-
-# The encoding of source files.
-#source_encoding = 'utf-8-sig'
-
-# The master toctree document.
-master_doc = 'index'
-
-# General information about the project.
-project = u'libmemcached'
-copyright = u'2011-2013, 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
-# built documents.
-#
-# The short X.Y version.
-version = '@VERSION@'
-# The full version, including alpha/beta/rc tags.
-release = '@VERSION@'
-
-# The language for content autogenerated by Sphinx. Refer to documentation
-# for a list of supported languages.
-#language = None
-
-# There are two options for replacing |today|: either, you set today to some
-# non-false value, then it is used:
-#today = ''
-# Else, today_fmt is used as the format for a strftime call.
-#today_fmt = '%B %d, %Y'
-
-# List of patterns, relative to source directory, that match files and
-# directories to ignore when looking for source files.
-exclude_patterns = ['_build']
-
-# The reST default role (used for this markup: `text`) to use for all documents.
-#default_role = None
-
-# If true, '()' will be appended to :func: etc. cross-reference text.
-#add_function_parentheses = True
-
-# If true, the current module name will be prepended to all description
-# unit titles (such as .. function::).
-#add_module_names = True
-
-# If true, sectionauthor and moduleauthor directives will be shown in the
-# output. They are ignored by default.
-#show_authors = False
-
-# The name of the Pygments (syntax highlighting) style to use.
-pygments_style = 'sphinx'
-
-# A list of ignored prefixes for module index sorting.
-#modindex_common_prefix = []
-
-
-# -- Options for HTML output ---------------------------------------------------
-
-# The theme to use for HTML and HTML Help pages. See the documentation for
-# a list of builtin themes.
-html_theme = 'default'
-
-# Theme options are theme-specific and customize the look and feel of a theme
-# further. For a list of options available for each theme, see the
-# documentation.
-#html_theme_options = {}
-
-# Add any paths that contain custom themes here, relative to this directory.
-#html_theme_path = []
-
-# The name for this set of Sphinx documents. If None, it defaults to
-# "<project> v<release> documentation".
-#html_title = None
-
-# A shorter title for the navigation bar. Default is the same as html_title.
-#html_short_title = None
-
-# The name of an image file (relative to this directory) to place at the top
-# of the sidebar.
-#html_logo = None
-
-# The name of an image file (within the static path) to use as favicon of the
-# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
-# pixels large.
-#html_favicon = None
-
-# Add any paths that contain custom static files (such as style sheets) here,
-# relative to this directory. They are copied after the builtin static files,
-# so a file named "default.css" will overwrite the builtin "default.css".
-html_static_path = ['_static']
-
-# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
-# using the given strftime format.
-#html_last_updated_fmt = '%b %d, %Y'
-
-# If true, SmartyPants will be used to convert quotes and dashes to
-# typographically correct entities.
-#html_use_smartypants = True
-
-# Custom sidebar templates, maps document names to template names.
-#html_sidebars = {}
-
-# Additional templates that should be rendered to pages, maps page names to
-# template names.
-#html_additional_pages = {}
-
-# If false, no module index is generated.
-#html_domain_indices = True
-
-# If false, no index is generated.
-#html_use_index = True
-
-# If true, the index is split into individual pages for each letter.
-#html_split_index = False
-
-# If true, links to the reST sources are added to the pages.
-html_show_sourcelink = False
-
-# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
-#html_show_sphinx = True
-
-# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
-#html_show_copyright = True
-
-# If true, an OpenSearch description file will be output, and all pages will
-# contain a <link> tag referring to it. The value of this option must be the
-# base URL from which the finished HTML is served.
-#html_use_opensearch = ''
-
-# This is the file name suffix for HTML files (e.g. ".xhtml").
-#html_file_suffix = None
-
-# Output file base name for HTML help builder.
-htmlhelp_basename = 'libmemcacheddoc'
-
-
-# -- Options for LaTeX output --------------------------------------------------
-
-# The paper size ('letter' or 'a4').
-#latex_paper_size = 'letter'
-
-# The font size ('10pt', '11pt' or '12pt').
-#latex_font_size = '10pt'
-
-# Grouping the document tree into LaTeX files. List of tuples
-# (source start file, target name, title, author, documentclass [howto/manual]).
-latex_documents = [
- ('index', 'libmemcached.tex', u'libmemcached Documentation',
- u'Brian Aker', 'manual'),
-]
-
-# The name of an image file (relative to this directory) to place at the top of
-# the title page.
-#latex_logo = None
-
-# For "manual" documents, if this is true, then toplevel headings are parts,
-# not chapters.
-#latex_use_parts = False
-
-# If true, show page references after internal links.
-#latex_show_pagerefs = False
-
-# If true, show URL addresses after external links.
-#latex_show_urls = False
-
-# Additional stuff for the LaTeX preamble.
-#latex_preamble = ''
-
-# Documents to append as an appendix to all manuals.
-#latex_appendices = []
-
-# If false, no module index is generated.
-#latex_domain_indices = True
-
-
-# -- Options for manual page output --------------------------------------------
-
-# One entry per manual page. List of tuples
-# (source start file, name, description, authors, manual section).
-man_pages = [
- ('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),
- ('hashkit_create', 'hashkit_is_allocated', u'libhashkit Documentation', [u'Brian Aker'], 3),
- ('hashkit_functions', 'hashkit_crc32', u'libhashkit Documentation', [u'Brian Aker'], 3),
- ('hashkit_functions', 'hashkit_fnv1_32', u'libhashkit Documentation', [u'Brian Aker'], 3),
- ('hashkit_functions', 'hashkit_fnv1_64', u'libhashkit Documentation', [u'Brian Aker'], 3),
- ('hashkit_functions', 'hashkit_fnv1a_32', u'libhashkit Documentation', [u'Brian Aker'], 3),
- ('hashkit_functions', 'hashkit_fnv1a_64', u'libhashkit Documentation', [u'Brian Aker'], 3),
- ('hashkit_functions', 'hashkit_functions', u'libhashkit Documentation', [u'Brian Aker'], 3),
- ('hashkit_functions', 'hashkit_hsieh', u'libhashkit Documentation', [u'Brian Aker'], 3),
- ('hashkit_functions', 'hashkit_jenkins', u'libhashkit Documentation', [u'Brian Aker'], 3),
- ('hashkit_functions', 'hashkit_md5', u'libhashkit Documentation', [u'Brian Aker'], 3),
- ('hashkit_functions', 'hashkit_murmur', u'libhashkit Documentation', [u'Brian Aker'], 3),
- ('hashkit_value', 'hashkit_value', u'libhashkit Documentation', [u'Brian Aker'], 3),
- ('libhashkit', 'libhashkit', u'libhashkit Documentation', [u'Brian Aker'], 3),
- ('libmemcached', 'libmemcached', u'Introducing the C Client Library for memcached', [u'Brian Aker'], 3),
- ('libmemcached_configuration', 'libmemcached_check_configuration', u'libmemcached Documentation', [u'Brian Aker'], 3),
- ('libmemcached_configuration', 'libmemcached_configuration', u'libmemcached Documentation', [u'Brian Aker'], 3),
- ('libmemcached_configuration', 'memcached', u'libmemcached Documentation', [u'Brian Aker'], 3),
- ('libmemcached_examples', 'libmemcached_examples', u'libmemcached Documentation', [u'Brian Aker'], 3),
- ('libmemcachedutil', 'libmemcachedutil', u'libmemcached Documentation', [u'Brian Aker'], 3),
- ('memcached_analyze', 'memcached_analyze', u'libmemcached Documentation', [u'Brian Aker'], 3),
- ('memcached_append', 'memcached_append', u'Appending to or Prepending to data on the server', [u'Brian Aker'], 3),
- ('memcached_append', 'memcached_append_by_key', u'Appending to or Prepending to data on the server', [u'Brian Aker'], 3),
- ('memcached_append', 'memcached_prepend', u'Appending to or Prepending to data on the server', [u'Brian Aker'], 3),
- ('memcached_append', 'memcached_prepend_by_key', u'Appending to or Prepending to data on the server', [u'Brian Aker'], 3),
- ('memcached_auto', 'memcached_auto', u'Incrementing and Decrementing Values', [u'Brian Aker'], 3),
- ('memcached_auto', 'memcached_decrement', u'Incrementing and Decrementing Values', [u'Brian Aker'], 3),
- ('memcached_auto', 'memcached_decrement_with_initial', u'Incrementing and Decrementing Values', [u'Brian Aker'], 3),
- ('memcached_auto', 'memcached_increment', u'Incrementing and Decrementing Values', [u'Brian Aker'], 3),
- ('memcached_auto', 'memcached_increment_with_initial', u'Incrementing and Decrementing Values', [u'Brian Aker'], 3),
- ('memcached_behavior', 'memcached_behavior', u'libmemcached Documentation', [u'Brian Aker'], 3),
- ('memcached_behavior', 'memcached_behavior_get', u'libmemcached Documentation', [u'Brian Aker'], 3),
- ('memcached_behavior', 'memcached_behavior_set', u'libmemcached Documentation', [u'Brian Aker'], 3),
- ('memcached_callback', 'memcached_callback', u'libmemcached Documentation', [u'Brian Aker'], 3),
- ('memcached_callback', 'memcached_callback_get', u'libmemcached Documentation', [u'Brian Aker'], 3),
- ('memcached_callback', 'memcached_callback_set', u'libmemcached Documentation', [u'Brian Aker'], 3),
- ('memcached_cas', 'memcached_cas', u'Working with data on the server in an atomic fashion', [u'Brian Aker'], 3),
- ('memcached_cas', 'memcached_cas_by_key', u'Storing and Replacing Data', [u'Brian Aker'], 3),
- ('memcached_create', 'memcached_clone', u'libmemcached Documentation', [u'Brian Aker'], 3),
- ('memcached_create', 'memcached_create', u'libmemcached Documentation', [u'Brian Aker'], 3),
- ('memcached_create', 'memcached_free', u'libmemcached Documentation', [u'Brian Aker'], 3),
- ('memcached_create', 'memcached_servers_reset', u'libmemcached Documentation', [u'Brian Aker'], 3),
- ('memcached_delete', 'memcached_delete', u'libmemcached Documentation', [u'Brian Aker'], 3),
- ('memcached_delete', 'memcached_delete_by_key', u'libmemcached Documentation', [u'Brian Aker'], 3),
- ('libmemcached-1.0/memcached_touch', 'memcached_touch', u'libmemcached Documentation', [u'Brian Aker'], 3),
- ('libmemcached-1.0/memcached_touch', 'memcached_touch_by_key', u'libmemcached Documentation', [u'Brian Aker'], 3),
- ('libmemcached/memcached_exist', 'memcached_exist', u'libmemcached Documentation', [u'Brian Aker'], 3),
- ('libmemcached/memcached_exist', 'memcached_exist_by_key', u'libmemcached Documentation', [u'Brian Aker'], 3),
- ('memcached_dump', 'memcached_dump', u'libmemcached Documentation', [u'Brian Aker'], 3),
- ('memcached_flush', 'memcached_flush', u'libmemcached Documentation', [u'Brian Aker'], 3),
- ('memcached_flush_buffers', 'memcached_flush_buffers', u'libmemcached Documentation', [u'Brian Aker'], 3),
- ('memcached_generate_hash_value', 'memcached_generate_hash', u'Generating hash values directly', [u'Brian Aker'], 3),
- ('memcached_generate_hash_value', 'memcached_generate_hash_value', u'Generating hash values directly', [u'Brian Aker'], 3),
- ('libmemcached/memcached_fetch', 'memcached_fetch', u'Retrieving data from the server', [u'Brian Aker'], 3),
- ('memcached_get', 'memcached_fetch_execute', u'Retrieving data from the server', [u'Brian Aker'], 3),
- ('memcached_get', 'memcached_fetch_result', u'Retrieving data from the server', [u'Brian Aker'], 3),
- ('memcached_get', 'memcached_get', u'Retrieving data from the server', [u'Brian Aker'], 3),
- ('memcached_get', 'memcached_get_by_key', u'Retrieving data from the server', [u'Brian Aker'], 3),
- ('libmemcached/memcached_return_t', 'memcached_return_t', u'Return type values ', [u'Brian Aker'], 3),
- ('memcached_get', 'memcached_mget', u'Retrieving data from the server', [u'Brian Aker'], 3),
- ('memcached_get', 'memcached_mget_by_key', u'Retrieving data from the server', [u'Brian Aker'], 3),
- ('memcached_get', 'memcached_mget_execute', u'Retrieving data from the server', [u'Brian Aker'], 3),
- ('memcached_get', 'memcached_mget_execute_by_key', u'Retrieving data from the server', [u'Brian Aker'], 3),
- ('libmemcached/memcached_last_error_message', 'memcached_last_error_message', u'libmemcached Documentation', [u'Brian Aker'], 3),
- ('memcached_memory_allocators', 'memcached_get_memory_allocators', u'libmemcached Documentation', [u'Brian Aker'], 3),
- ('memcached_memory_allocators', 'memcached_memory_allocators', u'libmemcached Documentation', [u'Brian Aker'], 3),
- ('memcached_memory_allocators', 'memcached_set_memory_allocators', u'libmemcached Documentation', [u'Brian Aker'], 3),
- ('memcached_memory_allocators', 'memcached_set_memory_allocators_context', u'libmemcached Documentation', [u'Brian Aker'], 3),
- ('memcached_pool', 'memcached_pool', u'libmemcached Documentation', [u'Brian Aker'], 3),
- ('memcached_pool', 'memcached_pool_behavior_get', u'libmemcached Documentation', [u'Brian Aker'], 3),
- ('memcached_pool', 'memcached_pool_behavior_set', u'libmemcached Documentation', [u'Brian Aker'], 3),
- ('memcached_pool', 'memcached_pool_create', u'libmemcached Documentation', [u'Brian Aker'], 3),
- ('memcached_pool', 'memcached_pool_destroy', u'libmemcached Documentation', [u'Brian Aker'], 3),
- ('memcached_pool', 'memcached_pool_fetch', u'libmemcached Documentation', [u'Brian Aker'], 3),
- ('memcached_pool', 'memcached_pool_pop', u'libmemcached Documentation', [u'Brian Aker'], 3),
- ('memcached_pool', 'memcached_pool_push', u'libmemcached Documentation', [u'Brian Aker'], 3),
- ('memcached_pool', 'memcached_pool_release', u'libmemcached Documentation', [u'Brian Aker'], 3),
- ('memcached_pool', 'memcached_pool_st', u'libmemcached Documentation', [u'Brian Aker'], 3),
- ('memcached_quit', 'memcached_quit', u'libmemcached Documentation', [u'Brian Aker'], 3),
- ('libmemcached-1.0/memcached_set_encoding_key', 'memcached_set_encoding_key', u'libmemcached Documentation', [u'Brian Aker'], 3),
- ('memcached_result_st', 'memcached_result_cas', u'Working with result sets', [u'Brian Aker'], 3),
- ('memcached_result_st', 'memcached_result_create', u'Working with result sets', [u'Brian Aker'], 3),
- ('memcached_result_st', 'memcached_result_flags', u'Working with result sets', [u'Brian Aker'], 3),
- ('memcached_result_st', 'memcached_result_free', u'Working with result sets', [u'Brian Aker'], 3),
- ('memcached_result_st', 'memcached_result_key_length', u'Working with result sets', [u'Brian Aker'], 3),
- ('memcached_result_st', 'memcached_result_key_value', u'Working with result sets', [u'Brian Aker'], 3),
- ('memcached_result_st', 'memcached_result_length', u'Working with result sets', [u'Brian Aker'], 3),
- ('memcached_result_st', 'memcached_result_st', u'Working with result sets', [u'Brian Aker'], 3),
- ('memcached_result_st', 'memcached_result_value', u'Working with result sets', [u'Brian Aker'], 3),
- ('memcached_sasl', 'memcached_destroy_sasl_auth_data', u'libmemcached Documentation', [u'Brian Aker'], 3),
- ('memcached_sasl', 'memcached_get_sasl_callbacks', u'libmemcached Documentation', [u'Brian Aker'], 3),
- ('memcached_sasl', 'memcached_sasl', u'libmemcached Documentation', [u'Brian Aker'], 3),
- ('memcached_sasl', 'memcached_sasl_set_auth_data', u'libmemcached Documentation', [u'Brian Aker'], 3),
- ('memcached_sasl', 'memcached_set_sasl_callbacks', u'libmemcached Documentation', [u'Brian Aker'], 3),
- ('memcached_server_st', 'memcached_server_list_append', u'libmemcached Documentation', [u'Brian Aker'], 3),
- ('memcached_server_st', 'memcached_server_list_count', u'libmemcached Documentation', [u'Brian Aker'], 3),
- ('memcached_server_st', 'memcached_server_list_free', u'libmemcached Documentation', [u'Brian Aker'], 3),
- ('memcached_server_st', 'memcached_servers_parse', u'libmemcached Documentation', [u'Brian Aker'], 3),
- ('memcached_servers', 'memcached_server_add', u'libmemcached Documentation', [u'Brian Aker'], 3),
- ('memcached_servers', 'memcached_server_add_unix_socket', u'libmemcached Documentation', [u'Brian Aker'], 3),
- ('memcached_servers', 'memcached_server_count', u'libmemcached Documentation', [u'Brian Aker'], 3),
- ('memcached_servers', 'memcached_server_cursor', u'libmemcached Documentation', [u'Brian Aker'], 3),
- ('memcached_servers', 'memcached_server_list', u'libmemcached Documentation', [u'Brian Aker'], 3),
- ('memcached_servers', 'memcached_server_push', u'libmemcached Documentation', [u'Brian Aker'], 3),
- ('memcached_servers', 'memcached_server_st', u'libmemcached Documentation', [u'Brian Aker'], 3),
- ('memcached_servers', 'memcached_servers', u'libmemcached Documentation', [u'Brian Aker'], 3),
- ('memcached_set', 'memcached_add', u'Storing and Replacing Data', [u'Brian Aker'], 3),
- ('memcached_set', 'memcached_add_by_key', u'Storing and Replacing Data', [u'Brian Aker'], 3),
- ('memcached_set', 'memcached_replace', u'Storing and Replacing Data', [u'Brian Aker'], 3),
- ('memcached_set', 'memcached_replace_by_key', u'Storing and Replacing Data', [u'Brian Aker'], 3),
- ('memcached_set', 'memcached_set', u'Storing and Replacing Data', [u'Brian Aker'], 3),
- ('memcached_set', 'memcached_set_by_key', u'Storing and Replacing Data', [u'Brian Aker'], 3),
- ('memcached_stats', 'memcached_stat', u'libmemcached Documentation', [u'Brian Aker'], 3),
- ('memcached_stats', 'memcached_stat_execute', u'libmemcached Documentation', [u'Brian Aker'], 3),
- ('memcached_stats', 'memcached_stat_get_keys', u'libmemcached Documentation', [u'Brian Aker'], 3),
- ('memcached_stats', 'memcached_stat_get_value', u'libmemcached Documentation', [u'Brian Aker'], 3),
- ('memcached_stats', 'memcached_stat_servername', u'libmemcached Documentation', [u'Brian Aker'], 3),
- ('memcached_stats', 'memcached_stats', u'libmemcached Documentation', [u'Brian Aker'], 3),
- ('memcached_strerror', 'memcached_strerror', u'libmemcached Documentation', [u'Brian Aker'], 3),
- ('memcached_user_data', 'memcached_get_user_data', u'libmemcached Documentation', [u'Brian Aker'], 3),
- ('memcached_user_data', 'memcached_set_user_data', u'libmemcached Documentation', [u'Brian Aker'], 3),
- ('memcached_user_data', 'memcached_user_data', u'libmemcached Documentation', [u'Brian Aker'], 3),
- ('memcached_verbosity', 'memcached_verbosity', u'libmemcached Documentation', [u'Brian Aker'], 3),
- ('memcached_version', 'memcached_lib_version', u'libmemcached Documentation', [u'Brian Aker'], 3),
- ('memcached_version', 'memcached_version', u'libmemcached Documentation', [u'Brian Aker'], 3),
- ('bin/memcapable', 'memcapable', u'libmemcached Documentation', [u'Brian Aker'], 1),
- ('bin/memcat', 'memcat', u'libmemcached Documentation', [u'Brian Aker'], 1),
- ('bin/memcp', 'memcp', u'libmemcached Documentation', [u'Brian Aker'], 1),
- ('bin/memdump', 'memdump', u'libmemcached Documentation', [u'Brian Aker'], 1),
- ('bin/memerror', 'memerror', u'libmemcached Documentation', [u'Brian Aker'], 1),
- ('bin/memflush', 'memflush', u'libmemcached Documentation', [u'Brian Aker'], 1),
- ('bin/memrm', 'memrm', u'libmemcached Documentation', [u'Brian Aker'], 1),
- ('bin/memaslap', 'memaslap', u'libmemcached Documentation', [u'Brian Aker'], 1),
- ('bin/memslap', 'memslap', u'libmemcached Documentation', [u'Brian Aker'], 1),
- ('bin/memstat', 'memstat', u'libmemcached Documentation', [u'Brian Aker'], 1),
- ('bin/memexist', 'memexist', u'libmemcached Documentation', [u'Brian Aker'], 1),
- ('bin/memparse', 'memparse', u'libmemcached Documentation', [u'Brian Aker'], 1),
- ('bin/memping', 'memping', u'libmemcached Documentation', [u'Brian Aker'], 1),
- ('bin/memtouch', 'memtouch', u'libmemcached Documentation', [u'Brian Aker'], 1),
- ]
+++ /dev/null
-=====================
-Client Error messages
-=====================
-
-.. toctree::
- :maxdepth: 1
-
- client_errors/MEMCACHED_AUTH_CONTINUE
- client_errors/MEMCACHED_AUTH_FAILURE
- client_errors/MEMCACHED_AUTH_PROBLEM
- client_errors/MEMCACHED_BAD_KEY_PROVIDED
- client_errors/MEMCACHED_BUFFERED
- client_errors/MEMCACHED_CLIENT_ERROR
- client_errors/MEMCACHED_CONNECTION_BIND_FAILURE
- client_errors/MEMCACHED_CONNECTION_FAILURE
- client_errors/MEMCACHED_CONNECTION_SOCKET_CREATE_FAILURE
- client_errors/MEMCACHED_DATA_DOES_NOT_EXIST
- client_errors/MEMCACHED_DATA_EXISTS
- client_errors/MEMCACHED_DELETED
- client_errors/MEMCACHED_DEPRECATED
- client_errors/MEMCACHED_E2BIG
- client_errors/MEMCACHED_END
- client_errors/MEMCACHED_ERRNO
- client_errors/MEMCACHED_FAILURE
- client_errors/MEMCACHED_FAIL_UNIX_SOCKET
- client_errors/MEMCACHED_FETCH_NOTFINISHED
- client_errors/MEMCACHED_HOST_LOOKUP_FAILURE
- client_errors/MEMCACHED_INVALID_ARGUMENTS
- client_errors/MEMCACHED_INVALID_HOST_PROTOCOL
- client_errors/MEMCACHED_ITEM
- client_errors/MEMCACHED_KEY_TOO_BIG
- client_errors/MEMCACHED_MAXIMUM_RETURN
- client_errors/MEMCACHED_MEMORY_ALLOCATION_FAILURE
- client_errors/MEMCACHED_NOTFOUND
- client_errors/MEMCACHED_NOTSTORED
- client_errors/MEMCACHED_NOT_SUPPORTED
- client_errors/MEMCACHED_NO_KEY_PROVIDED
- client_errors/MEMCACHED_NO_SERVERS
- client_errors/MEMCACHED_PARSE_ERROR
- client_errors/MEMCACHED_PARSE_USER_ERROR
- client_errors/MEMCACHED_PARTIAL_READ
- client_errors/MEMCACHED_PROTOCOL_ERROR
- client_errors/MEMCACHED_READ_FAILURE
- client_errors/MEMCACHED_SERVER_ERROR
- client_errors/MEMCACHED_SERVER_MARKED_DEAD
- client_errors/MEMCACHED_SOME_ERRORS
- client_errors/MEMCACHED_STAT
- client_errors/MEMCACHED_STORED
- client_errors/MEMCACHED_SUCCESS
- client_errors/MEMCACHED_TIMEOUT
- client_errors/MEMCACHED_UNKNOWN_READ_FAILURE
- client_errors/MEMCACHED_UNKNOWN_STAT_KEY
- client_errors/MEMCACHED_VALUE
- client_errors/MEMCACHED_WRITE_FAILURE
-
+++ /dev/null
-============================
-Creating a hashkit structure
-============================
-
-.. highlightlang:: c
-
-.. index:: object: hashkit_st
-
---------
-SYNOPSIS
---------
-
-#include <libhashkit/hashkit.h>
-
-.. c:type:: hashkit_st
-
-.. c:function:: hashkit_st *hashkit_create(hashkit_st *hash)
-
-.. c:function:: hashkit_st *hashkit_clone(hashkit_st *destination, const hashkit_st *ptr)
-
-.. c:function:: void hashkit_free(hashkit_st *hash)
-
-.. c:function:: bool hashkit_is_allocated(const hashkit_st *hash)
-
-Compile and link with -lhashkit
-
------------
-DESCRIPTION
------------
-
-
-The :c:func:`hashkit_create` function initializes a hashkit object for use. If
-you pass a NULL argument for hash, then the memory for the object is
-allocated. If you specify a pre-allocated piece of memory, that is
-initialized for use.
-
-The :c:func:`hashkit_clone` function initializes a hashkit object much like
-:c:func:`hashkit_create`, but instead of using default settings it will use
-the settings of the ptr hashkit object.
-
-The :c:func:`hashkit_free` frees any resources being consumed by the hashkit
-objects that were initialized with :c:func:`hashkit_create` or :c:func:`hashkit_clone`.
-
-The :c:func:`hashkit_is_allocated` reports where the memory was allocated
-for a hashkit object.
-
-
-------------
-RETURN VALUE
-------------
-
-
-:c:func:`hashkit_create` and :c:func:`hashkit_clone` will return NULL on
-failure or non-NULL on success.
-
-:c:func:`hashkit_is_allocated` returns true if the memory for the hashkit
-object was allocated inside of :c:func:`hashkit_create` or
-:c:func:`hashkit_clone`, otherwise it is false and was user-supplied memory.
-
-
-----
-HOME
-----
-
-
-To find out more information please check:
-`http://libmemcached.org/ <http://libmemcached.org/>`_
-
-
-
---------
-SEE ALSO
---------
-
-
-:manpage:`hashkit_create(3)` :manpage:`hashkit_value(3)` :manpage:`hashkit_set_hash_fn(3)`
-
+++ /dev/null
-================
-Available Hashes
-================
-
-.. index:: object: hashkit_st
-
-Various hash functions to use for calculating values for keys
-
-
---------
-SYNOPSIS
---------
-
-#include <libhashkit/hashkit.h>
-
-.. c:function:: uint32_t hashkit_default(const char *key, size_t key_length)
-
-.. c:function:: uint32_t hashkit_fnv1_64(const char *key, size_t key_length)
-
-.. c:function:: uint32_t hashkit_fnv1a_64(const char *key, size_t key_length)
-
-.. c:function:: uint32_t hashkit_fnv1_32(const char *key, size_t key_length)
-
-.. c:function:: uint32_t hashkit_fnv1a_32(const char *key, size_t key_length)
-
-.. c:function:: uint32_t hashkit_crc32(const char *key, size_t key_length)
-
-.. c:function:: uint32_t hashkit_hsieh(const char *key, size_t key_length)
-
-.. c:function:: uint32_t hashkit_murmur(const char *key, size_t key_length)
-
-.. c:function:: uint32_t hashkit_jenkins(const char *key, size_t key_length)
-
-.. c:function:: uint32_t hashkit_md5(const char *key, size_t key_length)
-
-Compile and link with -lhashkit
-
-
------------
-DESCRIPTION
------------
-
-
-These functions generate hash values from a key using a variety of
-algorithms. These functions can be used standalone, or as arguments
-to hashkit_set_hash_fn(3) or hashkit_set_continuum_hash_fn(3).
-
-The hashkit_hsieh is only available if the library is built with
-the appropriate flag enabled.
-
-
-------------
-RETURN VALUE
-------------
-
-
-A 32-bit hash value.
-
-
-----
-HOME
-----
-
-
-To find out more information please check:
-`http://libmemcached.org/ <http://libmemcached.org/>`_
-
-
---------
-SEE ALSO
---------
-
-
-:manpage:`hashkit_create(3)` :manpage:`hashkit_value(3)` :manpage:`hashkit_set_hash_fn(3)` :manpage:`hashkit_set_continuum_hash_fn(3)`
-
+++ /dev/null
-=============
-hashkit_value
-=============
-
-
-.. index:: object: hashkit_st
-
-Generate a value for the given key
-
---------
-SYNOPSIS
---------
-
-
-#include <libhashkit/hashkit.h>
-
-.. c:function:: uint32_t hashkit_value(hashkit_st *hash, const char *key, size_t key_length)
-
-Compile and link with -lhashkit
-
------------
-DESCRIPTION
------------
-
-
-The :c:func:`hashkit_value` function generates a 32-bit hash value from the
-given key and key_length. The hash argument is an initialized hashkit
-object, and distribution type and hash function is used from this
-object while generating the value.
-
-
-------------
-RETURN VALUE
-------------
-
-
-A 32-bit hash value.
-
-
-----
-HOME
-----
-
-
-To find out more information please check:
-`http://libmemcached.org/ <http://libmemcached.org/>`_
-
-
---------
-SEE ALSO
---------
-
-
-:manpage:`hashkit_create(3)` :manpage:`hashkit_set_distribution(3)` :manpage:`hashkit_set_hash_fn(3)`
-
+++ /dev/null
-# vim:ft=automake
-# included from Top Level Makefile.am
-# All paths should be given relative to the root
-
-# Makefile for Sphinx documentation
-#
-
-SPHINXOPTS = ${SPHINX_WARNINGS} -q
-PAPER =
-SPHINX_BUILDDIR = ${abs_top_builddir}/docs
-
-# Internal variables.
-PAPEROPT_a4 = -D latex_paper_size=a4
-PAPEROPT_letter = -D latex_paper_size=letter
-ALLSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) $(SPHINX_BUILDDIR)
-
-.PHONY: clean-docs-check
-clean-docs-check:
- -rm -rf docs/_build docs/doctrees man/.doctrees/
-
-.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest
-
-sphinx-help:
- @echo "Please use \`make <target>' where <target> is one of"
- @echo " html to make standalone HTML files"
- @echo " singlehtml to make a single large HTML file"
- @echo " pickle to make pickle files"
- @echo " json to make JSON files"
- @echo " htmlhelp to make HTML files and a HTML help project"
- @echo " qthelp to make HTML files and a qthelp project"
- @echo " devhelp to make HTML files and a Devhelp project"
- @echo " epub to make an epub"
- @echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
- @echo " latexpdf to make LaTeX files and run them through pdflatex"
- @echo " text to make text files"
- @echo " man to make manual pages"
- @echo " changes to make an overview of all changed/added/deprecated items"
- @echo " linkcheck to check all external links for integrity"
- @echo " doctest to run all doctests embedded in the documentation (if enabled)"
-
-install-html-local: html-local
- @$(MKDIR_P) $(htmldir)/html
- @cp -r ${top_builddir}/html $(htmldir)/
-
-html-local: docs/conf.py
- @PYTHONPATH=${top_srcdir}/docs $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) ${top_builddir}/html
-
-singlehtml: html-local
- @PYTHONPATH=${top_srcdir}/docs $(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(SPHINX_BUILDDIR)/singlehtml
-
-pickle: docs/conf.py
- PYTHONPATH=${top_srcdir}/docs $(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(SPHINX_BUILDDIR)/pickle
- @echo
- @echo "Build finished; now you can process the pickle files."
-
-json: docs/conf.py
- PYTHONPATH=${top_srcdir}/docs $(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(SPHINX_BUILDDIR)/json
- @echo
- @echo "Build finished; now you can process the JSON files."
-
-htmlhelp: docs/conf.py
- PYTHONPATH=${top_srcdir}/docs $(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(SPHINX_BUILDDIR)/htmlhelp
- @echo
- @echo "Build finished; now you can run HTML Help Workshop with the" \
- ".hhp project file in $(SPHINX_BUILDDIR)/htmlhelp."
-
-epub: docs/conf.py
- PYTHONPATH=${top_srcdir}/docs $(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(SPHINX_BUILDDIR)/epub
- @echo
- @echo "Build finished. The epub file is in $(SPHINX_BUILDDIR)/epub."
-
-latex: docs/conf.py
- PYTHONPATH=${top_srcdir}/docs $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(SPHINX_BUILDDIR)/latex
- @echo
- @echo "Build finished; the LaTeX files are in $(SPHINX_BUILDDIR)/latex."
- @echo "Run \`make' in that directory to run these through (pdf)latex" \
- "(use \`make latexpdf' here to do that automatically)."
-
-latexpdf: latex
- PYTHONPATH=${top_srcdir}/docs $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(SPHINX_BUILDDIR)/latex
- @echo "Running LaTeX files through pdflatex..."
- make -C $(SPHINX_BUILDDIR)/latex all-pdf
- @echo "pdflatex finished; the PDF files are in $(SPHINX_BUILDDIR)/latex."
-
-text: docs/conf.py
- @PYTHONPATH=${top_srcdir}/docs $(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(SPHINX_BUILDDIR)/text
-
-man:
- @PYTHONPATH=$(SPHINX_BUILDDIR)/docs $(SPHINXBUILD) -b man $(ALLSPHINXOPTS) ${top_builddir}/man
-
-
-changes: docs/conf.py
- @PYTHONPATH=${top_srcdir}/docs $(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(SPHINX_BUILDDIR)/changes
-
-linkcheck: docs/conf.py
- PYTHONPATH=${top_srcdir}/docs $(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(SPHINX_BUILDDIR)/linkcheck
-
-doctest: docs/conf.py
- PYTHONPATH=${top_srcdir}/docs $(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(SPHINX_BUILDDIR)/doctest
- @echo "Testing of doctests in the sources finished, look at the " \
- "results in $(SPHINX_BUILDDIR)/doctest/output.txt."
+++ /dev/null
-=========================================
-Welcome to the libmemcached documentation
-=========================================
-
-------------
-Libmemcached
-------------
-
-
-######
-Basics
-######
-
-
-.. toctree::
- :maxdepth: 1
-
- libmemcached
- versioning
- memcached_create
- libmemcached_examples
- libmemcached_configuration
- libmemcached/memcached_last_error_message
-
-#################
-Working with data
-#################
-
-.. toctree::
- :maxdepth: 1
-
- memcached_auto
- memcached_delete
- libmemcached/memcached_exist
- memcached_flush_buffers
- memcached_flush
- memcached_get
- memcached_result_st
- memcached_set
- memcached_append
- memcached_cas
-
-
-###############
-Advanced Topics
-###############
-
-.. toctree::
- :maxdepth: 1
-
- libmemcached-1.0/memcached_set_encoding_key
- memcached_behavior
- memcached_callback
- memcached_dump
- memcached_generate_hash_value
- memcached_memory_allocators
- memcached_quit
- libmemcached/memcached_return_t
- memcached_sasl
- memcached_server_st
- memcached_servers
- memcached_strerror
- error_messages
- memcached_user_data
- memcached_verbosity
- memcached_version
- libmemcached/defaults
-
-##################
-Interface Versions
-##################
-
-.. toctree::
- :titlesonly:
-
- libmemcached-1.0/index
- libmemcached-1.1/index
-
-####################
-Deprecated Functions
-####################
-
-.. toctree::
- :titlesonly:
-
- libmemcached/memcached_fetch
-
-#################
-Platform Specific
-#################
-
-.. toctree::
- :maxdepth: 1
-
- tap
- types
-
-#################################
-Deriving statistics from a server
-#################################
-
-.. toctree::
- :maxdepth: 1
-
- memcached_analyze
- memcached_stats
-
-----------------
-Libmemcachedutil
-----------------
-
-.. toctree::
- :maxdepth: 1
-
- libmemcachedutil
- memcached_pool
-
--------------------
-Client Applications
--------------------
-
-.. toctree::
- :maxdepth: 1
-
- bin/memcapable
- bin/memcat
- bin/memcp
- bin/memdump
- bin/memerror
- bin/memflush
- bin/memrm
- bin/memslap
- bin/memaslap
- bin/memstat
- bin/memexist.rst
- bin/memparse.rst
- bin/memping.rst
- bin/memtouch.rst
-
-----------
-Libhashkit
-----------
-
-.. toctree::
- :maxdepth: 1
-
- libhashkit
- hashkit_create
- hashkit_functions
- hashkit_value
-
-==================
-Indices and tables
-==================
-
-* :ref:`genindex`
-* :ref:`modindex`
-* :ref:`search`
-
+++ /dev/null
-======================
-Introducing libhashkit
-======================
-
-
-.. code-block:: c
-
- 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:
-`http://libmemcached.org/ <http://libmemcached.org/>`_
-
-
---------
-SEE ALSO
---------
-
-:manpage:`libhashkit(3)`
-
+++ /dev/null
-====================
-libmemcached 1.0 API
-====================
-
-
-.. toctree::
- :titlesonly:
-
- memcached_touch
+++ /dev/null
-==================
-Set encryption key
-==================
-
-.. index:: object: memcached_st
-
---------
-SYNOPSIS
---------
-
-#include <libmemcached/memcached.h>
-
-.. c:function:: void memcached_set_encoding_key (memcached_st *ptr, const char *string, const size_t string_length)
-
-Compile and link with -lmemcached
-
------------
-DESCRIPTION
------------
-
-
-:c:func:`memcached_set_encoding_key` sets the key that will be used to encrypt and decrypt data as it is sent and recieved from the server.
-
-Currently only AES is is supported.
-
-
-------
-RETURN
-------
-
-
-A value of type :c:type:`memcached_return_t` is returned On success that value
-will be :c:type:`MEMCACHED_SUCCESS`. Use :c:func:`memcached_strerror` to
-translate this value to a printable string.
-
-
-----
-HOME
-----
-
-
-To find out more information please check:
-`http://libmemcached.org/ <http://libmemcached.org/>`_
-
-
-------
-AUTHOR
-------
-
-
-Brian Aker, <brian@tangent.org>
-
-
---------
-SEE ALSO
---------
-
-:manpage:`memcached(1)` :manpage:`libmemcached(3)` :manpage:`memcached_strerror(3)`
+++ /dev/null
-===========================================
-memcached_touch, memcached_touch_by_key
-===========================================
-
-.. index:: object: memcached_st
-
---------
-SYNOPSIS
---------
-
-
-#include <libmemcached/memcached.h>
-
-.. c:function:: memcached_return_t memcached_touch (memcached_st *ptr, const char *key, size_t key_length, time_t expiration)
-
-.. c:function:: memcached_return_t memcached_touch_by_key (memcached_st *ptr, const char *group_key, size_t group_key_length, const char *key, size_t key_length, time_t expiration)
-
-Compile and link with -lmemcached
-
------------
-DESCRIPTION
------------
-
-
-:c:func:`memcached_touch` is used to update the expiration time on an existing key.
-:c:func:`memcached_touch_by_key` works the same, but it takes a master key
-to find the given value.
-
-
-------
-RETURN
-------
-
-
-A value of type :c:type:`memcached_return_t` is returned
-On success that value will be :c:type:`MEMCACHED_SUCCESS`.
-Use :c:func:`memcached_strerror` to translate this value to a printable
-string.
-
-----
-HOME
-----
-
-To find out more information please check:
-`http://libmemcached.org/ <http://libmemcached.org/>`_
-
-
-------
-AUTHOR
-------
-
-
-Brian Aker, <brian@tangent.org>
-
-
---------
-SEE ALSO
---------
-
-:manpage:`memcached(1)` :manpage:`libmemcached(3)` :manpage:`memcached_strerror(3)`
-
+++ /dev/null
-====================
-libmemcached 1.1 API
-====================
-
-The 1.1 is still being finalized. It will be the 1.0 API minus deprecated functions.
+++ /dev/null
-==============================================
-Introducing the C Client Library for memcached
-==============================================
-
---------
-SYNOPSIS
---------
-
-#include <libmemcached/memcached.h>
-
-Compile and link with -lmemcached
-
-=======
-
-libMemcached is an open source C/C++ client library and tools for the memcached server (http://memcached.org/). It has been designed to be light on memory usage, thread safe, and provide full access to server side methods.
-
-libMemcached was designed to provide the greatest number of options to use Memcached. Some of the features provided:
-
-1. Asynchronous and Synchronous Transport Support.
-2. Consistent Hashing and Distribution.
-3. Tunable Hashing algorithm to match keys.
-4. Access to large object support.
-5. Local replication.
-6. A complete reference guide and documentation to the API.
-7. Tools to Manage your Memcached networks.
-
------------
-DESCRIPTION
------------
-
-
-"Memcached is a high-performance, distributed memory object caching
-system, generic in nature, but intended for use in speeding up dynamic web
-applications by alleviating database load." `http://memcached.org/ <http://memcached.org/>`_
-
-:program:`libmemcached` is a small, thread-safe client library for the
-memcached protocol. The code has all been written to allow
-for both web and embedded usage. It handles the work behind routing
-individual keys to specific servers specified by the developer (and values are
-matched based on server order as supplied by the user). It implements
-a modular and consistent method of object distribution.
-
-There are multiple implemented routing and hashing methods. See the
-:c:func:`memcached_behavior_set` manpage for more information.
-
-All operations are performed against a :c:type:`memcached_st` structure.
-These structures can either be dynamically allocated or statically
-allocated and then initialized by :c:func:`memcached_create`. Functions have
-been written in order to encapsulate the :c:type:`memcached_st`. It is not
-recommended that you operate directly against the structure.
-
-Nearly all functions return a :c:type:`memcached_return_t` value.
-This value can be translated to a printable string with
-:c:type:`memcached_strerror`.
-
-Objects are stored on servers by hashing keys. The hash value maps the key to a particular server. All clients understand how this hashing works, so it is possibly to reliably both push data to a server and retrieve data from a server.
-
-Group keys can be optionally used to group sets of objects with servers.
-
-Namespaces are supported, and can be used to partition caches so that multiple applications can use the same memcached servers.
-
-:c:type:`memcached_st` structures are thread-safe, but each thread must
-contain its own structure (that is, if you want to share these among
-threads you must provide your own locking). No global variables are
-used in this library.
-
-If you are working with GNU autotools you will want to add the following to
-your COPYING to properly include libmemcached in your application.
-
-PKG_CHECK_MODULES(DEPS, libmemcached >= 0.8.0)
-AC_SUBST(DEPS_CFLAGS)
-AC_SUBST(DEPS_LIBS)
-
-Some features of the library must be enabled through :c:func:`memcached_behavior_set`.
-
-Hope you enjoy it!
-
-
----------
-CONSTANTS
----------
-
-
-A number of constants have been provided for in the library.
-
-
-.. c:macro:: MEMCACHED_DEFAULT_PORT
-
- The default port used by memcached(3).
-
-
-.. c:macro:: MEMCACHED_MAX_KEY
-
- Default maximum size of a key (which includes the null pointer). Master keys
- have no limit, this only applies to keys used for storage.
-
-
-.. c:macro:: MEMCACHED_MAX_KEY
-
- Default size of key (which includes the null pointer).
-
-
-.. c:macro:: MEMCACHED_STRIDE
-
- This is the "stride" used in the consistent hash used between replicas.
-
-
-.. c:macro:: MEMCACHED_MAX_HOST_LENGTH
-
- Maximum allowed size of the hostname.
-
-
-.. c:macro:: LIBMEMCACHED_VERSION_STRING
-
- String value of libmemcached version such as "1.23.4"
-
-
-.. c:macro:: LIBMEMCACHED_VERSION_HEX
-
- Hex value of the version number. "0x00048000" This can be used for comparing versions based on number.
-
-
-.. c:macro:: MEMCACHED_PREFIX_KEY_MAX_SIZE
-
- Maximum length allowed for namespacing of a key.
-
-
-
----------------------
-THREADS AND PROCESSES
----------------------
-
-
-When using threads or forked processes it is important to keep one instance
-of :c:type:`memcached_st` per process or thread. Without creating your own
-locking structures you can not share a single :c:type:`memcached_st`. However,
-you can call :c:func:`memcached_quit` on a :c:type:`memcached_st` and then use the resulting cloned structure.
-
-
-----
-HOME
-----
-
-
-To find out more information please check:
-`http://libmemcached.org/ <http://libmemcached.org/>`_
-
-
---------
-SEE ALSO
---------
-
-
-:manpage:`memcached(1)` :manpage:`libmemcached_examples(3)`
-:manpage:`libmemcached(1)` :manpage:`memcat(1)` :manpage:`memcp(1)`
-:manpage:`memflush(1)` :manpage:`memrm(1)` :manpage:`memslap(1)`
-:manpage:`memstat(1)` :manpage:`memcached_fetch(3)`
-:manpage:`memcached_replace(3)` :manpage:`memcached_server_list_free(3)`
-:manpage:`libmemcached_examples(3)` :manpage:`memcached_clone(3)`
-:manpage:`memcached_free(3)` :manpage:`memcached_server_add(3)`
-:manpage:`memcached_server_push(3)` :manpage:`memcached_add(3)`
-:manpage:`memcached_get(3)` :manpage:`memcached_server_count(3)`
-:manpage:`memcached_create(3)` :manpage:`memcached_increment(3)`
-:manpage:`memcached_server_list(3)` :manpage:`memcached_set(3)`
-:manpage:`memcached_decrement(3)` :manpage:`memcached_mget(3)`
-:manpage:`memcached_server_list_append(3)` :manpage:`memcached_strerror(3)`
-:manpage:`memcached_delete(3)` :manpage:`memcached_quit(3)`
-:manpage:`memcached_server_list_count(3)` :manpage:`memcached_verbosity(3)`
-:manpage:`memcached_server_add_unix_socket(3)`
-:manpage:`memcached_result_create(3)` :manpage:`memcached_result_free(3)`
-:manpage:`memcached_result_key_value(3)`
-:manpage:`memcached_result_key_length(3)`
-:manpage:`memcached_result_value(3)` :manpage:`memcached_result_length(3)`
-:manpage:`memcached_result_flags(3)` :manpage:`memcached_result_cas(3)`
-:manpage:`memcached_result_st(3)` :manpage:`memcached_append(3)`
-:manpage:`memcached_prepend(3)` :manpage:`memcached_fetch_result(3)`
-:manpage:`memerror(1)` :manpage:`memcached_get_by_key(3)`
-:manpage:`memcached_mget_by_key(3)` :manpage:`memcached_delete_by_key(3)`
-:manpage:`memcached_fetch_execute(3)` :manpage:`memcached_callback_get(3)`
-:manpage:`memcached_callback_set(3)` :manpage:`memcached_version(3)`
-:manpage:`memcached_lib_version(3)` :manpage:`memcached_result_set_value(3)`
-:manpage:`memcached_dump(3)` :manpage:`memdump(1)`
-:manpage:`memcached_set_memory_allocators(3)`
-:manpage:`memcached_get_memory_allocators(3)`
-:manpage:`memcached_get_user_data(3)` :manpage:`memcached_set_user_data(3)`
+++ /dev/null
-========
-DEFAULTS
-========
-
-
-.. c:macro:: MEMCACHED_DEFAULT_TIMEOUT
-
-Value 5000
-
-.. c:macro:: MEMCACHED_DEFAULT_CONNECT_TIMEOUT
-
- Value 4000
-
-.. c:macro:: MEMCACHED_CONTINUUM_ADDITION
-
- Value 10. How many extra slots we should build for in the continuum.
-
-.. c:macro:: MEMCACHED_SERVER_FAILURE_LIMIT
-
- Value 5
-
-.. c:macro:: MEMCACHED_SERVER_FAILURE_RETRY_TIMEOUT
-
- Value 2
-
-.. c:macro:: MEMCACHED_SERVER_FAILURE_DEAD_TIMEOUT
-
- Value 0
-
-.. c:macro:: `MEMCACHED_PREFIX_KEY_MAX_SIZE`
-
- Value 128
-
-.. c:macro:: MEMCACHED_VERSION_STRING_LENGTH
-
- Value 24
+++ /dev/null
-===========================
-Determine if a keys exists.
-===========================
-
-.. index:: object: memcached_st
-
---------
-SYNOPSIS
---------
-
-
-#include <libmemcached/memcached.h>
-
-.. c:function:: memcached_return_t memcached_exist(memcached_st *ptr, char *key, size_t *key_length)
-
-.. c:function:: memcached_return_t memcached_exist_by_key(memcached_st *ptr, char *group_key, size_t *group_key_length, char *key, size_t *key_length)
-
- .. versionadded:: 0.53
-
-Compile and link with -lmemcached
-
-
------------
-DESCRIPTION
------------
-
-:c:func:`memcached_exist()` can be used to check to see if a key exists. No value is returned if the key exists, or does not exist, on the server.
-
-
-------
-RETURN
-------
-
-:c:func:`memcached_exist()` sets error to
-to :c:type:`MEMCACHED_SUCCESS` upon finding that the key exists.
-:c:type:`MEMCACHED_NOTFOUND` will be return if the key is not found.
-
-
-----
-HOME
-----
-
-To find out more information please check:
-`http://libmemcached.org/ <http://libmemcached.org/>`_
-
-
---------
-SEE ALSO
---------
-
-:manpage:`memcached(1)` :manpage:`libmemcached(3)` :manpage:`memcached_strerror(3)`
-
-
+++ /dev/null
-=================
-memcached_fetch
-=================
-
-.. index:: object: memcached_st
-
---------
-SYNOPSIS
---------
-
-
-#include <libmemcached/memcached.h>
-
-.. c:function:: char *memcached_fetch(memcached_st *ptr, char *key, size_t *key_length, size_t *value_length, uint32_t *flags, memcached_return_t *error)
-
- .. deprecated:: 0.50
- Use :c:func:`memcached_fetch_result` instead.
-
-Compile and link with -lmemcached
-
-
------------
-DESCRIPTION
------------
-
-:c:func:`memcached_fetch` is used to fetch an individual value from the server. :c:func:`memcached_mget` must always be called before using this method.
-You must pass in a key and its length to fetch the object. You must supply
-three pointer variables which will give you the state of the returned
-object. A :c:type:`uint32_t` pointer to contain whatever flags you stored with the value, a :c:type:`size_t` pointer which will be filled with size of of the
-object, and a :c:type:`memcached_return_t` pointer to hold any error. The
-object will be returned upon success and NULL will be returned on failure. :c:type:`MEMCACHED_END` is returned by the \*error value when all objects that have been found are returned. The final value upon :c:type:`MEMCACHED_END` is null.
-
-Values returned by :c:func:`memcached_fetch` must be freed by the caller.
-
-All of the above functions are not tested when the
-:c:type:`MEMCACHED_BEHAVIOR_USE_UDP` has been set. Executing any of these
-functions with this behavior on will result in :c:type:`MEMCACHED_NOT_SUPPORTED` being returned, or for those functions which do not return a :c:type:`memcached_return_t`, the error function parameter will be set to :c:type:`MEMCACHED_NOT_SUPPORTED`.
-
-
-------
-RETURN
-------
-
-:c:func:`memcached_fetch` sets error to
-to :c:type:`MEMCACHED_END` upon successful conclusion.
-:c:type:`MEMCACHED_NOTFOUND` will be return if no keys at all were found.
-
-:c:type:`MEMCACHED_KEY_TOO_BIG` is set to error whenever :c:func:`memcached_fetch` was used
-and the key was set larger then :c:type:`MEMCACHED_MAX_KEY`, which was the largest
-key allowed for the original memcached ascii server.
-
-
-----
-HOME
-----
-
-To find out more information please check:
-`http://libmemcached.org/ <http://libmemcached.org/>`_
-
-
---------
-SEE ALSO
---------
-
-:manpage:`memcached(1)` :manpage:`libmemcached(3)` :manpage:`memcached_strerror(3)` :manpage:`memcached_fetch_result(3)`
-
+++ /dev/null
-=================
-Retrieving errors
-=================
-
-
---------
-SYNOPSIS
---------
-
-
-#include <libmemcached/memcached.h>
-
-.. c:function:: const char *memcached_last_error_message(memcached_st *)
-
-Compile and link with -lmemcached
-
-
------------
-DESCRIPTION
------------
-
-:c:func:`memcached_last_error_message` is used to return the last error
-message that the server responded too. If this error came from a specific
-server, its hostname and port will be provided in the error message.
-
-------
-RETURN
-------
-
-memcached_last_error_message returns a const char* which does not need to be
-de-allocated. If no error has occurred then it will return NULL.
-
-----
-HOME
-----
-
-To find out more information please check:
-`http://libmemcached.org/ <http://libmemcached.org/>`_
-
-
---------
-SEE ALSO
---------
-
-:manpage:`memcached(1)` :manpage:`libmemcached(3)` :manpage:`memcached_strerror(3)`
-
-
+++ /dev/null
-================================
-Error Codes (memcached_return_t)
-================================
-
---------
-SYNOPSIS
---------
-
-#include <libmemcached/memcached.h>
-
-.. c:type:: memcached_return_t
-
-.. c:function:: const char *libmemcached_strerror(memcached_return_t rc)
-
-.. c:function:: bool libmemcached_success(memcached_return_t rc)
-
-.. c:function:: bool libmemcached_failure(memcached_return_t rc)
-
-.. c:function:: bool libmemcache_continue(memcached_return_t rc)
-
-.. c:function:: bool memcached_success(memcached_return_t)
-
-.. c:function:: bool memcached_failure(memcached_return_t)
-
-
-:c:func:`memcached_success` return true if :c:type:`MEMCACHED_SUCCESS` tested true.
-
-:c:func:`memcached_failure` return true if any value other then :c:type:`MEMCACHED_SUCCESS` was provided.
-
-
-Libmemcached return types:
-++++++++++++++++++++++++++
-
-
-:c:type:`MEMCACHED_SUCCESS`
-
-:c:type:`MEMCACHED_FAILURE`
-
-:c:type:`MEMCACHED_HOST_LOOKUP_FAILURE`
-
-:c:type:`MEMCACHED_CONNECTION_FAILURE`
-
-:c:type:`MEMCACHED_CONNECTION_BIND_FAILURE`
-
-:c:type:`MEMCACHED_WRITE_FAILURE`
-
-:c:type:`MEMCACHED_READ_FAILURE`
-
-:c:type:`MEMCACHED_UNKNOWN_READ_FAILURE`
-
-:c:type:`MEMCACHED_PROTOCOL_ERROR`
-
-:c:type:`MEMCACHED_CLIENT_ERROR`
-
-:c:type:`MEMCACHED_SERVER_ERROR`
-
-:c:type:`MEMCACHED_CONNECTION_SOCKET_CREATE_FAILURE`
-
-:c:type:`MEMCACHED_DATA_EXISTS`
-
-:c:type:`MEMCACHED_DATA_DOES_NOT_EXIST`
-
-:c:type:`MEMCACHED_NOTSTORED`
-
-:c:type:`MEMCACHED_STORED`
-
-:c:type:`MEMCACHED_NOTFOUND`
-
-:c:type:`MEMCACHED_MEMORY_ALLOCATION_FAILURE`
-
-:c:type:`MEMCACHED_PARTIAL_READ`
-
-:c:type:`MEMCACHED_SOME_ERRORS`
-
-:c:type:`MEMCACHED_NO_SERVERS`
-
-:c:type:`MEMCACHED_END`
-
-:c:type:`MEMCACHED_DELETED`
-
-:c:type:`MEMCACHED_VALUE`
-
-:c:type:`MEMCACHED_STAT`
-
-:c:type:`MEMCACHED_ITEM`
-
-:c:type:`MEMCACHED_ERRNO`
-
-:c:type:`MEMCACHED_FAIL_UNIX_SOCKET`
-
-:c:type:`MEMCACHED_NOT_SUPPORTED`
-
-:c:type:`MEMCACHED_NO_KEY_PROVIDED`
-
-:c:type:`MEMCACHED_FETCH_NOTFINISHED`
-
-:c:type:`MEMCACHED_TIMEOUT`
-
-:c:type:`MEMCACHED_BUFFERED`
-
-:c:type:`MEMCACHED_BAD_KEY_PROVIDED`
-
-:c:type:`MEMCACHED_INVALID_HOST_PROTOCOL`
-
-:c:type:`MEMCACHED_SERVER_MARKED_DEAD`
-
-:c:type:`MEMCACHED_UNKNOWN_STAT_KEY`
-
-:c:type:`MEMCACHED_E2BIG`
-
-:c:type:`MEMCACHED_INVALID_ARGUMENTS`
-
-:c:type:`MEMCACHED_KEY_TOO_BIG`
-
-:c:type:`MEMCACHED_AUTH_PROBLEM`
-
-:c:type:`MEMCACHED_AUTH_FAILURE`
-
-:c:type:`MEMCACHED_AUTH_CONTINUE`
-
-:c:type:`MEMCACHED_PARSE_ERROR`
-
-:c:type:`MEMCACHED_PARSE_USER_ERROR`
-
-:c:type:`MEMCACHED_DEPRECATED`
-
---------
-SEE ALSO
---------
-
-:manpage:`memcached` :manpage:`libmemcached` :manpage:`memcached_client_error` or :manpage:`memcached_worker_error`
-
+++ /dev/null
-========================
-Configuring Libmemcached
-========================
-
-.. highlightlang:: c
-
---------
-SYNOPSIS
---------
-
-#include <libmemcached-1.0/memcached.h>
-
-.. envvar:: LIBMEMCACHED
-
-.. c:function:: memcached_st *memcached(const char *string, size_t string_length)
-
-.. c:function:: memcached_return_t libmemcached_check_configuration(const char *option_string, size_t length, char *error_buffer, size_t error_buffer_size)
-
-Compile and link with -lmemcached
-
-
------------
-DESCRIPTION
------------
-
-Libmemcached implements a custom language for configuring and modifying
-servers. By passing in an option string you can generate a ``memcached_st`` object
-that you can use in your application directly.
-
-.. describe:: --SERVER=<servername>:<optional_port>/?<optional_weight>
-
-Provide a servername to be used by the client. Providing a weight will cause weighting to occur with all hosts with each server getting a default weight of 1.
-
-.. describe:: --SOCKET=\"<filepath>/?<optional_weight>\"
-
-Provide a filepath to a UNIX socket file. Providing a weight will cause weighting to occur with all hosts with each server getting a default weight of 1.
-
-.. describe:: --VERIFY-KEY
-
-Verify that keys that are being used fit within the design of the protocol being used.
-
-.. describe:: --REMOVE_FAILED_SERVERS
-
-Enable the behavior :c:type:`MEMCACHED_BEHAVIOR_REMOVE_FAILED_SERVERS`.
-
-.. describe:: --BINARY-PROTOCOL
-
-Force all connections to use the binary protocol.
-
-.. describe:: --BUFFER-REQUESTS
-
-Please see :c:type:`MEMCACHED_BEHAVIOR_BUFFER_REQUESTS`.
-
-.. describe:: --CONFIGURE-FILE=
-
-Provide a configuration file to be used to load requests. Beware that by using a configuration file libmemcached will reset memcached_st based on information only contained in the file.
-
-.. describe:: --CONNECT-TIMEOUT=
-
-Please see :c:type:`MEMCACHED_BEHAVIOR_CONNECT_TIMEOUT`.
-
-.. describe:: --DISTRIBUTION=
-
-Set the distribution model used by the client. See :manpage:`` for more details.
-
-.. describe:: --HASH=
-
-Set the hashing alogrthm used for placing keys on servers.
-
-.. describe:: --HASH-WITH-NAMESPACE
-
-When enabled the prefix key will be added to the key when determining which
-server to store the data in.
-
-.. describe:: --NOREPLY
-
-Enable "no reply" for all calls that support this. It is highly recommended
-that you use this option with the binary protocol only.
-
-.. describe:: --NUMBER-OF-REPLICAS=
-
-Set the nummber of servers that keys will be replicated to.
-
-.. describe:: --RANDOMIZE-REPLICA-READ
-
-Select randomly the server within the replication pool to read from.
-
-.. describe:: --SORT-HOSTS
-
-When adding new servers always calculate their distribution based on sorted naming order.
-
-.. describe:: --SUPPORT-CAS
-
-See :manpage:`memcached_behavior_set(3)` for :c:type:`MEMCACHED_BEHAVIOR_SUPPORT_CAS`
-
-.. describe:: --USE-UDP
-
-See :manpage:`memcached_behavior_set(3)` for :c:type:`MEMCACHED_BEHAVIOR_USE_UDP`
-
-.. describe:: --NAMESPACE=
-
-A namespace is a container that provides context for keys, only other
-requests that know the namespace can access these values. This is
-accomplished by prepending the namespace value to all keys.
-
-
-**********************
-Mecached Pool Options:
-**********************
-
-.. describe:: --POOL-MIN
-
-Initial size of pool.
-
-.. describe:: --POOL-MAX
-
-Maximize size of the pool.
-
-************
-I/O Options:
-************
-
-.. describe:: --TCP-NODELAY
-
-See :manpage:`memcached_behavior_set(3)` for MEMCACHED_BEHAVIOR_TCP_NODELAY
-
-.. describe:: --TCP-KEEPALIVE
-
-See :manpage:`memcached_behavior_set(3)` for MEMCACHED_BEHAVIOR_TCP_KEEPALIVE
-
-.. describe:: --RETRY-TIMEOUT=
-
-See :manpage:`memcached_behavior_set(3)` for MEMCACHED_BEHAVIOR_RETRY_TIMEOUT
-
-.. describe:: --SERVER-FAILURE-LIMIT=
-
-See :manpage:`memcached_behavior_set(3)` for MEMCACHED_BEHAVIOR_SERVER_FAILURE_LIMIT
-
-.. describe:: --SND-TIMEOUT=
-
-See :manpage:`memcached_behavior_set(3)` for MEMCACHED_BEHAVIOR_SND_TIMEOUT
-
-.. describe:: --SOCKET-RECV-SIZE=
-
-See :manpage:`memcached_behavior_set(3)` for MEMCACHED_BEHAVIOR_SOCKET_RECV_SIZE
-
-.. describe:: --SOCKET-SEND-SIZE=
-
-See :manpage:`memcached_behavior_set(3)` for MEMCACHED_BEHAVIOR_SOCKET_SEND_SIZE
-
-.. describe:: --POLL-TIMEOUT=
-
-That sets the value of the timeout used by :manpage: `poll()`.
-
-.. describe:: --IO-BYTES-WATERMARK=
-
-.. describe:: --IO-KEY-PREFETCH=
-
-.. describe:: --IO-MSG-WATERMARK=
-
-.. describe:: --TCP-KEEPIDLE
-
-.. describe:: --RCV-TIMEOUT=
-
-
-
-******
-Other:
-******
-
-
-.. describe:: INCLUDE
-
-Include a file in configuration. Unlike --CONFIGURE-FILE= this will not reset memcached_st
-
-.. describe:: RESET
-
-Reset memcached_st and continue to process.
-
-.. describe:: END
-
-End configutation processing.
-
-.. describe:: ERROR
-
-End configutation processing and throw an error.
-
-
-------
-RETURN
-------
-
-
-:c:func:`memcached()` returns a pointer to the memcached_st that was
-created (or initialized). On an allocation failure, it returns NULL.
-
-
-
--------
-EXAMPLE
--------
-
-
-.. code-block:: c
-
- const char *config_string= "--SERVER=host10.example.com --SERVER=host11.example.com --SERVER=host10.example.com"
- memcached_st *memc= memcached(config_string, strlen(config_string);
- {
- ...
- }
- memcached_free(memc);
-
-
-
-----
-HOME
-----
-
-
-To find out more information please check:
-`http://libmemcached.org/ <http://libmemcached.org/>`_
-
-
-
---------
-SEE ALSO
---------
-
-
-:manpage:`memcached(1)` :manpage:`libmemcached(3)` :manpage:`memcached_strerror(3)`
+++ /dev/null
-========
-Examples
-========
-
-Examples for libmemcached
-
------------
-DESCRIPTION
------------
-
-
-For full examples, test cases are found in tests/\*.c in the main
-distribution. These are always up to date, and are used for each test run of
-the library.
-
-
----------------------
-Connecting to servers
----------------------
-
-
-.. code-block:: c
-
- const char *config_string= "--SERVER=host10.example.com --SERVER=host11.example.com --SERVER=host10.example.com"
- memcached_st *memc= memcached(config_string, strlen(config_string);
- {
- ...
- }
- memcached_free(memc);
-
-
-In the above code you create a :c:type:`memcached_st` object with three server
-by making use of :c:func:`memcached_create`.
-
-
---------------------------
-Creating a pool of servers
---------------------------
-
-
-
-.. code-block:: c
-
-Creating a pool of Servers::
-
- const char *config_string= "--SERVER=host10.example.com --SERVER=host11.example.com --SERVER=host10.example.com";
-
- memcached_pool_st* pool= memcached_pool(config_string, strlen(config_string));
-
- memcached_return_t rc;
-
- memcached_st *memc= memcached_pool_pop(pool, false, &rc);
-
- .... do work
-
- /*
- Release the memc_ptr that was pulled from the pool
- */
- memcached_pool_push(pool, memc);
-
- /*
- Destroy the pool.
- */
- memcached_pool_destroy(pool);
-
-
-
-In the above code you create a :c:type:`memcached_pool_st` object with three
-server by making use of :c:func:`memcached_pool()`.
-
-When :c:func:`memcached_pool_destroy()` all memory will be released that is associated
-with the pool.
-
-
-----------------------------
-Adding a value to the server
-----------------------------
-
-
-
-.. code-block:: c
-
-Adding a value to the Server::
-
- char *key= "foo";
- char *value= "value";
-
- memcached_return_t rc= memcached_set(memc, key, strlen(key), value, value_length, (time_t)0, (uint32_t)0);
-
- if (rc != MEMCACHED_SUCCESS)
- {
- ... // handle failure
- }
-
-
-It is best practice to always look at the return value of any operation.
-
-
-------------------------
-Fetching multiple values
-------------------------
-
-
-
-.. code-block:: c
-
- memcached_return_t rc;
- char *keys[]= {"fudge", "son", "food"};
- size_t key_length[]= {5, 3, 4};
- unsigned int x;
- uint32_t flags;
-
- char return_key[MEMCACHED_MAX_KEY];
- size_t return_key_length;
- char *return_value;
- size_t return_value_length;
-
- rc= memcached_mget(memc, keys, key_length, 3);
-
- x= 0;
- while ((return_value= memcached_fetch(memc, return_key, &return_key_length,
- &return_value_length, &flags, &rc)))
- {
- free(return_value);
- x++;
- }
-
-
-Notice that you freed values returned from memcached_fetch(). The define
-:c:type:`MEMCACHED_MAX_KEY` is provided for usage.
-
-
-
-----
-HOME
-----
-
-
-To find out more information please check:
-`http://libmemcached.org/ <http://libmemcached.org/>`_
-
-
---------
-SEE ALSO
---------
-
-
-:manpage:`memcached(1)`
-
+++ /dev/null
-===========
-Introducing
-===========
-
-
-Utility library for libmemcached
-
-
---------
-SYNOPSIS
---------
-
-.. code-block:: c
-
- cc [ flag ... ] file ... -lmemcachedutil
-
- #include <libmemcached/memcached_util.h>
-
-
-
------------
-DESCRIPTION
------------
-
-
-:program:`libmemcachedutil` is a small and thread-safe client library that
-provides extra functionality built on top of :program:`libmemcached`.
-
-
--------
-THREADS
--------
-
-
-Do not try to access an instance of :c:type:`memcached_st` from multiple threads
-at the same time. If you want to access memcached from multiple threads
-you should either clone the :c:type:`memcached_st`, or use the memcached pool
-implementation. see :c:func:`memcached_pool_create`.
-
-
-----
-HOME
-----
-
-
-To find out more information please check:
-`http://libmemcached.org/ <http://libmemcached.org/>`_
-
-
---------
-SEE ALSO
---------
-
-
-:manpage:`libmemcached(3)` :manpage:`memcached_pool_create(3)` :manpage:`memcached_pool_destroy(3)` :manpage:`memcached_pool_pop(3)` :manpage:`memcached_pool_push(3)`
-
+++ /dev/null
-=================
-Anaylzing servers
-=================
-
-
-Analyze server information
-
-
---------
-SYNOPSIS
---------
-
-.. index:: object: memcached_analysis_st
-
-
-#include <libmemcached/memcached.h>
-
-.. c:type:: memcached_analysis_st
-
-.. c:function:: memcached_analysis_st * memcached_analyze (memcached_st *ptr, memcached_stat_st *stat, memcached_return_t *error)
-
-Compile and link with -lmemcached
-
------------
-DESCRIPTION
------------
-
-
-:program:`libmemcached` has the ability to query a memcached server (or
-collection of servers) for their current state. Queries to find state return a
-:c:type:`memcached_analysis_st` structure. You are responsible for freeing this structure.
-
-:c:func:`memcached_analyze` analyzes useful information based on the
-provided servers and sets the result to the :c:type:`memcached_analysis_st`
-structure. The return value must be freed by the calling application.
-
-A command line tool, :program:`memstat` with the option :option:`memstat --analyze`,
-is provided so that you do not have to write an application to use this method.
-
-
-------
-RETURN
-------
-
-
-A pointer to the allocated :c:type:`memcached_analysis_st` structure on
-success and a NULL pointer on failure. You may inspect the error detail by
-checking the :c:type:`memcached_return_t` value.
-
-Any method returning a :c:type:`memcached_analysis_st` expects you to free the
-memory allocated for it.
-
-
-----
-HOME
-----
-
-
-To find out more information please check:
-`http://libmemcached.org/ <http://libmemcached.org/>`_
-
-
---------
-SEE ALSO
---------
-
-
-:manpage:`memcached(1)` :manpage:`libmemcached(3)` :manpage:`memcached_strerror(3)`
-
+++ /dev/null
-=============================================
-Appending or Prepending to data on the server
-=============================================
-
-.. index:: object: memcached_st
-
-Appending or Prepending to data on the server
-
-
---------
-SYNOPSIS
---------
-
-
-#include <libmemcached/memcached.h>
-
-.. c:function:: memcached_return_t memcached_prepend(memcached_st *ptr, const char *key, size_t key_length, const char *value, size_t value_length, time_t expiration, uint32_t flags)
-
-.. c:function:: memcached_return_t memcached_append(memcached_st *ptr, const char *key, size_t key_length, const char *value, size_t value_length, time_t expiration, uint32_t flags)
-
-.. c:function:: memcached_return_t memcached_prepend_by_key(memcached_st *ptr, const char *group_key, size_t group_key_length, const char *key, size_t key_length, const char *value, size_t value_length, time_t expiration, uint32_t flags)
-
-.. c:function:: memcached_return_t memcached_append_by_key(memcached_st *ptr, const char *group_key, size_t group_key_length, const char *key, size_t key_length, const char *value, size_t value_length, time_t expiration, uint32_t flags)
-
-Compile and link with -lmemcached
-
-
------------
-DESCRIPTION
------------
-
-
-:c:func:`memcached_prepend` and memcached_append are used to
-modify information on a server. All methods take a key, and its length to
-store the object. Keys are currently limited to 250 characters when using
-either a version of memcached which is 1.4 or below, or when using the text
-protocol. You must supply both a value and a length. Optionally you
-may test an expiration time for the object and a 16 byte value (it is
-meant to be used as a bitmap). "flags" is a 4byte space that is stored
-alongside of the main value. Many sub libraries make use of this field,
-so in most cases users should avoid making use of it.
-
-:c:func:`memcached_prepend` places a segment of data before the last piece
-of data stored. Currently expiration and key are not used in the server.
-
-:c:func:`memcached_append` places a segment of data at the end of the last
-piece of data stored. Currently expiration and key are not used in the server.
-
-:c:func:`memcached_prepend_by_key` and
-:c:func:`memcached_append_by_key` methods both behave in a similar
-method as the non key methods. The difference is that they use their
-group_key parameter to map objects to particular servers.
-
-If you are looking for performance, :c:func:`memcached_set` with non-blocking
-IO is the fastest way to store data on the server.
-
-All of the above functions are testsed with the
-:c:type:`MEMCACHED_BEHAVIOR_USE_UDP` behavior enabled. However, when using
-these operations with this behavior on, there are limits to the size of the
-payload being sent to the server. The reason for these limits is that the
-Memcached Server does not allow multi-datagram requests
-and the current server implementation sets a datagram size to 1400 bytes. Due
-to protocol overhead, the actual limit of the user supplied data is less than
-1400 bytes and depends on the protocol in use as, well as the operation being
-executed. When running with the binary protocol,
-:c:type:`MEMCACHED_BEHAVIOR_BINARY_PROTOCOL`, the size of the key,value,
-flags and expiry combined may not exceed 1368 bytes. When running with the
-ASCII protocol, the exact limit fluctuates depending on which function is
-being executed and whether the function is a cas operation or not. For
-non-cas ASCII set operations, there are at least 1335 bytes available
-to split among the key, key_prefix, and value; for cas ASCII operations
-there are at least 1318 bytes available to split among the key, key_prefix
-and value. If the total size of the command, including overhead, exceeds
-1400 bytes, a :c:type:`MEMCACHED_WRITE_FAILURE` will be returned.
-
-
-------
-RETURN
-------
-
-
-All methods return a value of type :c:type:`memcached_return_t`.
-On success the value will be :c:type:`MEMCACHED_SUCCESS`.
-Use :c:func:`memcached_strerror` to translate this value to a printable
-string.
-
-
-----
-HOME
-----
-
-
-To find out more information please check:
-`http://libmemcached.org/ <http://libmemcached.org/>`_
-
-
---------
-SEE ALSO
---------
-
-
-:manpage:`memcached(1)` :manpage:`libmemached(3)` :manpage:`memcached_strerror(3)` :manpage:`memcached_set(3)` :manpage:`memcached_add(3)` :manpage:`memcached_cas(3)` :manpage:`memcached_replace(3)`
-
+++ /dev/null
-====================================
-Incrementing and Decrementing Values
-====================================
-
-.. index:: object: memcached_st
-
---------
-SYNOPSIS
---------
-
-#include <libmemcached/memcached.h>
-
-.. c:function:: memcached_return_t memcached_increment (memcached_st *ptr, const char *key, size_t key_length, uint32_t offset, uint64_t *value)
-
-.. c:function:: memcached_return_t memcached_decrement (memcached_st *ptr, const char *key, size_t key_length, uint32_t offset, uint64_t *value)
-
-.. c:function:: memcached_return_t memcached_increment_with_initial (memcached_st *ptr, const char *key, size_t key_length, uint64_t offset, uint64_t initial, time_t expiration, uint64_t *value)
-
-.. c:function:: memcached_return_t memcached_decrement_with_initial (memcached_st *ptr, const char *key, size_t key_length, uint64_t offset, uint64_t initial, time_t expiration, uint64_t *value)
-
-.. c:function:: memcached_return_t memcached_increment_by_key (memcached_st *ptr, const char *group_key, size_t group_key_length, const char *key, size_t key_length, uint32_t offset, uint64_t *value)
-
-.. c:function:: memcached_return_t memcached_decrement_by_key (memcached_st *ptr, const char *group_key, size_t group_key_length, const char *key, size_t key_length, uint32_t offset, uint64_t *value)
-
-.. c:function:: memcached_return_t memcached_increment_with_initial_by_key (memcached_st *ptr, const char *group_key, size_t group_key_length, const char *key, size_t key_length, uint64_t offset, uint64_t initial, time_t expiration, uint64_t *value)
-
-.. c:function:: memcached_return_t memcached_decrement_with_initial_by_key (memcached_st *ptr, const char *group_key, size_t group_key_length, const char *key, size_t key_length, uint64_t offset, uint64_t initial, time_t expiration, uint64_t *value)
-
-Compile and link with -lmemcached
-
-
------------
-DESCRIPTION
------------
-
-
-:manpage:`memcached(1)` servers have the ability to increment and decrement keys
-(overflow and underflow are not detected). This gives you the ability to use
-memcached to generate shared sequences of values.
-
-memcached_increment takes a key and keylength and increments the value by
-the offset passed to it. The value is then returned via the uint32_t
-value pointer you pass to it.
-
-memcached_decrement takes a key and keylength and decrements the value by
-the offset passed to it. The value is then returned via the uint32_t
-value pointer you pass to it.
-
-memcached_increment_with_initial takes a key and keylength and increments
-the value by the offset passed to it. If the object specified by key does
-not exist, one of two things may happen: If the expiration value is
-MEMCACHED_EXPIRATION_NOT_ADD, the operation will fail. For all other
-expiration values, the operation will succeed by seeding the value for that
-key with a initial value to expire with the provided expiration time. The
-flags will be set to zero.The value is then returned via the uint32_t
-value pointer you pass to it. memcached_increment_with_initial is only available
-when using the binary protocol.
-
-memcached_decrement_with_initial takes a key and keylength and decrements
-the value by the offset passed to it. If the object specified by key does
-not exist, one of two things may happen: If the expiration value is
-MEMCACHED_EXPIRATION_NOT_ADD, the operation will fail. For all other
-expiration values, the operation will succeed by seeding the value for that
-key with a initial value to expire with the provided expiration time. The
-flags will be set to zero.The value is then returned via the uint32_t
-value pointer you pass to it. memcached_decrement_with_initial is only available
-when using the binary protocol.
-
-:c:func:`memcached_increment_by_key`, :c:func:`memcached_decrement_by_key`,
-:c:func:`memcached_increment_with_initial_by_key`, and
-:c:func:`memcached_decrement_with_initial_by_key` are master key equivalents of the above.
-
-
-------
-RETURN
-------
-
-
-A value of type :c:type:`memcached_return_t` is returned.
-On success that value will be :c:type:`MEMCACHED_SUCCESS`.
-Use memcached_strerror to translate this value to a printable string.
-
-
-----
-HOME
-----
-
-
-To find out more information please check:
-`http://libmemcached.org/ <http://libmemcached.org/>`_
-
-
---------
-SEE ALSO
---------
-
-
-:manpage:`memcached(1)` :manpage:`libmemcached(3)` :manpage:`memcached_strerror(3)`
+++ /dev/null
-================================
-Modifying how the driver behaves
-================================
-
-
-Manipulate the behavior of a memcached_st structure.
-
-.. index:: object: memcached_st
-
-
---------
-SYNOPSIS
---------
-
-
-#include <libmemcached/memcached.h>
-
-.. c:type:: memcached_behavior_t
-
-.. c:function:: uint64_t memcached_behavior_get (memcached_st *ptr, memcached_behavior_t flag)
-
-.. c:function:: memcached_return_t memcached_behavior_set (memcached_st *ptr, memcached_behavior_t flag, uint64_t data)
-
-Compile and link with -lmemcached
-
-
------------
-DESCRIPTION
------------
-
-:manpage:`libmemcached(3)` behavior can be modified by using :c:func:`memcached_behavior_set`. Default behavior is the library strives to be quick and
-accurate. Some behavior, while being faster, can also result in not entirely
-accurate behavior (for instance, :c:func:`memcached_set` will always respond
-with :c:type:`MEMCACHED_SUCCESS`).
-
-:c:func:`memcached_behavior_get` takes a behavior flag and returns whether or not that behavior is currently enabled in the client.
-
-:c:func:`memcached_behavior_set` changes the value of a particular option
-of the client. It takes both a flag (listed below) and a value. For simple
-on or off options you just need to pass in a value of 1. Calls to
-:c:func:`memcached_behavior_set` will flush and reset all connections.
-
-
-.. c:type:: MEMCACHED_BEHAVIOR_USE_UDP
-
-Causes :manpage:`libmemcached(3)` to use the UDP transport when communicating
-with a memcached server. Not all I/O operations are testsed
-when this behavior is enababled. The following operations will return
-:c:type:`MEMCACHED_NOT_SUPPORTED` when executed with the
-:c:type:`MEMCACHED_BEHAVIOR_USE_UDP` enabled: :c:func:`memcached_version`,
-:c:func:`memcached_stat`, :c:func:`memcached_get`,
-:c:func:`memcached_get_by_key`, :c:func:`memcached_mget`,
-:c:func:`memcached_mget_by_key`, :c:func:`memcached_fetch`,
-:c:func:`memcached_fetch_result`, :c:func:`memcached_fetch_execute`.
-
-All other operations are testsed but are executed in a 'fire-and-forget'
-mode, in which once the client has executed the operation, no attempt
-will be made to ensure the operation has been received and acted on by the
-server.
-
-:manpage:`libmemcached(3)` does not allow TCP and UDP servers to be shared
-within the same libmemached(3) client 'instance'. An attempt to add a TCP
-server when this behavior is enabled will result in a :c:type:`MEMCACHED_INVALID_HOST_PROTOCOL`, as will attempting to add a UDP server when this behavior has
-not been enabled.
-
-
-
-.. c:type:: MEMCACHED_BEHAVIOR_NO_BLOCK
-
-Causes :manpage:`libmemcached(3)` to use asychronous IO. This is the fastest
-transport available for storage functions.
-
-
-.. c:type:: MEMCACHED_BEHAVIOR_SND_TIMEOUT
-
-This sets the microsecond behavior of the socket against the SO_SNDTIMEO flag. In cases where you cannot use non-blocking IO this will allow you to still have timeouts on the sending of data.
-
-
-.. c:type:: MEMCACHED_BEHAVIOR_RCV_TIMEOUT
-
-This sets the microsecond behavior of the socket against the SO_RCVTIMEO flag.
-
-In cases where you cannot use non-blocking IO this will allow you to still have timeouts on the reading of data.
-
-
-
-.. c:type:: MEMCACHED_BEHAVIOR_TCP_NODELAY
-
-Turns on the no-delay feature for connecting sockets (may be faster in some
-environments).
-
-
-
-.. c:type:: MEMCACHED_BEHAVIOR_HASH
-
-Makes the default hashing algorithm for keys use MD5. The value can be set to either :c:type:`MEMCACHED_HASH_DEFAULT`, :c:type:`MEMCACHED_HASH_MD5`, :c:type:`MEMCACHED_HASH_CRC`, :c:type:`MEMCACHED_HASH_FNV1_64`, :c:type:`MEMCACHED_HASH_FNV1A_64`, :c:type:`MEMCACHED_HASH_FNV1_32`, :c:type:`MEMCACHED_HASH_FNV1A_32`, :c:type:`MEMCACHED_HASH_JENKINS`, :c:type:`MEMCACHED_HASH_HSIEH`, and :c:type:`MEMCACHED_HASH_MURMUR`.
-
-Each hash has it's advantages and it's weaknesses. If you don't know or don't
-care, just go with the default.
-
-Support for :c:type:`MEMCACHED_HASH_HSIEH` is a compile time option that is disabled by default. To enable tests for this hashing algorithm, configure and build libmemcached with the --enable-hash_hsieh.
-
-
-
-.. c:type:: MEMCACHED_BEHAVIOR_DISTRIBUTION
-
-Using this you can enable different means of distributing values to servers.
-
-The default method is MEMCACHED_DISTRIBUTION_MODULA. You can enable consistent hashing by setting MEMCACHED_DISTRIBUTION_CONSISTENT. Consistent hashing delivers better distribution and allows servers to be added to the cluster with minimal cache losses. Currently MEMCACHED_DISTRIBUTION_CONSISTENT is an alias for the value MEMCACHED_DISTRIBUTION_CONSISTENT_KETAMA.
-
-.. c:type:: MEMCACHED_BEHAVIOR_CACHE_LOOKUPS
-.. deprecated:: 0.46(?)
- DNS lookups are now always cached until an error occurs with the server.
-
- Memcached can cache named lookups so that DNS lookups are made only once.
-
-.. c:type:: MEMCACHED_BEHAVIOR_SUPPORT_CAS
-
-Support CAS operations (this is not enabled by default at this point in the server since it imposes a slight performance penalty).
-
-
-.. c:type:: MEMCACHED_BEHAVIOR_KETAMA
-
-Sets the default distribution to MEMCACHED_DISTRIBUTION_CONSISTENT_KETAMA and
-the hash to :c:type:`MEMCACHED_HASH_MD5`.
-
-
-.. c:type:: MEMCACHED_BEHAVIOR_KETAMA_WEIGHTED
-
- Sets the default distribution to MEMCACHED_DISTRIBUTION_CONSISTENT_KETAMA with the weighted tests. and the hash to MEMCACHED_HASH_MD5.
-
-.. c:type:: MEMCACHED_BEHAVIOR_KETAMA_HASH
-
-Sets the hashing algorithm for host mapping on continuum. The value can be set
-to either :c:type:`MEMCACHED_HASH_DEFAULT`, :c:type:`MEMCACHED_HASH_MD5`,
-:c:type:`MEMCACHED_HASH_CRC`, :c:type:`MEMCACHED_HASH_FNV1_64`,
-:c:type:`MEMCACHED_HASH_FNV1A_64`, :c:type:`MEMCACHED_HASH_FNV1_32`, and
-:c:type:`MEMCACHED_HASH_FNV1A_32`.
-
-.. c:type:: MEMCACHED_BEHAVIOR_KETAMA_COMPAT
-
-Sets the compatibility mode. The value can be set to either MEMCACHED_KETAMA_COMPAT_LIBMEMCACHED (this is the default) or MEMCACHED_KETAMA_COMPAT_SPY to be compatible with the SPY Memcached client for Java.
-
-.. c:type:: MEMCACHED_BEHAVIOR_POLL_TIMEOUT
-
-Modify the timeout value that is used by poll. The default value is -1. An signed int must be passed to memcached_behavior_set to change this value (this requires casting). For memcached_behavior_get a signed int value will be cast and returned as the unsigned long long.
-
-.. c:type:: MEMCACHED_BEHAVIOR_USER_DATA
-.. deprecated:: < 0.30
-
-.. c:type:: MEMCACHED_BEHAVIOR_BUFFER_REQUESTS
-
-Enabling buffered IO causes commands to "buffer" instead of being sent. Any action that gets data causes this buffer to be be sent to the remote connection. Quiting the connection or closing down the connection will also cause the buffered data to be pushed to the remote connection.
-
-
-.. c:type:: MEMCACHED_BEHAVIOR_VERIFY_KEY
-
-Enabling this will cause :manpage:`libmemcached(3)` to test all keys to verify that they are valid keys.
-
-
-
-.. c:type:: MEMCACHED_BEHAVIOR_SORT_HOSTS
-
-Enabling this will cause hosts that are added to be placed in the host list in sorted order. This will defeat consisten hashing.
-
-
-.. c:type:: MEMCACHED_BEHAVIOR_CONNECT_TIMEOUT
-
-In non-blocking mode this changes the value of the timeout during socket connection in milliseconds. Specifying -1 means an infinite time‐out.
-
-
-.. c:type:: MEMCACHED_BEHAVIOR_BINARY_PROTOCOL
-
-Enable the use of the binary protocol. Please note that you cannot toggle this flag on an open connection.
-
-
-
-.. c:type:: MEMCACHED_BEHAVIOR_SERVER_FAILURE_LIMIT
-
-Set this value to enable the server be removed after continuous MEMCACHED_BEHAVIOR_SERVER_FAILURE_LIMIT times connection failure.
-
-
-
-.. c:type:: MEMCACHED_BEHAVIOR_IO_MSG_WATERMARK
-
-Set this value to tune the number of messages that may be sent before libmemcached should start to automatically drain the input queue. Setting this value to high, may cause libmemcached to deadlock (trying to send data, but the send will block because the input buffer in the kernel is full).
-
-
-
-.. c:type:: MEMCACHED_BEHAVIOR_IO_BYTES_WATERMARK
-
-Set this value to tune the number of bytes that may be sent before libmemcached should start to automatically drain the input queue (need at least 10 IO requests sent without reading the input buffer). Setting this value to high, may cause libmemcached to deadlock (trying to send data, but the send will block because the input buffer in the kernel is full).
-
-
-
-.. c:type:: MEMCACHED_BEHAVIOR_IO_KEY_PREFETCH
-
-The binary protocol works a bit different than the textual protocol in that a multiget is implemented as a pipe of single get-operations which are sent to the server in a chunk. If you are using large multigets from your application, you may improve the latency of the gets by setting this value so you send out the first chunk of requests when you hit the specified limit. It allows the servers to start processing the requests to send the data back while the rest of the requests are created and sent to the server.
-
-
-
-.. c:type:: MEMCACHED_BEHAVIOR_NOREPLY
-
-Set this value to specify that you really don't care about the result from your storage commands (set, add, replace, append, prepend).
-
-
-
-.. c:type:: MEMCACHED_BEHAVIOR_NUMBER_OF_REPLICAS
-
-If you just want "a poor mans HA", you may specify the numbers of replicas libmemcached should store of each item (on different servers). This replication does not dedicate certain memcached servers to store the replicas in, but instead it will store the replicas together with all of the other objects (on the 'n' next servers specified in your server list).
-
-
-
-.. c:type:: MEMCACHED_BEHAVIOR_RANDOMIZE_REPLICA_READ
-
-Allows randomizing the replica reads starting point. Normally the read is done from primary server and in case of miss the read is done from primary + 1, then primary + 2 all the way to 'n' replicas. If this option is set on the starting point of the replica reads is randomized between the servers. This allows distributing read load to multiple servers with the expense of more write traffic.
-
-
-
-.. c:type:: MEMCACHED_BEHAVIOR_CORK
-
-This open has been deprecated with the behavior now built and used appropriately on selected platforms.
-
-
-.. c:type:: MEMCACHED_BEHAVIOR_KEEPALIVE
-
-Enable TCP_KEEPALIVE behavior.
-
-
-
-.. c:type:: MEMCACHED_BEHAVIOR_KEEPALIVE_IDLE
-
-Specify time, in seconds, to mark a connection as idle. This is only available as an option Linux.
-
-
-.. c:type:: MEMCACHED_BEHAVIOR_SOCKET_SEND_SIZE
-
-Find the current size of SO_SNDBUF. A value of 0 means either an error occured or no hosts were available. It is safe to assume system default if this occurs. If an error occurs you can checked the last cached errno statement to find the specific error.
-
-
-.. c:type:: MEMCACHED_BEHAVIOR_SOCKET_RECV_SIZE
-
-Find the current size of SO_RCVBUF. A value of 0 means either an error occured or no hosts were available. It is safe to assume system default if this occurs. If an error occurs you can checked the last cached errno statement to find the specific error.
-
-
-.. c:type:: MEMCACHED_BEHAVIOR_SERVER_FAILURE_LIMIT
-.. deprecated:: 0.48
- See :c:type:`MEMCACHED_BEHAVIOR_REMOVE_FAILED_SERVERS`
-
- This number of times a host can have an error before it is disabled.
-
-
-.. c:type:: MEMCACHED_BEHAVIOR_AUTO_EJECT_HOSTS
-.. deprecated:: 0.48
- See :c:type:`MEMCACHED_BEHAVIOR_REMOVE_FAILED_SERVERS`
-
- If enabled any hosts which have been flagged as disabled will be removed from the list of servers in the memcached_st structure. This must be used in combination with MEMCACHED_BEHAVIOR_SERVER_FAILURE_LIMIT.
-
-.. c:type:: MEMCACHED_BEHAVIOR_REMOVE_FAILED_SERVERS
-
- If enabled any hosts which have been flagged as disabled will be removed from the list of servers in the memcached_st structure.
-
-.. c:type:: MEMCACHED_BEHAVIOR_RETRY_TIMEOUT
-
-When enabled a host which is problematic will only be checked for usage based on the amount of time set by this behavior. The value is in seconds.
-
-
-.. c:type:: MEMCACHED_BEHAVIOR_HASH_WITH_PREFIX_KEY
-
-When enabled the prefix key will be added to the key when determining server
-by hash. See :c:type:`MEMCACHED_CALLBACK_NAMESPACE` for additional
-information.
-
-
-
-
-------
-RETURN
-------
-
-
-memcached_behavior_get returns either the current value of the get, or 0
-or 1 on simple flag behaviors (1 being enabled). memcached_behavior_set
-returns failure or success.
-
-
------
-NOTES
------
-
-
-memcached_behavior_set in version .17 was changed from taking a pointer
-to data value, to taking a uin64_t.
-
-
-----
-HOME
-----
-
-
-To find out more information please check:
-`http://libmemcached.org/ <http://libmemcached.org/>`_
-
-
-
---------
-SEE ALSO
---------
-
-
-:manpage:`memcached(1)` :manpage:`libmemcached(3)` :manpage:`memcached_strerror(3)`
+++ /dev/null
-=================
-Setting callbacks
-=================
-
-
-Get and set a callback
-
-.. index:: object: memcached_st
-
-
---------
-SYNOPSIS
---------
-
-#include <libmemcached/memcached.h>
-
-.. c:type:: memcached_callback_t
-
-.. c:function:: memcached_return_t memcached_callback_set (memcached_st *ptr, memcached_callback_t flag, const void *data)
-
-.. c:function:: void * memcached_callback_get (memcached_st *ptr, memcached_callback_t flag, memcached_return_t *error)
-
-Compile and link with -lmemcached
-
-
------------
-DESCRIPTION
------------
-
-
-libmemcached(3) can have callbacks set key execution points. These either
-provide function calls at points in the code, or return pointers to
-structures for particular usages.
-
-:c:func:`memcached_callback_get` takes a callback flag and returns the
-structure or function set by :c:func:`memcached_callback_set`.
-
-:c:func:`memcached_callback_set` changes the function/structure assigned by a
-callback flag. No connections are reset.
-
-You can use :c:type:`MEMCACHED_CALLBACK_USER_DATA` to provide custom context
-if required for any of the callbacks.
-
-
-.. c:type:: MEMCACHED_CALLBACK_CLEANUP_FUNCTION
-
-When :c:func:`memcached_delete` is called this function will be excuted. At
-the point of its execution all connections are closed.
-
-
-
-.. c:type:: MEMCACHED_CALLBACK_CLONE_FUNCTION
-
-When :c:func:`memcached_delete` is called this function will be excuted.
-At the point of its execution all connections are closed.
-
-.. c:type:: MEMCACHED_CALLBACK_PREFIX_KEY
-
- See :c:type:`MEMCACHED_CALLBACK_NAMESPACE`
-
-.. c:type:: MEMCACHED_CALLBACK_NAMESPACE
-
-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 :c:macro:`MEMCACHED_PREFIX_KEY_MAX_SIZE` - 1 and will
-reduce :c:macro:`MEMCACHED_MAX_KEY` by the value of your key.
-
-The prefix key is only applied to the primary key, not the master key.
-:c:type:`MEMCACHED_FAILURE` will be returned if no key is set. In the case of
-a key which is too long, :c:type:`MEMCACHED_BAD_KEY_PROVIDED` will be returned.
-
-If you set a value with the value being NULL then the prefix key is disabled.
-
-.. c:type:: MEMCACHED_CALLBACK_USER_DATA
-
-This allows you to store a pointer to a specifc piece of data. This can be
-retrieved from inside of :c:func:`memcached_fetch_execute`. Cloning a
-:c:type:`memcached_st` will copy the pointer to the clone.
-
-.. c:type:: MEMCACHED_CALLBACK_MALLOC_FUNCTION
-.. deprecated:: <0.32
- Use :c:type:`memcached_set_memory_allocators` instead.
-
-.. c:type:: MEMCACHED_CALLBACK_REALLOC_FUNCTION
-.. deprecated:: <0.32
- Use :c:type:`memcached_set_memory_allocators` instead.
-
-.. c:type:: MEMCACHED_CALLBACK_FREE_FUNCTION
-.. deprecated:: <0.32
- Use :c:type:`memcached_set_memory_allocators` instead.
-
-.. c:type:: 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 :c:type:`memcached_st` in order to
-make use of it. The value will be stored only if you return
-:c:type:`MEMCACHED_SUCCESS` or :c:type:`MEMCACHED_BUFFERED`. Returning
-:c:type:`MEMCACHED_BUFFERED` will cause the object to be buffered and not sent
-immediatly (if this is the default behavior based on your connection setup
-this will happen automatically).
-
-The prototype for this is:
-
-.. c:function:: memcached_return_t (\*memcached_trigger_key)(memcached_st \*ptr, char \*key, size_t key_length, memcached_result_st \*result);
-
-
-
-.. c:type:: 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.
-
-The prototype for this is:
-
-.. c:function:: typedef memcached_return_t (\*memcached_trigger_delete_key)(memcached_st \*ptr, char \*key, size_t key_length);
-
-
-
-
-------
-RETURN
-------
-
-
-:c:func:`memcached_callback_get` return the function or structure that was
-provided. Upon error, nothing is set, null is returned, and the
-:c:type:`memcached_return_t` argument is set to :c:type:`MEMCACHED_FAILURE`.
-
-:c:func:`memcached_callback_set` returns :c:type:`MEMCACHED_SUCCESS` upon
-successful setting, otherwise :c:type:`MEMCACHED_FAILURE` on error.
-
-
-----
-HOME
-----
-
-
-To find out more information please check:
-`http://libmemcached.org/ <http://libmemcached.org/>`_
-
-
-------
-AUTHOR
-------
-
-
-Brian Aker, <brian@tangent.org>
-
-
---------
-SEE ALSO
---------
-
-
-:manpage:`memcached(1)` :manpage:`libmemcached(3)` :manpage:`memcached_strerror(3)`
+++ /dev/null
-====================================================
-Working with data on the server in an atomic fashion
-====================================================
-
-.. index:: object: memcached_st
-
-
---------
-SYNOPSIS
---------
-
-
-#include <libmemcached/memcached.h>
-
-.. c:function:: memcached_return_t memcached_cas(memcached_st *ptr, const char *key, size_t key_length, const char *value, size_t value_length, time_t expiration, uint32_t flags, uint64_t cas)
-
-.. c:function:: memcached_return_t memcached_cas_by_key(memcached_st *ptr, const char *group_key, size_t group_key_length, const char *key, size_t key_length, const char *value, size_t value_length, time_t expiration, uint32_t flags, uint64_t cas)
-
-Compile and link with -lmemcached
-
-
------------
-DESCRIPTION
------------
-
-:c:func:`memcached_cas` overwrites data in the server as long as the "cas"
-value is still the same in the server. You can get the cas value of a result
-by calling :c:func:`memcached_result_cas` on a memcached_result_st(3)
-structure. At the point that this note was written cas is still buggy in memached. Turning on tests for it in libmemcached(3) is optional. Please see
-:c:func:`memcached_set` for information on how to do this.
-
-:c:func:`memcached_cas_by_key` method behaves in a similar method as the non
-key methods. The difference is that it uses the group_key parameter
-to map objects to particular servers.
-
-:c:func:`memcached_cas` is testsed with the :c:type:`MEMCACHED_BEHAVIOR_USE_UDP` behavior enabled. However, when using these operations with this behavior
-on, there are limits to the size of the payload being sent to the server. The
-reason for these limits is that the Memcached Server does not allow
-multi-datagram requests and the current server implementation sets a datagram
-size to 1400 bytes. Due to protocol overhead, the actual limit of the user
-supplied data is less than 1400 bytes and depends on the protocol in use as,
-well as the operation being executed. When running with the binary protocol,
-:c:type:`MEMCACHED_BEHAVIOR_BINARY_PROTOCOL`, the size of the key,value,
-flags and expiry combined may not exceed 1368 bytes. When running with the
-ASCII protocol, the exact limit fluctuates depending on which function is
-being executed and whether the function is a cas operation or not. For
-non-cas ASCII set operations, there are at least 1335 bytes available to
-split among the key, key_prefix, and value; for cas ASCII operations there
-are at least 1318 bytes available to split among the key, key_prefix and value. If the total size of the command, including overhead, exceeds 1400 bytes, a :c:type:`MEMCACHED_WRITE_FAILURE` will be returned.
-
-
-------
-RETURN
-------
-
-
-All methods return a value of type :c:type:`memcached_return_t`.
-On success the value will be :c:type:`MEMCACHED_SUCCESS`.
-Use :c:func:`memcached_strerror` to translate this value to a printable
-string.
-
-
-----
-HOME
-----
-
-
-To find out more information please check:
-`http://libmemcached.org/ <http://libmemcached.org/>`_
-
-
---------
-SEE ALSO
---------
-
-
-:manpage:`memcached(1)` :manpage:`libmemached(3)` :manpage:`memcached_strerror(3)` :manpage:`memcached_set(3)` :manpage:`memcached_append(3)` :manpage:`memcached_add(3)` :manpage:`memcached_prepend(3)` :manpage:`memcached_replace(3)`
-
+++ /dev/null
-======================================
-Creating and destroying a memcached_st
-======================================
-
---------
-SYNOPSIS
---------
-
-#include <libmemcached/memcached.h>
-
-.. c:type:: memcached_st
-
-.. c:function:: memcached_st* memcached_create(memcached_st *ptr)
-
-.. c:function:: void memcached_free(memcached_st *ptr)
-
-.. c:function:: memcached_st* memcached_clone(memcached_st *destination, memcached_st *source)
-
-.. c:function:: void memcached_servers_reset(memcached_st)
-
-Compile and link with -lmemcached
-
-
------------
-DESCRIPTION
------------
-
-:c:func:`memcached_create` is used to create a :c:type:`memcached_st`
-structure that will then be used by other libmemcached(3) functions to
-communicate with the server. You should either pass a statically declared
-:c:type:`memcached_st` to :c:func:`memcached_create` or
-a NULL. If a NULL passed in then a structure is allocated for you.
-
-Please note, when you write new application use
-:c:func:`memcached` over :c:func:`memcached_create`.
-
-:c:func:`memcached_clone` is similar to :c:func:`memcached_create` but
-it copies the defaults and list of servers from the source
-:c:type:`memcached_st`. If you pass a null as the argument for the source
-to clone, it is the same as a call to :c:func:`memcached_create`.
-If the destination argument is NULL a :c:type:`memcached_st` will be allocated
-for you.
-
-:c:func:`memcached_servers_reset` allows you to zero out the list of
-servers that the :c:type:`memcached_st` has.
-
-To clean up memory associated with a :c:type:`memcached_st` structure you
-should pass it to :c:func:`memcached_free` when you are finished using it.
-:c:func:`memcached_free` is the only way to make sure all memory is
-deallocated when you finish using the structure.
-
-You may wish to avoid using memcached_create(3) or memcached_clone(3) with a
-stack based allocation. The most common issues related to ABI safety involve
-heap allocated structures.
-
-
-------
-RETURN
-------
-
-
-:c:func:`memcached_create` returns a pointer to the :c:type:`memcached_st`
-that was created (or initialized). On an allocation failure, it returns NULL.
-
-:c:func:`memcached_clone` returns a pointer to the :c:type:`memcached_st`
-that was created (or initialized). On an allocation failure, it returns NULL.
-
-
-----
-HOME
-----
-
-
-To find out more information please check:
-`http://libmemcached.org/ <http://libmemcached.org/>`_
-
-
---------
-SEE ALSO
---------
-
-
-:manpage:`memcached(1)` :manpage:`libmemcached(3)` :manpage:`memcached_strerror(3)`
+++ /dev/null
-===========================
-Deleting data from a server
-===========================
-
-.. index:: object: memcached_st
-
---------
-SYNOPSIS
---------
-
-
-#include <libmemcached/memcached.h>
-
-.. c:function:: memcached_return_t memcached_delete (memcached_st *ptr, const char *key, size_t key_length, time_t expiration)
-
-.. c:function:: memcached_return_t memcached_delete_by_key (memcached_st *ptr, const char *group_key, size_t group_key_length, const char *key, size_t key_length, time_t expiration)
-
-Compile and link with -lmemcached
-
------------
-DESCRIPTION
------------
-
-
-:c:func:`memcached_delete` is used to delete a particular key.
-:c:func:`memcached_delete_by_key` works the same, but it takes a master key
-to find the given value.
-
-Expiration works by placing the item into a delete queue, which means that
-it won't be possible to retrieve it by the "get" command. The "add" and
-"replace" commands with this key will also fail (the "set" command will
-succeed, however). After the time passes, the item is finally deleted from server memory.
-
-Please note the the Danga memcached server removed tests for expiration in
-the 1.4 version.
-
-
-------
-RETURN
-------
-
-
-A value of type :c:type:`memcached_return_t` is returned
-On success that value will be :c:type:`MEMCACHED_SUCCESS`.
-Use :c:func:`memcached_strerror` to translate this value to a printable
-string.
-
-If you are using the non-blocking mode of the library, success only
-means that the message was queued for delivery.
-
-
-----
-HOME
-----
-
-
-To find out more information please check:
-`http://libmemcached.org/ <http://libmemcached.org/>`_
-
-
-------
-AUTHOR
-------
-
-
-Brian Aker, <brian@tangent.org>
-
-
---------
-SEE ALSO
---------
-
-:manpage:`memcached(1)` :manpage:`libmemcached(3)` :manpage:`memcached_strerror(3)`
+++ /dev/null
-==========================
-Dumping data from a server
-==========================
-
-
-Get a list of keys found on memcached servers
-
-.. index:: object: memcached_st
-
-
---------
-SYNOPSIS
---------
-
-
-#include <libmemcached/memcached.h>
-
-.. c:function:: memcached_return_t memcached_dump (memcached_st *ptr, memcached_dump_fn *function, void *context, uint32_t number_of_callbacks)
-
-.. c:type:: memcached_return_t (*memcached_dump_fn)(memcached_st *ptr, const char *key, size_t key_length, void *context)
-
-Compile and link with -lmemcached
-
-
-
------------
-DESCRIPTION
------------
-
-
-:c:func:`memcached_dump` is used to get a list of keys found in memcached(1)
-servers. Because memcached(1) does not guarentee to dump all keys you can not
-assume you have fetched all keys from the server. The function takes an array
-of callbacks that it will use to execute on keys as they are found.
-
-Currently the binary protocol is not testsed.
-
-
-------
-RETURN
-------
-
-
-A value of type :c:type:`memcached_return_t` is returned
-On success that value will be :c:type:`MEMCACHED_SUCCESS`.
-Use :c:func:`memcached_strerror` to translate this value to a printable
-string.
-
-
-----
-HOME
-----
-
-
-To find out more information please check:
-`http://libmemcached.org/ <http://libmemcached.org/>`_
-
-
-------
-AUTHOR
-------
-
-
-Brian Aker, <brian@tangent.org>
-
-
---------
-SEE ALSO
---------
-
-
-:manpage:`memcached(1)` :manpage:`libmemcached(3)` :manpage:`memcached_strerror(3)`
+++ /dev/null
-=====================================
-Wiping clean the contents of a server
-=====================================
-
-.. index:: object: memcached_st
-
-Wipe contents of memcached servers
-
-
---------
-SYNOPSIS
---------
-
-
-#include <libmemcached/memcached.h>
-
-.. c:function:: memcached_return_t memcached_flush (memcached_st *ptr, time_t expiration)
-
-Compile and link with -lmemcached
-
-
------------
-DESCRIPTION
------------
-
-
-:c:func::`memcached_flush` is used to wipe clean the contents of :program:`memcached` servers.
-It will either do this immediately or expire the content based on the
-expiration time passed to the method (a value of zero causes an immediate
-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.
-
-
-------
-RETURN
-------
-
-
-A value of type :c:type:`memcached_return_t` is returned
-On success that value will be :c:type:`MEMCACHED_SUCCESS`.
-Use :c:type:`memcached_strerror` to translate this value to a printable string.
-
-----
-HOME
-----
-
-
-To find out more information please check:
-`http://libmemcached.org/ <http://libmemcached.org/>`_
-
-
-------
-AUTHOR
-------
-
-
-Brian Aker, <brian@tangent.org>
-
-
---------
-SEE ALSO
---------
-
-:manpage:`memcached(1)` :manpage:`libmemcached(3)` :manpage:`memcached_strerror(3)`
+++ /dev/null
-=======================
-Flushing client buffers
-=======================
-
-
-.. index:: object: memcached_st
-
-Flush and senf buffered commands
-
---------
-SYNOPSIS
---------
-
-#include <libmemcached/memcached.h>
-
-.. c:function:: memcached_return_t memcached_flush_buffers (memcached_st *ptr)
-
-Compile and link with -lmemcached
-
-
------------
-DESCRIPTION
------------
-
-
-:c:func:`memcached_flush_buffers` is used in conjunction with
-:c:type:`MEMCACHED_BEHAVIOR_BUFFER_REQUESTS` (see memcached_behavior(3)) to flush all buffers by sending the buffered commands to the server for processing.
-
-
-------
-RETURN
-------
-
-
-A value of type :c:type:`memcached_return_t` is returned
-On success that value will be :c:type:`MEMCACHED_SUCCESS`.
-Use :c:func:`memcached_strerror` to translate this value to a printable
-string.
-
-
-----
-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>
-
-
---------
-SEE ALSO
---------
-
-
-:manpage:`memcached(1)` :manpage:`libmemcached(3)` :manpage:`memcached_strerror(3)`
+++ /dev/null
-===============================
-Generating hash values directly
-===============================
-
-.. index:: object: memcached_st
-
-Hash a key value
-
-
---------
-SYNOPSIS
---------
-
-
-#include <libmemcached/memcached.h>
-
-.. c:type:: memcached_hash_t
-
-.. c:function:: uint32_t memcached_generate_hash_value (const char *key, size_t key_length, memcached_hash_t hash_algorithm)
-
-.. c:function:: uint32_t memcached_generate_hash (memcached_st *ptr, const char *key, size_t key_length)
-
-.. c:type:: MEMCACHED_HASH_DEFAULT
-
-.. c:type:: MEMCACHED_HASH_MD5
-
-.. c:type:: MEMCACHED_HASH_CRC
-
-.. c:type:: MEMCACHED_HASH_FNV1_64
-
-.. c:type:: MEMCACHED_HASH_FNV1A_64
-
-.. c:type:: MEMCACHED_HASH_FNV1_32
-
-.. c:type:: MEMCACHED_HASH_FNV1A_32
-
-.. c:type:: MEMCACHED_HASH_JENKINS
-
-.. c:type:: MEMCACHED_HASH_MURMUR
-
-.. c:type:: MEMCACHED_HASH_HSIEH
-
-.. c:type:: MEMCACHED_HASH_MURMUR3
-
-
-Compile and link with -lmemcachedutil -lmemcached
-
-
------------
-DESCRIPTION
------------
-
-
-:c:func:`memcached_generate_hash_value` allows you to hash a key using one of
-the hash functions defined in the library. This method is provided for
-the convenience of higher-level language bindings and is not necessary
-for normal memcache operations.
-
-The allowed hash algorithm constants are listed in the manpage for
-:c:func:`memcached_behavior_set`.
-
-:c:func:`memcached_generate_hash` takes a :c:type:`memcached_st` struture
-and produces the hash value that would have been generated based on the
-defaults of :c:type:`memcached_st`.
-
-As of version 0.36 all hash methods have been placed into the library
-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.
-For 64-bit hash algorithms, only the least-significant 32 bits are
-returned.
-
-
-----
-HOME
-----
-
-
-To find out more information please check:
-`http://libmemcached.org/ <http://libmemcached.org/>`_
-
-
-------
-AUTHOR
-------
-
-
-Brian Aker, <brian@tangent.org>
-
-
---------
-SEE ALSO
---------
-
-
-:manpage:`memcached(1)` :manpage:`libmemcached(3)` :manpage:`memcached_strerror(3)`
+++ /dev/null
-===============================
-Retrieving data from the server
-===============================
-
-.. index:: object: memcached_st
-
---------
-SYNOPSIS
---------
-
-
-#include <libmemcached/memcached.h>
-
-.. c:function:: memcached_result_st * memcached_fetch_result (memcached_st *ptr, memcached_result_st *result, memcached_return_t *error)
-
-.. c:function:: char * memcached_get (memcached_st *ptr, const char *key, size_t key_length, size_t *value_length, uint32_t *flags, memcached_return_t *error)
-
-.. c:function:: memcached_return_t memcached_mget (memcached_st *ptr, const char * const *keys, const size_t *key_length, size_t number_of_keys)
-
-.. c:function:: char * memcached_get_by_key (memcached_st *ptr, const char *group_key, size_t group_key_length, const char *key, size_t key_length, size_t *value_length, uint32_t *flags, memcached_return_t *error)
-
-.. c:function:: memcached_return_t memcached_mget_by_key (memcached_st *ptr, const char *group_key, size_t group_key_length, const char * const *keys, const size_t *key_length, size_t number_of_keys)
-
-.. c:function:: memcached_return_t memcached_fetch_execute (memcached_st *ptr, memcached_execute_fn *callback, void *context, uint32_t number_of_callbacks)
-
-.. c:function:: memcached_return_t memcached_mget_execute (memcached_st *ptr, const char * const *keys, const size_t *key_length, size_t number_of_keys, memcached_execute_fn *callback, void *context, uint32_t number_of_callbacks)
-
-.. c:function:: memcached_return_t memcached_mget_execute_by_key (memcached_st *ptr, const char *group_key, size_t group_key_length, const char * const *keys, const size_t *key_length, size_t number_of_keys, memcached_execute_fn *callback, void *context, uint32_t number_of_callbacks)
-
-.. c:type:: memcached_return_t (*memcached_execute_fn)(const memcached_st *ptr, memcached_result_st *result, void *context)
-
-Compile and link with -lmemcached
-
-
------------
-DESCRIPTION
------------
-
-
-:c:func:`memcached_get` is used to fetch an individual value from the server.
-You must pass in a key and its length to fetch the object. You must supply
-three pointer variables which will give you the state of the returned
-object. A :c:type:`uint32_t` pointer to contain whatever flags you stored with the value, a :c:type:`size_t` pointer which will be filled with size of of
-the object, and a :c:type:`memcached_return_t` pointer to hold any error. The
-object will be returned upon success and NULL will be returned on failure. Any
-object returned by :c:func:`memcached_get` must be released by the caller
-application.
-
-:c:func:`memcached_mget` is used to select multiple keys at once. For
-multiple key operations it is always faster to use this function. This function always works asynchronously.
-
-To retrieve data after a successful execution of :c:func:`memcached_mget`, you will need to
-call :c:func:`memcached_fetch_result`. You should continue to call this function until
-it returns a NULL (i.e. no more values). If you need to quit in the middle of a
-:c:func:`memcached_mget` call, you can execute a :c:func:`memcached_quit`, those this is not required.
-
-:c:func:`memcached_fetch_result` is used to fetch an individual value from the server. :c:func:`memcached_mget` must always be called before using this method.
-You must pass in a key and its length to fetch the object. You must supply
-three pointer variables which will give you the state of the returned
-object. A :c:type:`uint32_t` pointer to contain whatever flags you stored with the value, a :c:type:`size_t` pointer which will be filled with size of of the
-object, and a :c:type:`memcached_return_t` pointer to hold any error. The
-object will be returned upon success and NULL will be returned on failure. :c:type:`MEMCACHED_END` is returned by the \*error value when all objects that have been found are returned. The final value upon :c:type:`MEMCACHED_END` is null.
-
-:c:func:`memcached_fetch_result` is used to return a :c:type:`memcached_result_st` structure from a memcached server. The result object is forward compatible
-with changes to the server. For more information please refer to the
-:c:type:`memcached_result_st` help. This function will dynamically allocate a
-result structure for you if you do not pass one to the function.
-
-:c:func:`memcached_fetch_execute` is a callback function for result sets.
-Instead of returning the results to you for processing, it passes each of the
-result sets to the list of functions you provide. It passes to the function
-a :c:type:`memcached_st` that can be cloned for use in the called
-function (it can not be used directly). It also passes a result set which does
-not need to be freed. Finally it passes a "context". This is just a pointer to
-a memory reference you supply the calling function. Currently only one value
-is being passed to each function call. In the future there will be an option
-to allow this to be an array.
-
-:c:func:`memcached_mget_execute` and :c:func:`memcached_mget_execute_by_key`
-is similar to :c:func:`memcached_mget`, but it may trigger the supplied
-callbacks with result sets while sending out the queries. If you try to
-perform a really large multiget with :c:func:`memcached_mget` you may
-encounter a deadlock in the OS kernel (it will fail to write data to the
-socket because the input buffer is full). :c:func:`memcached_mget_execute`
-solves this problem by processing some of the results before continuing
-sending out requests. Please note that this function is only available in
-the binary protocol.
-
-:c:func:`memcached_get_by_key` and :c:func:`memcached_mget_by_key` behave
-in a similar nature as :c:func:`memcached_get` and :c:func:`memcached_mget`.
-The difference is that they take a master key that is used for determining
-which server an object was stored if key partitioning was used for storage.
-
-All of the above functions are not tested when the
-:c:type:`MEMCACHED_BEHAVIOR_USE_UDP` has been set. Executing any of these
-functions with this behavior on will result in :c:type:`MEMCACHED_NOT_SUPPORTED` being returned, or for those functions which do not return a :c:type:`memcached_return_t`, the error function parameter will be set to :c:type:`MEMCACHED_NOT_SUPPORTED`.
-
-
-------
-RETURN
-------
-
-
-All objects retrieved via :c:func:`memcached_get` or :c:func:`memcached_get_by_key` must be freed with :manpage:`free(3)`.
-
-:c:func:`memcached_get` will return NULL on
-error. You must look at the value of error to determine what the actual error
-was.
-
-:c:func:`memcached_fetch_execute` return :c:type:`MEMCACHED_SUCCESS` if
-all keys were successful. :c:type:`MEMCACHED_NOTFOUND` will be return if no
-keys at all were found.
-
-:c:func:`memcached_fetch_result` sets error
-to :c:type:`MEMCACHED_END` upon successful conclusion.
-:c:type:`MEMCACHED_NOTFOUND` will be return if no keys at all were found.
-
-----
-HOME
-----
-
-
-To find out more information please check:
-`http://libmemcached.org/ <http://libmemcached.org/>`_
-
-
---------
-SEE ALSO
---------
-
-:manpage:`memcached(1)` :manpage:`libmemcached(3)` :manpage:`memcached_strerror(3)`
+++ /dev/null
-========================================
-Use custom allocators for embedded usage
-========================================
-
-.. index:: object: memcached_st
-
-Manage memory allocator functions
-
---------
-SYNOPSIS
---------
-
-
-#include <libmemcached/memcached.h>
-
-.. c:function:: memcached_return_t memcached_set_memory_allocators (memcached_st *ptr, memcached_malloc_fn mem_malloc, memcached_free_fn mem_free, memcached_realloc_fn mem_realloc, memcached_calloc_fn mem_calloc, void *context)
-
-.. c:function:: void memcached_get_memory_allocators (memcached_st *ptr, memcached_malloc_fn *mem_malloc, memcached_free_fn *mem_free, memcached_realloc_fn *mem_realloc, memcached_calloc_fn *mem_calloc)
-
-.. c:function:: void * memcached_get_memory_allocators_context(const memcached_st *ptr)
-
-.. c:function:: void * (*memcached_malloc_fn) (memcached_st *ptr, const size_t size, void *context)
-
-.. c:function:: void * (*memcached_realloc_fn) (memcached_st *ptr, void *mem, const size_t size, void *context)
-
-.. c:function:: void (*memcached_free_fn) (memcached_st *ptr, void *mem, void *context)
-
-.. c:function:: void * (*memcached_calloc_fn) (memcached_st *ptr, size_t nelem, const size_t elsize, void *context)
-
-Compile and link with -lmemcached
-
-
-
------------
-DESCRIPTION
------------
-
-
-libmemcached(3) allows you to specify your own memory allocators, optimized
-for your application. This enables libmemcached to be used inside of applications that have their own malloc implementation.
-
-:c:func:`memcached_set_memory_allocators` is used to set the memory
-allocators used by the memcached instance specified by ptr. Please note that
-you cannot override only one of the memory allocators, you have to specify a
-complete new set if you want to override one of them. All of the memory
-allocation functions should behave as specified in the C99 standard. Specify
-NULL as all functions to reset them to the default values.
-
-:c:func:`memcached_get_memory_allocators` is used to get the currently used
-memory allocators by a mamcached handle.
-
-:c:func:`memcached_get_memory_allocators_context` returns the void \* that
-was passed in during the call to :c:func:`memcached_set_memory_allocators`.
-
-The first argument to the memory allocator functions is a pointer to a
-memcached structure, the is passed as const and you will need to clone
-it in order to make use of any operation which would modify it.
-
-
------
-NOTES
------
-
-
-In version 0.38 all functions were modified to have a context void pointer
-passed to them. This was so that customer allocators could have their
-own space for memory.
-
-
-------
-RETURN
-------
-
-
-:c:func:`memcached_set_memory_allocators` return :c:type:`MEMCACHED_SUCCESS`
-upon success, and :c:type:`MEMCACHED_FAILURE` if you don't pass a complete set
-of function pointers.
-
-
-----
-HOME
-----
-
-
-To find out more information please check:
-`http://libmemcached.org/ <http://libmemcached.org/>`_
-
-
---------
-SEE ALSO
---------
-
-:manpage:`memcached(1)` :manpage:`libmemcached(3)` :manpage:`memcached_strerror(3)`
+++ /dev/null
-============================
-Working with memcached pools
-============================
-
---------
-SYNOPSIS
---------
-
-#include <libmemcached/memcached_pool.h>
-
-.. c:type:: memcached_pool_st
-
-.. c:function:: memcached_pool_st* memcached_pool(const char *option_string, size_t option_string_length)
-
-.. c:function:: memcached_pool_st* memcached_pool_create(memcached_st* mmc, int initial, int max)
-.. deprecated:: 0.46
- Use :c:func:`memcached_pool`
-
-.. c:function:: 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)
-.. deprecated:: 0.53
- Use :c:func:`memcached_pool_fetch`
-
-.. c:function:: memcached_st* memcached_pool_fetch(memcached_pool_st*, struct timespec* relative_time, memcached_return_t* rc)
-
-.. versionadded:: 0.53
- Synonym for memcached_pool_pop
-
-.. c:function:: memcached_return_t memcached_pool_push(memcached_pool_st* pool, memcached_st *mmc)
-.. deprecated:: 0.53
- Use :c:func:`memcached_pool_push`
-
-.. c:function:: memcached_return_t memcached_pool_release(memcached_pool_st* pool, memcached_st* mmc)
-.. versionadded:: 0.53
- Synonym for memcached_pool_push.
-
-.. c:function:: memcached_return_t memcached_pool_behavior_set(memcached_pool_st *pool, memcached_behavior_t flag, uint64_t data)
-
-.. 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
-
------------
-DESCRIPTION
------------
-
-
-:c:func:`memcached_pool` is used to create a connection pool of objects you
-may use to remove the overhead of using memcached_clone for short lived
-:c:type:`memcached_st` objects. Please see :doc:`libmemcached_configuration` for details on the format of the configuration string.
-
-:c:func:`memcached_pool_destroy` is used to destroy the connection pool
-created with :c:func:`memcached_pool_create` and release all allocated
-resources. It will return the pointer to the :c:type:`memcached_st` structure
-passed as an argument to :c:func:`memcached_pool_create`, and returns the ownership of the pointer to the caller when created with :c:func:`memcached_pool_create`, otherwise NULL is returned..
-
-:c:func:`memcached_pool_fetch` is used to fetch a connection structure from the
-connection pool. The relative_time argument specifies if the function should
-block and wait for a connection structure to be available if we try
-to exceed the maximum size. You need to specify time in relative time.
-
-:c:func:`memcached_pool_release` is used to return a connection structure back to the pool.
-
-:c:func:`memcached_pool_behavior_get` and :c:func:`memcached_pool_behavior_set` is used to get/set behavior flags on all connections in the pool.
-
-Both :c:func:`memcached_pool_release` and :c:func:`memcached_pool_fetch` are thread safe.
-
-------
-RETURN
-------
-
-:c:func:`memcached_pool_destroy` returns the pointer (and ownership) to the :c:type:`memcached_st` structure used to create the pool. If connections are in use it returns NULL.
-
-:c:func:`memcached_pool_pop` returns a pointer to a :c:type:`memcached_st` structure from the pool (or NULL if an allocation cannot be satisfied).
-
-:c:func:`memcached_pool_release` returns :c:type:`MEMCACHED_SUCCESS` upon success.
-
-:c:func:`memcached_pool_behavior_get` and :c:func:`memcached_pool_behavior_get` returns :c:type:`MEMCACHED_SUCCESS` upon success.
-
-If any methods returns MEMCACHED_IN_PROGRESS then a lock on the pool could not be obtained. If any of the parameters passed to any of these functions is invalid, MEMCACHED_INVALID_ARGUMENTS will be returned.
-
-memcached_pool_fetch may return MEMCACHED_TIMEOUT if a timeout occurs while waiting for a free memcached_st. MEMCACHED_NOTFOUND if no memcached_st was available.
-
-
-----
-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>
-
-
---------
-SEE ALSO
---------
-
-:manpage:`memcached(1)` :manpage:`libmemcached(3)` :manpage:`memcached_strerror(3)` :manpage:`libmemcached_configuration(3)`
+++ /dev/null
-====================================
-Disconnecting a client from a server
-====================================
-
-.. index:: object: memcached_st
-
---------
-SYNOPSIS
---------
-
-#include <libmemcached/memcached.h>
-
-.. c:function:: void memcached_quit (memcached_st *ptr)
-
-Compile and link with -lmemcached
-
------------
-DESCRIPTION
------------
-
-
-:c:func:`memcached_quit` will disconnect you from all currently connected
-servers. It will also reset the state of the connection (ie, any :c:func:`memcached_fetch` you are in the middle of will be terminated). This function is
-called automatically when you call :c:func:`memcached_free` on the :c:type:`memcached_st` structure.
-
-You do not need to call this on your own. All operations to change server
-hashes and parameters will handle connections to the server for you. This
-function is provided mainly so that you can timeout your connections or
-reset connections during the middle of a :c:func:`memcached_fetch`.
-
-
-------
-RETURN
-------
-
-
-A value of type :c:type:`memcached_return_t` is returned On success that value
-will be :c:type:`MEMCACHED_SUCCESS`. Use :c:func:`memcached_strerror` to
-translate this value to a printable string.
-
-
-----
-HOME
-----
-
-
-To find out more information please check:
-`http://libmemcached.org/ <http://libmemcached.org/>`_
-
-
-------
-AUTHOR
-------
-
-
-Brian Aker, <brian@tangent.org>
-
-
---------
-SEE ALSO
---------
-
-:manpage:`memcached(1)` :manpage:`libmemcached(3)` :manpage:`memcached_strerror(3)`
+++ /dev/null
-========================
-Working with result sets
-========================
-
---------
-SYNOPSIS
---------
-
-#include <libmemcached/memcached_pool.h>
-
-.. c:type:: memcached_result_st
-
-.. c:function:: memcached_result_st * memcached_result_create (memcached_st *ptr, memcached_result_st *result)
-
-.. c:function:: void memcached_result_free (memcached_result_st *result)
-
-.. c:function:: const char * memcached_result_key_value (memcached_result_st *result)
-
-.. c:function:: size_t memcached_result_key_length (const memcached_result_st *result)
-
-.. c:function:: const char *memcached_result_value (memcached_result_st *ptr)
-
-.. c:function:: char *memcached_result_take_value (memcached_result_st *ptr)
-
-.. c:function:: size_t memcached_result_length (const memcached_result_st *ptr)
-
-.. c:function:: uint32_t memcached_result_flags (const memcached_result_st *result)
-
-.. c:function:: uint64_t memcached_result_cas (const memcached_result_st *result)
-
-.. c:function:: memcached_return_t memcached_result_set_value (memcached_result_st *ptr, const char *value, size_t length)
-
-.. c:function:: void memcached_result_set_flags (memcached_result_st *ptr, uint32_t flags)
-
-.. c:function:: void memcached_result_set_expiration (memcached_result_st *ptr, time_t)
-
-Compile and link with -lmemcachedutil -lmemcached
-
-
-
------------
-DESCRIPTION
------------
-
-
-libmemcached(3) can optionally return a :c:type:`memcached_result_st` which
-acts as a result object. The result objects have added benefits over the
-character pointer returns, in that they are forward compatible with new
-return items that future memcached servers may implement (the best current
-example of this is the CAS return item). The structures can also be reused,
-which will save on calls to malloc(3). It is suggested that you use result
-objects over char \* return functions.
-
-The structure of :c:type:`memcached_result_st` has been encapsulated, you should
-not write code to directly access members of the structure.
-
-:c:func:`memcached_result_create` will either allocate memory for a
-:c:type:`memcached_result_st` or will initialize a structure passed to it.
-
-:c:func:`memcached_result_free` will deallocate any memory attached to the
-structure. If the structure was also allocated, it will deallocate it.
-
-:c:func:`memcached_result_key_value` returns the key value associated with the
-current result object.
-
-:c:func:`memcached_result_key_length` returns the key length associated with
-the current result object.
-
-:c:func:`memcached_result_value` returns the result value associated with the
-current result object.
-
-:c:func:`memcached_result_take_value` returns and hands over the result value
-associated with the current result object. You must call free() to release this
-value, unless you have made use of a custom allocator. Use of a custom
-allocator requires that you create your own custom free() to release it.
-
-:c:func:`memcached_result_length` returns the result length associated with
-the current result object.
-
-:c:func:`memcached_result_flags` returns the flags associated with the
-current result object.
-
-:c:func:`memcached_result_cas` returns the cas associated with the
-current result object. This value will only be available if the server
-tests it.
-
-:c:func:`memcached_result_set_value` takes a byte array and a size and sets
-the result to this value. This function is used for trigger responses.
-
-:c:func:`memcached_result_set_flags` takes a result structure and stores a new
-value for the flags field.
-
-:c:func:`memcached_result_set_expiration` takes a result structure and stores
-a new value for the expiration field (this is only used by read through
-triggers).
-
-You may wish to avoid using memcached_result_create(3) with a
-stack based allocation. The most common issues related to ABI safety involve
-heap allocated structures.
-
-
-------
-RETURN
-------
-
-
-Varies, see particular functions. All structures must have
-:c:func:`memcached_result_free` called on them for cleanup purposes. Failure
-to do this will result in leaked memory.
-
-
-----
-HOME
-----
-
-
-To find out more information please check:
-`http://libmemcached.org/ <http://libmemcached.org/>`_
-
-
---------
-SEE ALSO
---------
-
-:manpage:`memcached(1)` :manpage:`libmemcached(3)` :manpage:`memcached_strerror(3)`
+++ /dev/null
-============
-SASL support
-============
-
-.. index:: object: memcached_st
-
-
---------
-SYNOPSIS
---------
-
-#include <libmemcached/memcached_pool.h>
-
-.. c:function:: void memcached_set_sasl_callbacks(memcached_st *ptr, const sasl_callback_t *callbacks)
-
-.. c:function:: const sasl_callback_t *memcached_get_sasl_callbacks(memcached_st *ptr)
-
-.. c:function:: memcached_return_t memcached_set_sasl_auth_data(memcached_st *ptr, const char *username, const char *password)
-
-.. c:function:: memcached_return_t memcached_destroy_sasl_auth_data(memcached_st *ptr)
-
-Compile and link with -lmemcached
-
-
-
------------
-DESCRIPTION
------------
-
-
-libmemcached(3) allows you to plug in your own callbacks function used by
-libsasl to perform SASL authentication.
-
-Please note that SASL requires the memcached binary protocol, and you have
-to specify the callbacks before you connect to the server.
-
-:c:func:`memcached_set_sasl_auth_data` is a helper function defining
-the basic functionality for you, but it will store the username and password
-in memory. If you choose to use this method you have to call
-:c:type:`memcached_destroy_sasl_auth_data` before calling
-:c:type:`memcached_free` to avoid a memory leak. You should NOT call
-:c:type:`memcached_destroy_sasl_auth_data` if you specify your own callback
-function with :c:func:`memcached_set_sasl_callbacks`.
-
-
-------
-RETURN
-------
-
-
-:c:func:`memcached_get_sasl_callbacks` returns the callbacks currently used by
-this memcached handle. :c:func:`memcached_set_sasl_auth_data` returns
-:c:type:`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>
-
-
---------
-SEE ALSO
---------
-
-
-:manpage:`memcached(1)` :manpage:`libmemcached(3)` :manpage:`memcached_strerror(3)`
+++ /dev/null
-=========================
-Managing lists of servers
-=========================
-
-
---------
-SYNOPSIS
---------
-
-
-
-#include <libmemcached/memcached.h>
-
-.. c:type:: const memcached_instance_st *
-
-.. c:type:: memcached_server_list_st
-
-.. c:type:: memcached_server_st
-
-.. c:function:: const const memcached_instance_st * memcached_server_list (memcached_st *ptr)
-
-.. c:function:: void memcached_server_list_free (memcached_server_list_st list)
-
-.. c:function:: memcached_server_list_st memcached_server_list_append (memcached_server_list_st list, const char *hostname, in_port_t port, memcached_return_t *error)
-
-.. c:function:: uint32_t memcached_server_list_count (memcached_server_list_st list)
-
-.. c:function:: const char *memcached_server_error (const memcached_instance_st * instance)
-
-.. c:function:: void memcached_server_error_reset (const memcached_instance_st * list)
-.. deprecated:: 0.39
-
-.. c:function:: void memcached_servers_parse ()
-.. deprecated:: 0.39
-
-Compile and link with -lmemcached
-
-
------------
-DESCRIPTION
------------
-
-
-libmemcached(3) operates on a list of hosts which are stored in
-:c:type:`memcached_server_st` structures. You should not modify these structures
-directly. Functions are provided to modify these structures (and more can be
-added, just ask!).
-
-:c:func:`memcached_server_list` is used to provide an array of all defined hosts. This was incorrectly documented as "requiring free" up till version 0.39.
-
-:c:func:`memcached_server_list_free` deallocates all memory associated with the array of :c:type:`memcached_server_st` that you passed to it.
-
-:c:func:`memcached_server_list_append` adds a server to the end of a
-:c:type:`memcached_server_st` array. On error null will be returned and the
-:c:type:`memcached_return_t` pointer you passed into the function will be set with the appropriate error. If the value of port is zero, it is set to the default
-port of a memcached server.
-
-DEPRECATED :c:func:`memcached_servers_parse`, please see :c:func:`memcached`
-
-:c:func:`memcached_server_error` can be used to look at the text of the last error message sent by the server to to the client.
-
-Before version 0.39 theses functions used a memcache_server_st \*. In 0.39
-memcached_server_st \* was aliased to :c:type:`memcached_server_list_st`. This was done for a style reason to help clean up some concepts in the code.
-
-
-------
-RETURN
-------
-
-
-Varies, see particular functions.
-
-
-----
-HOME
-----
-
-
-To find out more information please check:
-`http://libmemcached.org/ <http://libmemcached.org/>`_
-
-
-
---------
-SEE ALSO
---------
-
-
-:manpage:`memcached(1)` :manpage:`libmemcached(3)` :manpage:`memcached_strerror(3)`
+++ /dev/null
-========================================================
-Manipulate the server information stored in memcached_st
-========================================================
-
---------
-SYNOPSIS
---------
-
-#include <libmemcached/memcached.h>
-
-.. c:type:: memcached_server_fn
-
-.. c:function:: uint32_t memcached_server_count (memcached_st *ptr)
-
-.. c:function:: memcached_return_t memcached_server_add (memcached_st *ptr, const char *hostname, in_port_t port)
-
-.. c:function:: memcached_return_t memcached_server_add_udp (memcached_st *ptr, const char *hostname, in_port_t port)
-
-.. c:function:: memcached_return_t memcached_server_add_unix_socket (memcached_st *ptr, const char *socket)
-
-.. c:function:: memcached_return_t memcached_server_push (memcached_st *ptr, const memcached_server_st *list)
-
-.. c:function:: const memcached_instance_st * memcached_server_by_key (memcached_st *ptr, const char *key, size_t key_length, memcached_return_t *error)
-
-.. c:function:: const memcached_instance_st * memcached_server_get_last_disconnect (const memcached_st *ptr)
-
-.. c:function:: memcached_return_t memcached_server_cursor(const memcached_st *ptr, const memcached_server_fn *callback, void *context, uint32_t number_of_callbacks)
-
-compile and link with -lmemcached
-
-
-
------------
-DESCRIPTION
------------
-
-
-:doc:`libmemcached` performs operations on a list of hosts. The order of
-these hosts determine routing to keys. Functions are provided to add keys to
-memcached_st structures. To manipulate lists of servers see
-memcached_server_st(3).
-
-:c:func:`memcached_server_count` provides you a count of the current number of
-servers being used by a :c:type:`memcached_st` structure.
-
-:c:func:`memcached_server_add` pushes a single TCP server into the :c:type:`memcached_st` structure. This server will be placed at the end. Duplicate servers
- are allowed, so duplication is not checked. Executing this function with the :c:type:`MEMCACHED_BEHAVIOR_USE_UDP` behavior set will result in a :c:type:`MEMCACHED_INVALID_HOST_PROTOCOL`.
-
-:c:func:`memcached_server_add_udp` pushes a single UDP server into the :c:type:`memcached_st` structure. This server will be placed at the end. Duplicate
-servers are allowed, so duplication is not checked. Executing this function with out setting the :c:type:`MEMCACHED_BEHAVIOR_USE_UDP` behavior will result in a
-:c:type:`MEMCACHED_INVALID_HOST_PROTOCOL`.
-
-:c:func:`memcached_server_add_unix_socket` pushes a single UNIX socket into the :c:type:`memcached_st` structure. This UNIX socket will be placed at the end.
-Duplicate servers are allowed, so duplication is not checked. The length
-of the filename must be one character less than :c:type:`MEMCACHED_MAX_HOST_LENGTH`.
-
-:c:func:`memcached_server_push` pushes an array of :c:type:`memcached_server_st` into the :c:type:`memcached_st` structure. These servers will be placed at
-the end. Duplicate servers are allowed, so duplication is not checked. A
-copy is made of structure so the list provided (and any operations on
-the list) are not saved.
-
-:c:func:`memcached_server_by_key` allows you to provide a key and retrieve the
-server which would be used for assignment.
-
-:c:func:`memcached_server_get_last_disconnect` returns a pointer to the last
-server for which there was a connection problem. It does not mean this
-particular server is currently dead but if the library is reporting a server
-is, the returned server is a very good candidate.
-
-:c:func:`memcached_server_cursor` takes a memcached_st and loops through the
-list of hosts currently in the cursor calling the list of callback
-functions provided. You can optionally pass in a value via
-context which will be provided to each callback function. An error
-return from any callback will terminate the loop. :c:func:`memcached_server_cursor` is passed the original caller :c:type:`memcached_st` in its current state.
-
-
-------
-RETURN
-------
-
-
-Varies, see particular functions.
-
-
-----
-HOME
-----
-
-
-To find out more information please check:
-`http://libmemcached.org/ <http://libmemcached.org/>`_
-
-
---------
-SEE ALSO
---------
-
-
-:manpage:`memcached(1)` :manpage:`libmemcached(3)` :manpage:`memcached_strerror(3)`
+++ /dev/null
-=========================================================
-Store, replace, add, or atomically add data to the server
-=========================================================
-
-.. index:: object: memcached_st
-
-
---------
-SYNOPSIS
---------
-
-
-#include <libmemcached/memcached.h>
-
-.. c:function:: memcached_return_t memcached_set (memcached_st *ptr, const char *key, size_t key_length, const char *value, size_t value_length, time_t expiration, uint32_t flags)
-
-.. c:function:: memcached_return_t memcached_add (memcached_st *ptr, const char *key, size_t key_length, const char *value, size_t value_length, time_t expiration, uint32_t flags)
-
-.. c:function:: memcached_return_t memcached_replace (memcached_st *ptr, const char *key, size_t key_length, const char *value, size_t value_length, time_t expiration, uint32_t flags)
-
-.. c:function:: memcached_return_t memcached_set_by_key(memcached_st *ptr, const char *group_key, size_t group_key_length, const char *key, size_t key_length, const char *value, size_t value_length, time_t expiration, uint32_t flags)
-
-.. c:function:: memcached_return_t memcached_add_by_key(memcached_st *ptr, const char *group_key, size_t group_key_length, const char *key, size_t key_length, const char *value, size_t value_length, time_t expiration, uint32_t flags)
-
-.. c:function:: memcached_return_t memcached_replace_by_key(memcached_st *ptr, const char *group_key, size_t group_key_length, const char *key, size_t key_length, const char *value, size_t value_length, time_t expiration, uint32_t flags)
-
-Compile and link with -lmemcached
-
-
------------
-DESCRIPTION
------------
-
-
-:c:func:`memcached_set`, :c:func:`memcached_add`, and :c:func:`memcached_replace` are all used to store information on the server. All methods take a key, and its length to store the object. Keys are currently limited to 250 characters when using either a version of memcached(1) which is 1.4 or below, or when using the text protocol. You must supply both a value and a length. Optionally you
-store the object. Keys are currently limited to 250 characters by the
-memcached(1) server. You must supply both a value and a length. Optionally you
-may test an expiration time for the object and a 16 byte value (it is meant to be used as a bitmap). "flags" is a 4byte space that is stored alongside of the main value. Many sub libraries make use of this field, so in most cases users should avoid making use of it.
-
-:c:func:`memcached_set` will write an object to the server. If an object
-already exists it will overwrite what is in the server. If the object does not
-exist it will be written. If you are using the non-blocking mode this function
-will always return true unless a network error occurs.
-
-:c:func:`memcached_replace` replaces an object on the server. If the object is not found on the server an error occurs.
-
-:c:func:`memcached_add` adds an object to the server. If the object is found on the server an error occurs, otherwise the value is stored.
-
-:c:func:`memcached_cas` overwrites data in the server as long as the "cas"
-value is still the same in the server. You can get the cas value of a result by
-calling :c:func:`memcached_result_cas` on a memcached_result_st(3) structure. At the point
-that this note was written cas is still buggy in memached. Turning on tests
-for it in libmemcached(3) is optional. Please see memcached_set for
-information on how to do this.
-
-:c:func:`memcached_set_by_key`, :c:func:`memcached_add_by_key`, and :c:func:`memcached_replace_by_key` methods all behave in a similar method as the non
-key methods. The difference is that they use their group_key parameter to map
-objects to particular servers.
-
-If you are looking for performance, :c:func:`memcached_set` with non-blocking IO is the fastest way to store data on the server.
-
-All of the above functions are testsed with the :c:type:`MEMCACHED_BEHAVIOR_USE_UDP` behavior enabled. However, when using these operations with this behavior
-on, there are limits to the size of the payload being sent to the server.
-The reason for these limits is that the Memcached Server does not allow
-multi-datagram requests and the current server implementation sets a datagram
-size to 1400 bytes. Due to protocol overhead, the actual limit of the user supplied data is less than 1400 bytes and depends on the protocol in use as, well as the operation being
-executed. When running with the binary protocol, :c:type:`MEMCACHED_BEHAVIOR_BINARY_PROTOCOL`, the size of the key,value, flags and expiry combined may not
-exceed 1368 bytes. When running with the ASCII protocol, the exact limit fluctuates depending on which function is being executed and whether the function is a cas operation or not. For non-cas ASCII set operations, there are at least
-1335 bytes available to split among the key, key_prefix, and value; for cas
-ASCII operations there are at least 1318 bytes available to split among the key, key_prefix and value. If the total size of the command, including overhead,
-exceeds 1400 bytes, a :c:type:`MEMCACHED_WRITE_FAILURE` will be returned.
-
-
-------
-RETURN
-------
-
-
-All methods return a value of type :c:type:`memcached_return_t`.
-On success the value will be :c:type:`MEMCACHED_SUCCESS`.
-Use :c:func:`memcached_strerror` to translate this value to a printable string.
-
-For :c:func:`memcached_replace` and :c:func:`memcached_add`, :c:type:`MEMCACHED_NOTSTORED` is a legitmate error in the case of a collision.
-
-
-----
-HOME
-----
-
-
-To find out more information please check:
-`http://libmemcached.org/ <http://libmemcached.org/>`_
-
-
---------
-SEE ALSO
---------
-
-
-:manpage:`memcached(1)` :manpage:`libmemached(3)` :manpage:`memcached_strerror(3)` :manpage:`memcached_prepend(3)` :manpage:`memcached_cas(3)` :manpage:`memcached_append(3)`
-
+++ /dev/null
-==================================================
-Working with statistical information from a server
-==================================================
-
-
-Get memcached statistics
-
-.. index:: object: memcached_st
-
-
---------
-SYNOPSIS
---------
-
-#include <libmemcached/memcached.h>
-
-.. c:type:: memcached_stat_st
-
-.. c:type:: memcached_return_t (*memcached_stat_fn)(const memcached_instance_st * server, const char *key, size_t key_length, const char *value, size_t value_length, void *context)
-
-.. c:function:: memcached_stat_st *memcached_stat (memcached_st *ptr, char *args, memcached_return_t *error)
-
-.. c:function:: memcached_return_t memcached_stat_servername (memcached_stat_st *stat, char *args, const char *hostname, in_port_t port)
-
-.. c:function:: char * memcached_stat_get_value (memcached_st *ptr, memcached_stat_st *stat, const char *key, memcached_return_t *error)
-
-.. c:function:: char ** memcached_stat_get_keys (memcached_st *ptr, memcached_stat_st *stat, memcached_return_t *error)
-
-.. c:function:: memcached_return_t memcached_stat_execute (memcached_st *memc, const char *args, memcached_stat_fn func, void *context)
-
-Compile and link with -lmemcached
-
------------
-DESCRIPTION
------------
-
-
-libmemcached(3) has the ability to query a memcached server (or collection
-of servers) for their current state. Queries to find state return a
-:c:type:`memcached_stat_st` structure. You are responsible for freeing this structure. While it is possible to access the structure directly it is not advisable. :c:func:`memcached_stat_get_value` has been provided to query the structure.
-
-:c:func:`memcached_stat_execute` uses the servers found in :c:type:`memcached_stat_st` and executes a "stat" command on each server. args is an optional argument that can be passed in to modify the behavior of "stats". You will need to supply a callback function that will be supplied each pair of values returned by
-the memcached server.
-
-:c:func:`memcached_stat` fetches an array of :c:type:`memcached_stat_st` structures containing the state of all available memcached servers. The return value must be freed by the calling application. If called with the :c:type:`MEMCACHED_BEHAVIOR_USE_UDP` behavior set, a NULL value is returned and the error parameter is set to :c:type:`MEMCACHED_NOT_SUPPORTED`.
-
-:c:func:`memcached_stat_servername` can be used standalone without a :c:type:`memcached_st` to obtain the state of a particular server. "args" is used to define a particular state object (a list of these are not provided for by either
-the :c:func:`memcached_stat_get_keys` call nor are they defined in the memcached protocol). You must specify the hostname and port of the server you want to
-obtain information on.
-
-:c:func:`memcached_stat_get_value` returns the value of a particular state key. You specify the key you wish to obtain. The key must be null terminated.
-
-:c:func:`memcached_stat_get_keys` returns a list of keys that the server has state objects on. You are responsible for freeing this list.
-
-A command line tool, memstat(1), is provided so that you do not have to write
-an application to do this.
-
-
-------
-RETURN
-------
-
-
-Varies, see particular functions.
-
-Any method returning a :c:type:`memcached_stat_st` expects you to free the
-memory allocated for it.
-
-
-----
-HOME
-----
-
-
-To find out more information please check:
-`http://libmemcached.org/ <http://libmemcached.org/>`_
-
-
-------
-AUTHOR
-------
-
-
-Brian Aker, <brian@tangent.org>
-
-
---------
-SEE ALSO
---------
-
-
-:manpage:`memcached(1)` :manpage:`libmemcached(3)` :manpage:`memcached_strerror(3)`
-
+++ /dev/null
-================================================
-Coverting Errors, memcached_return_t, to strings
-================================================
-
-
-.. index:: object: memcached_st
-
---------
-SYNOPSIS
---------
-
-#include <libmemcached/memcached.h>
-
-.. c:function:: const char * memcached_strerror (memcached_st *ptr, memcached_return_t rc)
-
-Compile and link with -lmemcached
-
-
------------
-DESCRIPTION
------------
-
-
-:c:func:`memcached_strerror` takes a :c:type:`memcached_return_t` value and returns a string describing the error.
-
-This string must not be modified by the application.
-
-:c:type:`memcached_return_t` values are returned from nearly all libmemcached(3) functions.
-
-:c:type:`memcached_return_t` values are of an enum type so that you can set up responses with switch/case and know that you are capturing all possible return values.
-
-
-------
-RETURN
-------
-
-
-:c:func:`memcached_strerror` returns a string describing a :c:type:`memcached_return_t` value.
-
-
-----
-HOME
-----
-
-
-To find out more information please check:
-`http://libmemcached.org/ <http://libmemcached.org/>`_
-
-
-
---------
-SEE ALSO
---------
-
-
-:manpage:`memcached(1)` :manpage:`libmemcached(3)`
-
+++ /dev/null
-==============================================
-Storing custom user information in the client.
-==============================================
-
-.. index:: object: memcached_st
-
-Manage user specific data
-
-
--------
-LIBRARY
--------
-
-
-C Client Library for memcached (libmemcached, -lmemcached)
-
-
---------
-SYNOPSIS
---------
-
-
-
-.. code-block:: c
-
-#include <libmemcached/memcached.h>
-
-.. c:function:: void *memcached_get_user_data (memcached_st *ptr)
-
-.. c:function:: void *memcached_set_user_data (memcached_st *ptr, void *data)
-
-Compile and link with -lmemcached
-
-
-
------------
-DESCRIPTION
------------
-
-
-libmemcached(3) allows you to store a pointer to a user specific data inside
-the memcached_st structure.
-
-:c:func:`memcached_set_user_data` is used to set the user specific data in the
-:c:type:`memcached_st` structure.
-
-:c:func:`memcached_get_user_data` is used to retrieve the user specific data in the :c:type:`memcached_st` structure.
-
-
-------
-RETURN
-------
-
-
-:c:func:`memcached_set_user_data` returns the previous value of the user specific data.
-
-:c:func:`memcached_get_user_data` returns the current value uf the user specific data.
-
-
-----
-HOME
-----
-
-
-To find out more information please check:
-`http://libmemcached.org/ <http://libmemcached.org/>`_
-
-
---------
-SEE ALSO
---------
-
-
-:manpage:`memcached(1)` :manpage:`libmemcached(3)`
-
+++ /dev/null
-=================================
-Setting the verbosity of a server
-=================================
-
-.. index:: object: memcached_st
-
-Modifiy verbosity of servers
-
---------
-SYNOPSIS
---------
-
-#include <libmemcached/memcached.h>
-
-.. c:function:: memcached_return_t memcached_verbosity (memcached_st *ptr, uint32_t verbosity)
-
-Compile and link with -lmemcached
-
-
------------
-DESCRIPTION
------------
-
-
-:c:func:`memcached_verbosity` modifies the "verbosity" of the
-memcached(1) servers referenced in the :c:type:`memcached_st` parameter.
-
-
-------
-RETURN
-------
-
-
-A value of type :c:type:`memcached_return_t` is returned.
-
-On success that value will be :c:type:`MEMCACHED_SUCCESS`.
-
-Use :c:func:`memcached_strerror` to translate this value to a printable string.
-
-
-----
-HOME
-----
-
-
-To find out more information please check:
-`http://libmemcached.org/ <http://libmemcached.org/>`_
-
-
---------
-SEE ALSO
---------
-
-
-:manpage:`memcached(1)` :manpage:`libmemcached(3)` :manpage:`memcached_strerror(3)`
-
+++ /dev/null
-=======================================================
-Getting version information about the client and server
-=======================================================
-
-
---------
-SYNOPSIS
---------
-
-#include <libmemcached/memcached.h>
-
-.. c:function:: const char * memcached_lib_version (void)
-
-.. c:function:: memcached_return_t memcached_version (memcached_st *ptr)
-
-
-Compile and link with -lmemcached
-
-
-
------------
-DESCRIPTION
------------
-
-
-:c:func:`memcached_lib_version` is used to return a simple version string representing the libmemcached version (client library version, not server version)
-
-:c:func:`memcached_version` is used to set the major, minor, and micro versions of each memcached server being used by the memcached_st connection structure. It returns the memcached server return code.
-
-
-------
-RETURN
-------
-
-
-:c:func:`memcached_lib_version` returns a string with the version of the libmemcached driver.
-
-A value of :c:type:`memcached_return_t` is returned from :c:func:'memcached_version'
-
-On success that value will be :c:type:`MEMCACHED_SUCCESS`.
-
-If called with the :c:func:`MEMCACHED_BEHAVIOR_USE_UDP` behavior set, the value :c:type:`MEMCACHED_NOT_SUPPORTED` will be returned.
-
-Use :c:func:`memcached_strerror` to translate this value to
-a printable string.
-
-
-----
-HOME
-----
-
-
-To find out more information please check:
-`http://libmemcached.org/ <http://libmemcached.org/>`_
-
-
---------
-SEE ALSO
---------
-
-
-:manpage:`memcached(1)` :manpage:`libmemcached(3)` :manpage:`memcached_strerror(3)`
-
--- /dev/null
+==================================================
+memaslap - Load testing and benchmarking a server
+==================================================
+
+
+--------
+SYNOPSIS
+--------
+
+memaslap [options]
+
+.. program:: memaslap
+
+.. option:: --help
+
+.. envvar:: MEMCACHED_SERVERS
+
+-----------
+DESCRIPTION
+-----------
+
+
+:program:`memaslap` is a load generation and benchmark tool for memcached
+servers. It generates configurable workload such as threads, concurrencies,
+connections, run time, overwrite, miss rate, key size, value size, get/set
+proportion, expected throughput, and so on. Furthermore, it also testss data
+verification, expire-time verification, UDP, binary protocol, facebook test,
+replication test, multi-get and reconnection, etc.
+
+Memaslap manages network connections like memcached with
+libevent. Each thread of memaslap is bound with a CPU core, all
+the threads don't communicate with each other, and there are several socket
+connections in each thread. Each connection keeps key size distribution,
+value size distribution, and command distribution by itself.
+
+You can specify servers via the :option:`memslap --servers` option or via the
+environment variable :envvar:`MEMCACHED_SERVERS`.
+
+
+--------
+FEATURES
+--------
+
+
+Memslap is developed to for the following purposes:
+
+
+Manages network connections with libevent asynchronously.
+
+
+
+Set both TCP and UDP up to use non-blocking IO.
+
+
+
+Improves parallelism: higher performance in multi-threads environments.
+
+
+
+Improves time efficiency: faster processing speed.
+
+
+
+Generates key and value more efficiently; key size distribution and value size distribution are configurable.
+
+
+
+Supports get, multi-get, and set commands; command distribution is configurable.
+
+
+
+Supports controllable miss rate and overwrite rate.
+
+
+
+Supports data and expire-time verification.
+
+
+
+Supports dumping statistic information periodically.
+
+
+
+Supports thousands of TCP connections.
+
+
+
+Supports binary protocol.
+
+
+
+Supports facebook test (set with TCP and multi-get with UDP) and replication test.
+
+
+
+
+-------
+DETAILS
+-------
+
+
+Effective implementation of network.
+____________________________________
+
+
+For memaslap, both TCP and UDP use non-blocking network IO. All
+the network events are managed by libevent as memcached. The network module
+of memaslap is similar to memcached. Libevent can ensure
+memaslap can handle network very efficiently.
+
+
+Effective implementation of multi-threads and concurrency
+_________________________________________________________
+
+
+Memslap has the similar implementation of multi-threads to
+memcached. Memslap creates one or more self-governed threads;
+each thread is bound with one CPU core if the system testss setting CPU
+core affinity.
+
+In addition, each thread has a libevent to manage the events of the network;
+each thread has one or more self-governed concurrencies; and each
+concurrency has one or more socket connections. All the concurrencies don’t
+communicate with each other even though they are in the same thread.
+
+Memslap can create thousands of socket connections, and each
+concurrency has tens of socket connections. Each concurrency randomly or
+sequentially selects one socket connection from its socket connection pool
+to run, so memaslap can ensure each concurrency handles one
+socket connection at any given time. Users can specify the number of
+concurrency and socket connections of each concurrency according to their
+expected workload.
+
+
+Effective implementation of generating key and value
+____________________________________________________
+
+
+In order to improve time efficiency and space efficiency,
+memaslap creates a random characters table with 10M characters. All the
+suffixes of keys and values are generated from this random characters table.
+
+Memslap uses the offset in the character table and the length
+of the string to identify a string. It can save much memory.
+Each key contains two parts, a prefix and a suffix. The prefix is an
+uint64_t, 8 bytes. In order to verify the data set before,
+memaslap need to ensure each key is unique, so it uses the prefix to identify
+a key. The prefix cannot include illegal characters, such as ‘\r’, ‘\n’,
+‘\0’ and ‘ ‘. And memaslap has an algorithm to ensure that.
+
+Memslap doesn’t generate all the objects (key-value pairs) at
+the beginning. It only generates enough objects to fill the task window
+(default 10K objects) of each concurrency. Each object has the following
+basic information, key prefix, key suffix offset in the character table, key
+length, value offset in the character table, and value length.
+
+In the work process, each concurrency sequentially or randomly selects an
+object from the window to do set operation or get operation. At the same
+time, each concurrency kicks objects out of its window and adds new object
+into it.
+
+
+Simple but useful task scheduling
+_________________________________
+
+
+Memslap uses libevent to schedule all the concurrencies of
+threads, and each concurrency schedules tasks based on the local task
+window. Memslap assumes that if each concurrency keeps the same
+key distribution, value distribution and commands distribution, from
+outside, memaslap keeps all the distribution as a whole.
+Each task window includes a lot of objects, each object stores its basic
+information, such as key, value, expire time, and so on. At any time, all
+the objects in the window keep the same and fixed key and value
+distribution. If an object is overwritten, the value of the object will be
+updated. Memslap verifies the data or expire-time according to
+the object information stored in the task window.
+
+Libevent selects which concurrency to handle based on a specific network
+event. Then the concurrency selects which command (get or set) to operate
+based on the command distribution. If it needs to kick out an old object and
+add a new object, in order to keep the same key and value distribution, the
+new object must have the same key length and value length.
+
+If memcached server has two cache layers (memory and SSD), running
+memaslap with different window sizes can get different cache
+miss rates. If memaslap adds enough objects into the windows at
+the beginning, and the cache of memcached cannot store all the objects
+initialized, then memaslap will get some objects from the second
+cache layer. It causes the first cache layer to miss. So the user can
+specify the window size to get the expected miss rate of the first cache
+layer.
+
+
+Useful implementation of multi-servers , UDP, TCP, multi-get and binary protocol
+________________________________________________________________________________
+
+
+Because each thread is self-governed, memaslap can assign
+different threads to handle different memcached servers. This is just one of
+the ways in which memaslap tests multiple servers. The only
+limitation is that the number of servers cannot be greater than the number
+of threads. The other way to test multiple servers is for replication
+test. Each concurrency has one socket connection to each memcached server.
+For the implementation, memaslap can set some objects to one
+memcached server, and get these objects from the other servers.
+
+By default, Memslap does single get. If the user specifies
+multi-get option, memaslap will collect enough get commands and
+pack and send the commands together.
+
+Memslap testss both the ASCII protocol and binary protocol,
+but it runs on the ASCII protocol by default.
+Memslap by default runs on the TCP protocol, but it also
+tests UDP. Because UDP is unreliable, dropped packages and out-of-order
+packages may occur. Memslap creates a memory buffer to handle
+these problems. Memslap tries to read all the response data of
+one command from the server and reorders the response data. If some packages
+get lost, the waiting timeout mechanism can ensure half-baked packages will
+be discarded and the next command will be sent.
+
+
+
+-----
+USAGE
+-----
+
+
+Below are some usage samples:
+
+
+memaslap -s 127.0.0.1:11211 -S 5s
+
+
+
+memaslap -s 127.0.0.1:11211 -t 2m -v 0.2 -e 0.05 -b
+
+
+
+memaslap -s 127.0.0.1:11211 -F config -t 2m -w 40k -S 20s -o 0.2
+
+
+
+memaslap -s 127.0.0.1:11211 -F config -t 2m -T 4 -c 128 -d 20 -P 40k
+
+
+
+memaslap -s 127.0.0.1:11211 -F config -t 2m -d 50 -a -n 40
+
+
+
+memaslap -s 127.0.0.1:11211,127.0.0.1:11212 -F config -t 2m
+
+
+
+memaslap -s 127.0.0.1:11211,127.0.0.1:11212 -F config -t 2m -p 2
+
+
+
+The user must specify one server at least to run memaslap. The
+rest of the parameters have default values, as shown below:
+
+Thread number = 1 Concurrency = 16
+
+Run time = 600 seconds Configuration file = NULL
+
+Key size = 64 Value size = 1024
+
+Get/set = 9:1 Window size = 10k
+
+Execute number = 0 Single get = true
+
+Multi-get = false Number of sockets of each concurrency = 1
+
+Reconnect = false Data verification = false
+
+Expire-time verification = false ASCII protocol = true
+
+Binary protocol = false Dumping statistic information
+
+periodically = false
+
+Overwrite proportion = 0% UDP = false
+
+TCP = true Limit throughput = false
+
+Facebook test = false Replication test = false
+
+Key size, value size and command distribution.
+______________________________________________
+
+
+All the distributions are read from the configuration file specified by user
+with “—cfg_cmd” option. If the user does not specify a configuration file,
+memaslap will run with the default distribution (key size = 64,
+value size = 1024, get/set = 9:1). For information on how to edit the
+configuration file, refer to the “Configuration File” section.
+
+The minimum key size is 16 bytes; the maximum key size is 250 bytes. The
+precision of proportion is 0.001. The proportion of distribution will be
+rounded to 3 decimal places.
+
+The minimum value size is 1 bytes; the maximum value size is 1M bytes. The
+precision of proportion is 0.001. The proportion of distribution will be
+rounded to 3 decimal places.
+Currently, memaslap only testss set and get commands. And it
+testss 100% set and 100% get. For 100% get, it will preset some objects to
+the server.
+
+
+Multi-thread and concurrency
+____________________________
+
+
+The high performance of memaslap benefits from the special
+schedule of thread and concurrency. It’s important to specify the proper
+number of them. The default number of threads is 1; the default number of
+concurrency is 16. The user can use “—threads” and “--concurrency” to
+specify these variables.
+
+If the system tests setting CPU affinity and the number of threads
+specified by the user is greater than 1, memaslap will try to
+bind each thread to a different CPU core. So if you want to get the best
+performance memaslap, it is better to specify the number of
+thread equal to the number of CPU cores. The number of threads specified by
+the user can also be less or greater than the number of CPU cores. Because
+of the limitation of implementation, the number of concurrencies could be
+the multiple of the number of threads.
+
+1. For 8 CPU cores system
+
+For example:
+
+--threads=2 --concurrency=128
+
+--threads=8 --concurrency=128
+
+--threads=8 --concurrency=256
+
+--threads=12 --concurrency=144
+
+2. For 16 CPU cores system
+
+For example:
+
+--threads=8 --concurrency=128
+
+--threads=16 --concurrency=256
+
+--threads=16 --concurrency=512
+
+--threads=24 --concurrency=288
+
+The memaslap performs very well, when
+used to test the performance of memcached servers.
+Most of the time, the bottleneck is the network or
+the server. If for some reason the user wants to
+limit the performance of memaslap, there
+are two ways to do this:
+
+Decrease the number of threads and concurrencies.
+Use the option “--tps” that memaslap
+provides to limit the throughput. This option allows
+the user to get the expected throughput. For
+example, assume that the maximum throughput is 50
+kops/s for a specific configuration, you can specify
+the throughput equal to or less than the maximum
+throughput using “--tps” option.
+
+
+Window size
+___________
+
+
+Most of the time, the user does not need to specify the window size. The
+default window size is 10k. For Schooner Memcached, the user can specify
+different window sizes to get different cache miss rates based on the test
+case. Memslap testss cache miss rate between 0% and 100%.
+If you use this utility to test the performance of Schooner Memcached, you
+can specify a proper window size to get the expected cache miss rate. The
+formula for calculating window size is as follows:
+
+Assume that the key size is 128 bytes, and the value size is 2048 bytes, and
+concurrency=128.
+
+1. Small cache cache_size=1M, 100% cache miss (all data get from SSD).
+win_size=10k
+
+2. cache_size=4G
+
+(1). cache miss rate 0%
+
+win_size=8k
+
+(2). cache miss rate 5%
+
+win_size=11k
+
+3. cache_size=16G
+
+(1). cache miss rate 0%
+
+win_size=32k
+
+(2). cache miss
+
+rate 5%
+
+win_size=46k
+
+The formula for calculating window size for cache miss rate 0%:
+
+cache_size / concurrency / (key_size + value_size) \* 0.5
+
+The formula for calculating window size for cache miss rate 5%:
+
+cache_size / concurrency / (key_size + value_size) \* 0.7
+
+
+Verification
+____________
+
+
+Memslap testss both data verification and expire-time
+verification. The user can use "--verify=" or "-v" to specify the proportion
+of data verification. In theory, it testss 100% data verification. The
+user can use "--exp_verify=" or "-e" to specify the proportion of
+expire-time verification. In theory, it testss 100% expire-time
+verification. Specify the "--verbose" options to get more detailed error
+information.
+
+For example: --exp_verify=0.01 –verify=0.1 , it means that 1% of the objects
+set with expire-time, 10% of the objects gotten will be verified. If the
+objects are gotten, memaslap will verify the expire-time and
+value.
+
+
+multi-servers and multi-config
+_______________________________
+
+
+Memslap testss multi-servers based on self-governed thread.
+There is a limitation that the number of servers cannot be greater than the
+number of threads. Memslap assigns one thread to handle one
+server at least. The user can use the "--servers=" or "-s" option to specify
+multi-servers.
+
+For example:
+
+--servers=10.1.1.1:11211,10.1.1.2:11212,10.1.1.3:11213 --threads=6 --concurrency=36
+
+The above command means that there are 6 threads, with each thread having 6
+concurrencies and that threads 0 and 3 handle server 0 (10.1.1.1); threads 1
+and 4 handle server 1 (10.1.1.2); and thread 2 and 5 handle server 2
+(10.1.1.3).
+
+All the threads and concurrencies in memaslap are self-governed.
+
+So is memaslap. The user can start up several
+memaslap instances. The user can run memaslap on different client
+machines to communicate with the same memcached server at the same. It is
+recommended that the user start different memaslap on different
+machines using the same configuration.
+
+
+Run with execute number mode or time mode
+_________________________________________
+
+
+The default memaslap runs with time mode. The default run time
+is 10 minutes. If it times out, memaslap will exit. Do not
+specify both execute number mode and time mode at the same time; just
+specify one instead.
+
+For example:
+
+--time=30s (It means the test will run 30 seconds.)
+
+--execute_number=100000 (It means that after running 100000 commands, the test will exit.)
+
+
+Dump statistic information periodically.
+________________________________________
+
+
+The user can use "--stat_freq=" or "-S" to specify the frequency.
+
+For example:
+
+--stat_freq=20s
+
+Memslap will dump the statistics of the commands (get and set) at the frequency of every 20
+seconds.
+
+For more information on the format of dumping statistic information, refer to “Format of Output” section.
+
+
+Multi-get
+_________
+
+
+The user can use "--division=" or "-d" to specify multi-get keys count.
+Memslap by default does single get with TCP. Memslap also testss data
+verification and expire-time verification for multi-get.
+
+Memslap testss multi-get with both TCP and UDP. Because of
+the different implementation of the ASCII protocol and binary protocol,
+there are some differences between the two. For the ASCII protocol,
+memaslap sends one “multi-get” to the server once. For the
+binary protocol, memaslap sends several single get commands
+together as “multi-get” to the server.
+
+
+UDP and TCP
+___________
+
+
+Memslap testss both UDP and TCP. For TCP,
+memaslap does not reconnect the memcached server if socket connections are
+lost. If all the socket connections are lost or memcached server crashes,
+memaslap will exit. If the user specifies the “--reconnect”
+option when socket connections are lost, it will reconnect them.
+
+User can use “--udp” to enable the UDP feature, but UDP comes with some
+limitations:
+
+UDP cannot set data more than 1400 bytes.
+
+UDP is not testsed by the binary protocol because the binary protocol of
+memcached does not tests that.
+
+UDP doesn’t tests reconnection.
+
+
+Facebook test
+_____________
+
+
+Set data with TCP and multi-get with UDP. Specify the following options:
+
+"--facebook --division=50"
+
+If you want to create thousands of TCP connections, specify the
+
+"--conn_sock=" option.
+
+For example: --facebook --division=50 --conn_sock=200
+
+The above command means that memaslap will do facebook test,
+each concurrency has 200 socket TCP connections and one UDP socket.
+
+Memslap sets objects with the TCP socket, and multi-gets 50
+objects once with the UDP socket.
+
+If you specify "--division=50", the key size must be less that 25 bytes
+because the UDP packet size is 1400 bytes.
+
+
+Replication test
+________________
+
+
+For replication test, the user must specify at least two memcached servers.
+The user can use “—rep_write=” option to enable feature.
+
+For example:
+
+--servers=10.1.1.1:11211,10.1.1.2:11212 –rep_write=2
+
+The above command means that there are 2 replication memcached servers,
+memaslap will set objects to both server 0 and server 1, get
+objects which are set to server 0 before from server 1, and also get objects
+which are set to server 1 before from server 0. If server 0 crashes,
+memaslap will only get objects from server 1. If server 0 comes
+back to life again, memaslap will reconnect server 0. If both
+server 0 and server 1 crash, memaslap will exit.
+
+
+Supports thousands of TCP connections
+_____________________________________
+
+
+Start memaslap with "--conn_sock=" or "-n" to enable this
+feature. Make sure that your system can tests opening thousands of files
+and creating thousands of sockets. However, this feature does not tests
+reconnection if sockets disconnect.
+
+For example:
+
+--threads=8 --concurrency=128 --conn_sock=128
+
+The above command means that memaslap starts up 8 threads, each
+thread has 16 concurrencies, each concurrency has 128 TCP socket
+connections, and the total number of TCP socket connections is 128 \* 128 =
+16384.
+
+
+Supports binary protocol
+________________________
+
+
+Start memaslap with "--binary" or "-B" options to enable this
+feature. It testss all the above features except UDP, because the latest
+memcached 1.3.3 does not implement binary UDP protocol.
+
+For example:
+
+--binary
+
+Since memcached 1.3.3 doesn't implement binary UDP protocol,
+memaslap does not tests UDP. In addition, memcached 1.3.3 does not tests
+multi-get. If you specify "--division=50" option, it just sends 50 get
+commands together as “mulit-get” to the server.
+
+
+
+------------------
+Configuration file
+------------------
+
+
+This section describes the format of the configuration file. By default
+when no configuration file is specified memaslap reads the default
+one located at ~/.memaslap.cnf.
+
+Below is a sample configuration file:
+
+
+.. code-block:: perl
+
+ ---------------------------------------------------------------------------
+ #comments should start with '#'
+ #key
+ #start_len end_len proportion
+ #
+ #key length range from start_len to end_len
+ #start_len must be equal to or greater than 16
+ #end_len must be equal to or less than 250
+ #start_len must be equal to or greater than end_len
+ #memaslap will generate keys according to the key range
+ #proportion: indicates keys generated from one range accounts for the total
+ generated keys
+ #
+ #example1: key range 16~100 accounts for 80%
+ # key range 101~200 accounts for 10%
+ # key range 201~250 accounts for 10%
+ # total should be 1 (0.8+0.1+0.1 = 1)
+ #
+ # 16 100 0.8
+ # 101 200 0.1
+ # 201 249 0.1
+ #
+ #example2: all keys length are 128 bytes
+ #
+ # 128 128 1
+ key
+ 128 128 1
+ #value
+ #start_len end_len proportion
+ #
+ #value length range from start_len to end_len
+ #start_len must be equal to or greater than 1
+ #end_len must be equal to or less than 1M
+ #start_len must be equal to or greater than end_len
+ #memaslap will generate values according to the value range
+ #proportion: indicates values generated from one range accounts for the
+ total generated values
+ #
+ #example1: value range 1~1000 accounts for 80%
+ # value range 1001~10000 accounts for 10%
+ # value range 10001~100000 accounts for 10%
+ # total should be 1 (0.8+0.1+0.1 = 1)
+ #
+ # 1 1000 0.8
+ # 1001 10000 0.1
+ # 10001 100000 0.1
+ #
+ #example2: all value length are 128 bytes
+ #
+ # 128 128 1
+ value
+ 2048 2048 1
+ #cmd
+ #cmd_type cmd_proportion
+ #
+ #currently memaslap only testss get and set command.
+ #
+ #cmd_type
+ #set 0
+ #get 1
+ #
+ #example: set command accounts for 50%
+ # get command accounts for 50%
+ # total should be 1 (0.5+0.5 = 1)
+ #
+ # cmd
+ # 0 0.5
+ # 1 0.5
+ cmd
+ 0 0.1
+ 1.0 0.9
+
+
+
+----------------
+Format of output
+----------------
+
+
+At the beginning, memaslap displays some configuration information as follows:
+
+
+servers : 127.0.0.1:11211
+
+
+
+threads count: 1
+
+
+
+concurrency: 16
+
+
+
+run time: 20s
+
+
+
+windows size: 10k
+
+
+
+set proportion: set_prop=0.10
+
+
+
+get proportion: get_prop=0.90
+
+
+
+Where
+_____
+
+
+
+servers : "servers"
+
+ The servers used by memaslap.
+
+
+
+threads count
+
+ The number of threads memaslap runs with.
+
+
+
+concurrency
+
+ The number of concurrencies memaslap runs with.
+
+
+
+run time
+
+ How long to run memaslap.
+
+
+
+windows size
+
+ The task window size of each concurrency.
+
+
+
+set proportion
+
+ The proportion of set command.
+
+
+
+get proportion
+
+ The proportion of get command.
+
+
+
+The output of dynamic statistics is something like this:
+
+
+.. code-block:: perl
+
+ ---------------------------------------------------------------------------------------------------------------------------------
+ Get Statistics
+ Type Time(s) Ops TPS(ops/s) Net(M/s) Get_miss Min(us) Max(us)
+ Avg(us) Std_dev Geo_dist
+ Period 5 345826 69165 65.3 0 27 2198 203
+ 95.43 177.29
+ Global 20 1257935 62896 71.8 0 26 3791 224
+ 117.79 192.60
+
+
+ Set Statistics
+ Type Time(s) Ops TPS(ops/s) Net(M/s) Get_miss Min(us) Max(us)
+ Avg(us) Std_dev Geo_dist
+ Period 5 38425 7685 7.3 0 42 628 240
+ 88.05 220.21
+ Global 20 139780 6989 8.0 0 37 3790 253
+ 117.93 224.83
+
+
+ Total Statistics
+ Type Time(s) Ops TPS(ops/s) Net(M/s) Get_miss Min(us) Max(us)
+ Avg(us) Std_dev Geo_dist
+ Period 5 384252 76850 72.5 0 27 2198 207
+ 94.72 181.18
+ Global 20 1397720 69886 79.7 0 26 3791 227
+ 117.93 195.60
+ ---------------------------------------------------------------------------------------------------------------------------------
+
+
+
+Where
+_____
+
+
+
+Get Statistics
+
+ Statistics information of get command
+
+
+
+Set Statistics
+
+ Statistics information of set command
+
+
+
+Total Statistics
+
+ Statistics information of both get and set command
+
+
+
+Period
+
+ Result within a period
+
+
+
+Global
+
+ Accumulated results
+
+
+
+Ops
+
+ Total operations
+
+
+
+TPS
+
+ Throughput, operations/second
+
+
+
+Net
+
+ The rate of network
+
+
+
+Get_miss
+
+ How many objects can’t be gotten
+
+
+
+Min
+
+ The minimum response time
+
+
+
+Max
+
+ The maximum response time
+
+
+
+Avg:
+
+ The average response time
+
+
+
+Std_dev
+
+ Standard deviation of response time
+
+
+
+Geo_dist
+
+ Geometric distribution based on natural exponential function
+
+
+
+At the end, memaslap will output something like this:
+
+
+.. code-block:: perl
+
+ ---------------------------------------------------------------------------------------------------------------------------------
+ Get Statistics (1257956 events)
+ Min: 26
+ Max: 3791
+ Avg: 224
+ Geo: 192.60
+ Std: 116.23
+ Log2 Dist:
+ 4: 0 10 84490 215345
+ 8: 484890 459823 12543 824
+ 12: 31
+
+ Set Statistics (139782 events)
+ Min: 37
+ Max: 3790
+ Avg: 253
+ Geo: 224.84
+ Std: 116.83
+ Log2 Dist:
+ 4: 0 0 4200 16988
+ 8: 50784 65574 2064 167
+ 12: 5
+
+ Total Statistics (1397738 events)
+ Min: 26
+ Max: 3791
+ Avg: 227
+ Geo: 195.60
+ Std: 116.60
+ Log2 Dist:
+ 4: 0 10 88690 232333
+ 8: 535674 525397 14607 991
+ 12: 36
+
+ cmd_get: 1257969
+ cmd_set: 139785
+ get_misses: 0
+ verify_misses: 0
+ verify_failed: 0
+ expired_get: 0
+ unexpired_unget: 0
+ written_bytes: 242516030
+ read_bytes: 1003702556
+ object_bytes: 152086080
+ packet_disorder: 0
+ packet_drop: 0
+ udp_timeout: 0
+
+ Run time: 20.0s Ops: 1397754 TPS: 69817 Net_rate: 59.4M/s
+ ---------------------------------------------------------------------------------------------------------------------------------
+
+
+
+Where
+_____
+
+
+
+Get Statistics
+
+ Get statistics of response time
+
+
+
+Set Statistics
+
+ Set statistics of response time
+
+
+
+Total Statistics
+
+ Both get and set statistics of response time
+
+
+
+Min
+
+ The accumulated and minimum response time
+
+
+
+Max
+
+ The accumulated and maximum response time
+
+
+
+Avg
+
+ The accumulated and average response time
+
+
+
+Std
+
+ Standard deviation of response time
+
+
+
+Log2 Dist
+
+ Geometric distribution based on logarithm 2
+
+
+
+cmd_get
+
+ Total get commands done
+
+
+
+cmd_set
+
+ Total set commands done
+
+
+
+get_misses
+
+ How many objects can’t be gotten from server
+
+
+
+verify_misses
+
+ How many objects need to verify but can’t get them
+
+
+
+verify_failed
+
+ How many objects with insistent value
+
+
+
+expired_get
+
+ How many objects are expired but we get them
+
+
+
+unexpired_unget
+
+ How many objects are unexpired but we can’t get them
+
+
+
+written_bytes
+
+ Total written bytes
+
+
+
+read_bytes
+
+ Total read bytes
+
+
+
+object_bytes
+
+ Total object bytes
+
+
+
+packet_disorder
+
+ How many UDP packages are disorder
+
+
+
+packet_drop
+
+ How many UDP packages are lost
+
+
+
+udp_timeout
+
+ How many times UDP time out happen
+
+
+
+Run time
+
+ Total run time
+
+
+
+Ops
+
+ Total operations
+
+
+
+TPS
+
+ Throughput, operations/second
+
+
+
+Net_rate
+
+ The average rate of network
+
+
+
+
+
+-------
+OPTIONS
+-------
+
+
+-s, --servers=
+ List one or more servers to connect. Servers count must be less than
+ threads count. e.g.: --servers=localhost:1234,localhost:11211
+
+-T, --threads=
+ Number of threads to startup, better equal to CPU numbers. Default 8.
+
+-c, --concurrency=
+ Number of concurrency to simulate with load. Default 128.
+
+-n, --conn_sock=
+ Number of TCP socks per concurrency. Default 1.
+
+-x, --execute_number=
+ Number of operations(get and set) to execute for the
+ given test. Default 1000000.
+
+-t, --time=
+ How long the test to run, suffix: s-seconds, m-minutes, h-hours,
+ d-days e.g.: --time=2h.
+
+-F, --cfg_cmd=
+ Load the configure file to get command,key and value distribution list.
+
+-w, --win_size=
+ Task window size of each concurrency, suffix: K, M e.g.: --win_size=10k.
+ Default 10k.
+
+-X, --fixed_size=
+ Fixed length of value.
+
+-v, --verify=
+ The proportion of date verification, e.g.: --verify=0.01
+
+-d, --division=
+ Number of keys to multi-get once. Default 1, means single get.
+
+-S, --stat_freq=
+ Frequency of dumping statistic information. suffix: s-seconds,
+ m-minutes, e.g.: --resp_freq=10s.
+
+-e, --exp_verify=
+ The proportion of objects with expire time, e.g.: --exp_verify=0.01.
+ Default no object with expire time
+
+-o, --overwrite=
+ The proportion of objects need overwrite, e.g.: --overwrite=0.01.
+ Default never overwrite object.
+
+-R, --reconnect
+ Reconnect tests, when connection is closed it will be reconnected.
+
+-U, --udp
+ UDP tests, default memaslap uses TCP, TCP port and UDP port of
+ server must be same.
+
+-a, --facebook
+ Whether it enables facebook test feature, set with TCP and multi-get with UDP.
+
+-B, --binary
+ Whether it enables binary protocol. Default with ASCII protocol.
+
+-P, --tps=
+ Expected throughput, suffix: K, e.g.: --tps=10k.
+
+-p, --rep_write=
+ The first nth servers can write data, e.g.: --rep_write=2.
+
+-b, --verbose
+ Whether it outputs detailed information when verification fails.
+
+-h, --help
+ Display this message and then exit.
+
+-V, --version
+ 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 -t 2m -v 0.2 -e 0.05 -b
+
+memaslap -s 127.0.0.1:11211 -F config -t 2m -w 40k -S 20s -o 0.2
+
+memaslap -s 127.0.0.1:11211 -F config -t 2m -T 4 -c 128 -d 20 -P 40k
+
+memaslap -s 127.0.0.1:11211 -F config -t 2m -d 50 -a -n 40
+
+memaslap -s 127.0.0.1:11211,127.0.0.1:11212 -F config -t 2m
+
+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://libmemcached.org/ <http://libmemcached.org/>`_
+
+
+-------
+AUTHORS
+-------
+
+
+Mingqiang Zhuang <mingqiangzhuang@hengtiansoft.com> (Schooner Technolgy)
+Brian Aker, <brian@tangent.org>
+
+
+--------
+SEE ALSO
+--------
+
+:manpage:`memcached(1)` :manpage:`libmemcached(3)`
--- /dev/null
+=======================================================================
+memcapable - Checking a Memcached server capibilities and compatibility
+=======================================================================
+
+--------
+SYNOPSIS
+--------
+
+memcapable [options]
+
+.. program:: memcapable
+
+-----------
+DESCRIPTION
+-----------
+
+:program:`memcapable` connects to the specified memcached server and tries to
+determine its capabilities by running the various commands and verifying
+the response.
+
+
+-----------
+LIMITATIONS
+-----------
+
+
+The current version of memcapable will only verify the binary protocol.
+
+
+-------
+OPTIONS
+-------
+
+
+.. option:: -h hostname
+
+Specify the hostname to connect to. The default is \ *localhost*\
+
+.. option:: -p port
+
+Specify the port number to connect to. The default is \ *11211*\
+
+.. option:: -c
+
+Generate a coredump when it detects an error from the server.
+
+.. option:: -v
+
+Print out the comparison when it detects an error from the server.
+
+.. option:: -t n
+
+Set the timeout from an IO operation to/from the server to \ *n*\ seconds.
+
+
+----
+HOME
+----
+
+
+To find out more information please check:
+`http://libmemcached.org/ <http://libmemcached.org/>`_
+
+
+------
+AUTHOR
+------
+
+
+Trond Norbye, <trond.norbye@gmail.com>
+
+
+--------
+SEE ALSO
+--------
+
+:manpage:`memcached(1)` :manpage:`libmemcached(3)`
+
--- /dev/null
+=================================
+memcat - "cat" data from a server
+=================================
+
+
+
+--------
+SYNOPSIS
+--------
+
+memcat [options] key
+
+Copy a set of keys to stdout
+
+
+.. program:: memcat
+
+
+-----------
+DESCRIPTION
+-----------
+
+
+:program:`memcat` outputs to stdout the value a single or multiple set of keys
+stored in a memcached(1) server. If any key is not found an error is returned.
+
+It is similar to the standard UNIX cat(1) utility.
+
+
+-------
+OPTIONS
+-------
+
+
+You can specify servers via the option:
+
+.. cmdoption:: --servers
+
+or via the environment variable:
+
+.. envvar:: `MEMCACHED_SERVERS`
+
+For a full list of operations run the tool with the option:
+
+.. cmdoption:: --help
+
+
+----
+HOME
+----
+
+
+To find out more information please check:
+`http://libmemcached.org/ <http://libmemcached.org/>`_
+
+
+------
+AUTHOR
+------
+
+
+Brian Aker, <brian@tangent.org>
+
+Mark Atwood <mark@fallenpegasus.com>
+
+
+--------
+SEE ALSO
+--------
+
+
+:manpage:`memcached(1)` :manpage:`libmemcached(3)`
+
--- /dev/null
+=============================
+memcp - Copy data to a server
+=============================
+
+
+Copies files to a collection of memcached servers
+
+
+--------
+SYNOPSIS
+--------
+
+memcp [options] [file] [server]
+
+.. program:: memcp
+
+
+-----------
+DESCRIPTION
+-----------
+
+
+:program:`memcp` copies one or more files into memcached(1) servers.
+It is similar to the standard UNIX cp(1) command.
+
+The key names will be the names of the files,
+without any directory path.
+
+
+-------
+OPTIONS
+-------
+
+
+You can specify servers via the option:
+
+.. option:: --servers
+
+or via the environment variable:
+
+.. envvar:: `MEMCACHED_SERVERS`
+
+If you do not specify either these, the final value in the command line list is the name of a server(s).
+
+For a full list of operations run the tool with the option:
+
+.. option:: --help
+
+
+----
+HOME
+----
+
+
+To find out more information please check:
+`http://libmemcached.org/ <http://libmemcached.org/>`_
+
+
+------
+AUTHOR
+------
+
+
+Brian Aker, <brian@tangent.org>
+
+Mark Atwood, <mark@fallenpegasus.com>
+
+
+--------
+SEE ALSO
+--------
+
+
+:manpage:`memcached(1)` :manpage:`libmemcached(3)`
+
--- /dev/null
+=============================
+memdump - Dumping your server
+=============================
+
+
+Dump a list of keys from a server.
+
+
+--------
+SYNOPSIS
+--------
+
+memdump [options]
+
+.. program:: memdump
+
+-----------
+DESCRIPTION
+-----------
+
+
+:program:`memdump` dumps a list of "keys" from all servers that
+it is told to fetch from. Because memcached does not guarentee to
+provide all keys it is not possible to get a complete "dump".
+
+
+-------
+OPTIONS
+-------
+
+
+For a full list of operations run the tool with option:
+
+.. option:: --help
+
+
+----
+HOME
+----
+
+
+To find out more information please check:
+`http://libmemcached.org/ <http://libmemcached.org/>`_
+
+
+------
+AUTHOR
+------
+
+
+Brian Aker, <brian@tangent.org>
+
+
+--------
+SEE ALSO
+--------
+
+:manpage:`memcached(1)` :manpage:`libmemcached(3)`
--- /dev/null
+==============================================
+memerror - translate an error code to a string
+==============================================
+
+
+Translates a memcached error code into a string
+
+
+--------
+SYNOPSIS
+--------
+
+memerror [options] [error code]
+
+.. program:: memerror
+
+-----------
+DESCRIPTION
+-----------
+
+
+:program:`memerror` translates an error code from libmemcached(3) into a human
+readable string.
+
+
+-------
+OPTIONS
+-------
+
+
+For a full list of operations run the tool with option:
+
+.. option:: --help
+
+
+----
+HOME
+----
+
+
+To find out more infoerroration please check:
+`http://libmemcached.org/ <http://libmemcached.org/>`_
+
+
+------
+AUTHOR
+------
+
+
+Brian Aker, <brian@tangent.org>
+
+
+--------
+SEE ALSO
+--------
+
+
+:manpage:`memcached(1)` :manpage:`libmemcached(3)`
--- /dev/null
+===========================================
+memexist - Check for the existance of a key
+===========================================
+
+
+--------
+SYNOPSIS
+--------
+
+memexist [options] [key]
+
+.. program:: memexist
+
+
+-----------
+DESCRIPTION
+-----------
+
+:program:`memexist` checks for the existance of a key within a cluster.
+
+
+-------
+OPTIONS
+-------
+
+
+You can specify servers via the option:
+
+.. option:: --servers
+
+or via the environment variable:
+
+.. envvar:: `MEMCACHED_SERVERS`
+
+If you do not specify either these, the final value in the command line list is the name of a server(s).
+
+For a full list of operations run the tool with the option:
+
+.. option:: --help
+
+
+----
+HOME
+----
+
+
+To find out more information please check:
+`http://libmemcached.org/ <http://libmemcached.org/>`_
+
+
+------
+AUTHOR
+------
+
+
+Brian Aker, <brian@tangent.org>
+
+--------
+SEE ALSO
+--------
+
+
+:manpage:`memcached(1)` :manpage:`libmemcached(3)`
+
--- /dev/null
+=======================================
+memflush - flush all data from a server
+=======================================
+
+
+Reset a server or list of servers
+
+
+--------
+SYNOPSIS
+--------
+
+memflush [options]
+
+.. program:: memflush
+
+-----------
+DESCRIPTION
+-----------
+
+
+:program:`memflush` resets the contents of memcached(1) servers.
+This means that all data in the specified servers will be deleted.
+
+
+-------
+OPTIONS
+-------
+
+
+You can specify servers via the option:
+
+.. option:: --servers
+
+or via the environment variable:
+
+.. envvar:: `MEMCACHED_SERVERS`
+
+For a full list of operations run the tool with option:
+
+.. option:: --help
+
+
+----
+HOME
+----
+
+
+To find out more information please check:
+`http://libmemcached.org/ <http://libmemcached.org/>`_
+
+
+------
+AUTHOR
+------
+
+
+Brian Aker, <brian@tangent.org>
+
+Mark Atwood <mark@fallenpegasus.com>
+
+
+--------
+SEE ALSO
+--------
+
+:manpage:`memcached(1)` :manpage:`libmemcached(3)`
--- /dev/null
+=================================
+memparse - Parse an option string
+=================================
+
+
+Copies files to a collection of memcached servers
+
+
+--------
+SYNOPSIS
+--------
+
+memparse [options] "option string"
+
+.. program:: memparse
+
+
+-----------
+DESCRIPTION
+-----------
+
+
+:program:`memparse` can be used to validate an option string.
+
+-------
+OPTIONS
+-------
+
+For a full list of operations run the tool with the option:
+
+.. option:: --help
+
+
+----
+HOME
+----
+
+
+To find out more information please check:
+`http://libmemcached.org/ <http://libmemcached.org/>`_
+
+
+------
+AUTHOR
+------
+
+
+Brian Aker, <brian@tangent.org>
+
+--------
+SEE ALSO
+--------
+
+
+:manpage:`memcached(1)` :manpage:`libmemcached(3)`
+
--- /dev/null
+===============================================
+memping - Test to see if a server is available.
+===============================================
+
+
+--------
+SYNOPSIS
+--------
+
+memping [options] [server]
+
+.. program:: memping
+
+
+-----------
+DESCRIPTION
+-----------
+
+
+:program:`memping` can be used to ping a memcached server to see if it is taking connections.
+
+-------
+OPTIONS
+-------
+
+
+You can specify servers via the option:
+
+.. option:: --servers
+
+or via the environment variable:
+
+.. envvar:: `MEMCACHED_SERVERS`
+
+If you do not specify either these, the final value in the command line list is the name of a server(s).
+
+For a full list of operations run the tool with the option:
+
+.. option:: --help
+
+
+----
+HOME
+----
+
+
+To find out more information please check:
+`http://libmemcached.org/ <http://libmemcached.org/>`_
+
+
+------
+AUTHOR
+------
+
+Brian Aker, <brian@tangent.org>
+
+--------
+SEE ALSO
+--------
+
+:manpage:`memcached(1)` :manpage:`libmemcached(3)`
--- /dev/null
+=================================
+memrm - Remove data from a server
+=================================
+
+
+memrm - Remove a key(s) from a collection of memcached servers
+
+
+--------
+SYNOPSIS
+--------
+
+memrm [options] [key]
+
+.. program:: memrm
+
+
+-----------
+DESCRIPTION
+-----------
+
+
+:program:`memrm` removes items, specified by key, from memcached(1) servers.
+
+
+-------
+OPTIONS
+-------
+
+
+You can specify servers via the option:
+
+.. option:: --servers
+
+or via the environment variable:
+
+.. envvar:: `MEMCACHED_SERVERS`
+
+For a full list of operations run the tool with the
+
+.. option:: --help
+
+
+
+
+----
+HOME
+----
+
+
+To find out more information please check:
+`http://libmemcached.org/ <http://libmemcached.org/>`_
+
+
+------
+AUTHOR
+------
+
+
+Brian Aker, <brian@tangent.org>
+
+Mark Atwood, <mark@fallenpegasus.com>
+
+
+--------
+SEE ALSO
+--------
+
+
+:manpage:`memcached(1)` :manpage:`libmemcached(3)`
+
--- /dev/null
+=================================================
+memslap - Load testing and benchmarking a server
+=================================================
+
+
+--------
+SYNOPSIS
+--------
+
+memslap [options]
+
+.. program:: memslap
+
+-----------
+DESCRIPTION
+-----------
+
+
+:program:`memslap` is a load generation and benchmark tool for memcached(1)
+servers. It generates configurable workload such as threads, concurrencies, connections, run time, overwrite, miss rate, key size, value size, get/set proportion, expected throughput, and so on.
+
+
+-------
+OPTIONS
+-------
+
+
+You can specify servers via the option:
+
+.. option:: --servers
+
+or via the environment variable:
+
+.. envvar:: `MEMCACHED_SERVERS`
+
+For a full list of operations run the tool with:
+
+.. option:: --help
+
+
+----
+HOME
+----
+
+
+To find out more information please check:
+'http://libmemcached.org/ <http://libmemcached.org/>'_
+
+
+------
+AUTHOR
+------
+
+
+Brian Aker, <brian@tangent.org>
+
+
+--------
+SEE ALSO
+--------
+
+
+:manpage:`memcached(1)` :manpage:`libmemcached(3)`
--- /dev/null
+=========================================
+memstat - Gather statistics from a server
+=========================================
+
+
+memstat - Display the operating status of a single or group of memcached servers
+
+
+--------
+SYNOPSIS
+--------
+
+memstat [options]
+
+.. program:: memstat
+
+-----------
+DESCRIPTION
+-----------
+
+
+:program:`memstat` dumps the state of memcached(1) servers.
+It displays all data to stdout.
+
+
+-------
+OPTIONS
+-------
+
+
+You can specify servers via the option:
+
+.. option:: --servers
+
+or via the environment variable:
+
+.. envvar:: 'MEMCACHED_SERVERS, --args'
+
+which can be used to specify the "argument" sent to the stats command (ie slab, size, items, etc..).
+
+For a full list of operations run the tool with:
+
+.. option:: --help
+
+.. option:: --analyze
+
+----
+HOME
+----
+
+
+To find out more information please check:
+`http://libmemcached.org/ <http://libmemcached.org/>`_
+
+
+--------
+SEE ALSO
+--------
+
+
+:manpage:`memcached(1)` :manpage:`libmemcached(3)`
+
--- /dev/null
+=========================
+memtouch - Touches a key.
+=========================
+
+
+--------
+SYNOPSIS
+--------
+
+memtouch [options] key
+
+.. program:: memtouch
+
+
+-----------
+DESCRIPTION
+-----------
+
+
+:program:`memtouch` does a "touch" on the specified key.
+
+-------
+OPTIONS
+-------
+
+
+You can specify servers via the option:
+
+.. option:: --servers
+
+or via the environment variable:
+
+.. envvar:: `MEMCACHED_SERVERS`
+
+If you do not specify either these, the final value in the command line list is the name of a server(s).
+
+For a full list of operations run the tool with the option:
+
+.. option:: --help
+
+
+----
+HOME
+----
+
+
+To find out more information please check:
+`http://libmemcached.org/ <http://libmemcached.org/>`_
+
+
+------
+AUTHOR
+------
+
+Brian Aker, <brian@tangent.org>
+
+--------
+SEE ALSO
+--------
+
+
+:manpage:`memcached(1)` :manpage:`libmemcached(3)`
+
--- /dev/null
+=======================
+MEMCACHED_AUTH_CONTINUE
+=======================
+
+.. c:type:: MEMCACHED_AUTH_CONTINUE
+
+Authentication has been paused.
--- /dev/null
+======================
+MEMCACHED_AUTH_FAILURE
+======================
+
+.. c:type:: MEMCACHED_AUTH_FAILURE
+
+The credentials provided are not valid for this server.
--- /dev/null
+======================
+MEMCACHED_AUTH_PROBLEM
+======================
+
+.. c:type:: MEMCACHED_AUTH_PROBLEM
+
+An unknown issue has occured during authentication.
--- /dev/null
+==========================
+MEMCACHED_BAD_KEY_PROVIDED
+==========================
+
+.. c:type:: MEMCACHED_BAD_KEY_PROVIDED
+
+The key provided is not a valid key.
--- /dev/null
+==================
+MEMCACHED_BUFFERED
+==================
+
+.. c:type:: MEMCACHED_BUFFERED
+
+The request has been buffered.
--- /dev/null
+======================
+MEMCACHED_CLIENT_ERROR
+======================
+
+.. c:type:: MEMCACHED_CLIENT_ERROR
+
+An unknown client error has occured internally.
--- /dev/null
+=================================
+MEMCACHED_CONNECTION_BIND_FAILURE
+=================================
+
+.. c:type:: MEMCACHED_CONNECTION_BIND_FAILURE
+.. deprecated:: <0.30
+
+We were not able to bind() to the socket.
--- /dev/null
+============================
+MEMCACHED_CONNECTION_FAILURE
+============================
+
+.. c:type:: MEMCACHED_CONNECTION_FAILURE
+
+A unknown error has occured while trying to connect to a server.
--- /dev/null
+==========================================
+MEMCACHED_CONNECTION_SOCKET_CREATE_FAILURE
+==========================================
+
+.. c:type:: MEMCACHED_CONNECTION_SOCKET_CREATE_FAILURE
+.. deprecated:: <0.30
+
+An error has occurred while trying to connect to a server. It is likely that either the number of file descriptors need to be increased or you are out of memory.
--- /dev/null
+=============================
+MEMCACHED_DATA_DOES_NOT_EXIST
+=============================
+
+.. c:type:: MEMCACHED_DATA_DOES_NOT_EXIST
+
+The data requested with the key given was not found.
--- /dev/null
+=====================
+MEMCACHED_DATA_EXISTS
+=====================
+
+.. c:type:: MEMCACHED_DATA_EXISTS
+
+The data requested with the key given was not found.
--- /dev/null
+=================
+MEMCACHED_DELETED
+=================
+
+.. c:type:: MEMCACHED_DELETED
+
+The object requested by the key has been deleted.
--- /dev/null
+====================
+MEMCACHED_DEPRECATED
+====================
+
+.. c:type:: MEMCACHED_DEPRECATED
+
+The method that was requested has been deprecated.
--- /dev/null
+===============
+MEMCACHED_E2BIG
+===============
+
+.. c:type:: MEMCACHED_E2BIG
+
+Item is too large for the server to store.
--- /dev/null
+=============
+MEMCACHED_END
+=============
+
+.. c:type:: MEMCACHED_END
+
+The server has completed returning all of the objects requested.
--- /dev/null
+===============
+MEMCACHED_ERRNO
+===============
+
+.. c:type:: MEMCACHED_ERRNO
+
+An error has occurred in the driver which has set errno.
--- /dev/null
+=================
+MEMCACHED_FAILURE
+=================
+
+.. c:type:: MEMCACHED_FAILURE
+.. deprecated:: <0.30
+
+A unknown failure has occurred in the server.
--- /dev/null
+==========================
+MEMCACHED_FAIL_UNIX_SOCKET
+==========================
+
+.. c:type:: MEMCACHED_FAIL_UNIX_SOCKET
+
+A connection was not established with the server via a unix domain socket.
--- /dev/null
+===========================
+MEMCACHED_FETCH_NOTFINISHED
+===========================
+
+.. c:type:: MEMCACHED_FETCH_NOTFINISHED
+
+A request has been made, but the server has not finished the fetch of the last request.
--- /dev/null
+=============================
+MEMCACHED_HOST_LOOKUP_FAILURE
+=============================
+
+.. c:type:: MEMCACHED_HOST_LOOKUP_FAILURE
+
+A DNS failure has occurred.
--- /dev/null
+===========================
+MEMCACHED_INVALID_ARGUMENTS
+===========================
+
+.. c:type:: MEMCACHED_INVALID_ARGUMENTS
+
+The arguments supplied to the given function were not valid.
--- /dev/null
+===============================
+MEMCACHED_INVALID_HOST_PROTOCOL
+===============================
+
+.. c:type:: MEMCACHED_INVALID_HOST_PROTOCOL
+
+The server you are connecting too has an invalid protocol. Most likely you are connecting to an older server that does not speak the binary protocol.
--- /dev/null
+==============
+MEMCACHED_ITEM
+==============
+
+.. c:type:: MEMCACHED_ITEM
+
+An item has been fetched (this is an internal error only).
--- /dev/null
+=====================
+MEMCACHED_KEY_TOO_BIG
+=====================
+
+.. c:type:: MEMCACHED_KEY_TOO_BIG
+
+The key that has been provided is too large for the given server.
--- /dev/null
+========================
+MEMCACHED_MAXIMUM_RETURN
+========================
+
+.. c:type:: MEMCACHED_MAXIMUM_RETURN
+
+This in an internal only state.
--- /dev/null
+===================================
+MEMCACHED_MEMORY_ALLOCATION_FAILURE
+===================================
+
+.. c:type:: MEMCACHED_MEMORY_ALLOCATION_FAILURE
+
+An error has occurred while trying to allocate memory.
--- /dev/null
+==================
+MEMCACHED_NOTFOUND
+==================
+
+.. c:type:: MEMCACHED_NOTFOUND
+
+The object requested was not found.
--- /dev/null
+===================
+MEMCACHED_NOTSTORED
+===================
+
+.. c:type:: MEMCACHED_NOTSTORED
+
+The request to store an object failed.
--- /dev/null
+=======================
+MEMCACHED_NOT_SUPPORTED
+=======================
+
+.. c:type:: MEMCACHED_NOT_SUPPORTED
+
+The given method is not supported in the server.
--- /dev/null
+=========================
+MEMCACHED_NO_KEY_PROVIDED
+=========================
+
+.. c:type:: MEMCACHED_NO_KEY_PROVIDED
+.. deprecated:: <0.30
+ Use :c:type:`MEMCACHED_BAD_KEY_PROVIDED` instead.
+
+No key was provided.
--- /dev/null
+====================
+MEMCACHED_NO_SERVERS
+====================
+
+.. c:type:: MEMCACHED_NO_SERVERS
+
+No servers have been added to the memcached_st object.
--- /dev/null
+=====================
+MEMCACHED_PARSE_ERROR
+=====================
+
+.. c:type:: MEMCACHED_PARSE_ERROR
+
+An error has occurred while trying to parse the configuration string. You should use memparse to determine what the error was.
--- /dev/null
+==========================
+MEMCACHED_PARSE_USER_ERROR
+==========================
+
+.. c:type:: MEMCACHED_PARSE_USER_ERROR
+
+An error has occurred in parsing the configuration string.
--- /dev/null
+======================
+MEMCACHED_PARTIAL_READ
+======================
+
+.. c:type:: MEMCACHED_PARTIAL_READ
+
+The read was only partcially successful.
--- /dev/null
+========================
+MEMCACHED_PROTOCOL_ERROR
+========================
+
+.. c:type:: MEMCACHED_PROTOCOL_ERROR
+
+An unknown error has occurred in the protocol.
--- /dev/null
+======================
+MEMCACHED_READ_FAILURE
+======================
+
+.. c:type:: MEMCACHED_READ_FAILURE
+
+A read failure has occurred.
--- /dev/null
+======================
+MEMCACHED_SERVER_ERROR
+======================
+
+.. c:type:: MEMCACHED_SERVER_ERROR
+
+An unknown error has occurred in the server.
--- /dev/null
+============================
+MEMCACHED_SERVER_MARKED_DEAD
+============================
+
+.. c:type:: MEMCACHED_SERVER_MARKED_DEAD
+
+The requested server has been marked dead.
--- /dev/null
+=====================
+MEMCACHED_SOME_ERRORS
+=====================
+
+.. c:type:: MEMCACHED_SOME_ERRORS
+
+A multi request has been made, and some underterminate number of errors have occurred.
--- /dev/null
+==============
+MEMCACHED_STAT
+==============
+
+.. c:type:: MEMCACHED_STAT
+
+A "stat" command has been returned in the protocol.
--- /dev/null
+================
+MEMCACHED_STORED
+================
+
+.. c:type:: MEMCACHED_STORED
+
+The requested object has been successfully stored on the server.
--- /dev/null
+=================
+MEMCACHED_SUCCESS
+=================
+
+.. c:type:: MEMCACHED_SUCCESS
+
+The request was successfully executed.
--- /dev/null
+=================
+MEMCACHED_TIMEOUT
+=================
+
+.. c:type:: MEMCACHED_TIMEOUT
+
+Operation has timed out.
--- /dev/null
+==============================
+MEMCACHED_UNKNOWN_READ_FAILURE
+==============================
+
+.. c:type:: MEMCACHED_UNKNOWN_READ_FAILURE
+
+An unknown read failure only occurs when either there is a bug in the server, or in rare cases where an ethernet nic is reporting dubious information.
--- /dev/null
+==========================
+MEMCACHED_UNKNOWN_STAT_KEY
+==========================
+
+.. c:type:: MEMCACHED_UNKNOWN_STAT_KEY
+
+The server you are communicating with has a stat key which has not be defined in the protocol.
--- /dev/null
+===============
+MEMCACHED_VALUE
+===============
+
+.. c:type:: MEMCACHED_VALUE
+
+A value has been returned from the server (this is an internal condition only).
--- /dev/null
+=======================
+MEMCACHED_WRITE_FAILURE
+=======================
+
+.. c:type:: MEMCACHED_WRITE_FAILURE
+
+An error has occured while trying to write to a server.
--- /dev/null
+# -*- coding: utf-8 -*-
+#
+# libmemcached documentation build configuration file, created by
+# sphinx-quickstart on Sun Mar 6 12:05:53 2011.
+#
+# This file is execfile()d with the current directory set to its containing dir.
+#
+# Note that not all possible configuration values are present in this
+# autogenerated file.
+#
+# All configuration values have a default; values that are commented out
+# serve to show the default.
+
+import sys, os
+
+# If extensions (or modules to document with autodoc) are in another directory,
+# add these directories to sys.path here. If the directory is relative to the
+# documentation root, use os.path.abspath to make it absolute, like shown here.
+#sys.path.insert(0, os.path.abspath('.'))
+
+# -- General configuration -----------------------------------------------------
+
+# If your documentation needs a minimal Sphinx version, state it here.
+#needs_sphinx = '1.0'
+
+# Add any Sphinx extension module names here, as strings. They can be extensions
+# coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
+extensions = []
+
+#extensions = ['sphinxcontrib.googleanalytics']
+
+# Google
+#googleanalytics_id = 'UA-15307604-2'
+#googleanalytics_enabled = 'True'
+
+# Add any paths that contain templates here, relative to this directory.
+templates_path = ['_templates']
+
+# The suffix of source filenames.
+source_suffix = '.rst'
+
+# The encoding of source files.
+#source_encoding = 'utf-8-sig'
+
+# The master toctree document.
+master_doc = 'index'
+
+# General information about the project.
+project = u'libmemcached'
+copyright = u'2011-2013, 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
+# built documents.
+#
+# The short X.Y version.
+version = '@VERSION@'
+# The full version, including alpha/beta/rc tags.
+release = '@VERSION@'
+
+# The language for content autogenerated by Sphinx. Refer to documentation
+# for a list of supported languages.
+#language = None
+
+# There are two options for replacing |today|: either, you set today to some
+# non-false value, then it is used:
+#today = ''
+# Else, today_fmt is used as the format for a strftime call.
+#today_fmt = '%B %d, %Y'
+
+# List of patterns, relative to source directory, that match files and
+# directories to ignore when looking for source files.
+exclude_patterns = ['_build']
+
+# The reST default role (used for this markup: `text`) to use for all documents.
+#default_role = None
+
+# If true, '()' will be appended to :func: etc. cross-reference text.
+#add_function_parentheses = True
+
+# If true, the current module name will be prepended to all description
+# unit titles (such as .. function::).
+#add_module_names = True
+
+# If true, sectionauthor and moduleauthor directives will be shown in the
+# output. They are ignored by default.
+#show_authors = False
+
+# The name of the Pygments (syntax highlighting) style to use.
+pygments_style = 'sphinx'
+
+# A list of ignored prefixes for module index sorting.
+#modindex_common_prefix = []
+
+
+# -- Options for HTML output ---------------------------------------------------
+
+# The theme to use for HTML and HTML Help pages. See the documentation for
+# a list of builtin themes.
+html_theme = 'default'
+
+# Theme options are theme-specific and customize the look and feel of a theme
+# further. For a list of options available for each theme, see the
+# documentation.
+#html_theme_options = {}
+
+# Add any paths that contain custom themes here, relative to this directory.
+#html_theme_path = []
+
+# The name for this set of Sphinx documents. If None, it defaults to
+# "<project> v<release> documentation".
+#html_title = None
+
+# A shorter title for the navigation bar. Default is the same as html_title.
+#html_short_title = None
+
+# The name of an image file (relative to this directory) to place at the top
+# of the sidebar.
+#html_logo = None
+
+# The name of an image file (within the static path) to use as favicon of the
+# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
+# pixels large.
+#html_favicon = None
+
+# Add any paths that contain custom static files (such as style sheets) here,
+# relative to this directory. They are copied after the builtin static files,
+# so a file named "default.css" will overwrite the builtin "default.css".
+html_static_path = ['_static']
+
+# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
+# using the given strftime format.
+#html_last_updated_fmt = '%b %d, %Y'
+
+# If true, SmartyPants will be used to convert quotes and dashes to
+# typographically correct entities.
+#html_use_smartypants = True
+
+# Custom sidebar templates, maps document names to template names.
+#html_sidebars = {}
+
+# Additional templates that should be rendered to pages, maps page names to
+# template names.
+#html_additional_pages = {}
+
+# If false, no module index is generated.
+#html_domain_indices = True
+
+# If false, no index is generated.
+#html_use_index = True
+
+# If true, the index is split into individual pages for each letter.
+#html_split_index = False
+
+# If true, links to the reST sources are added to the pages.
+html_show_sourcelink = False
+
+# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
+#html_show_sphinx = True
+
+# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
+#html_show_copyright = True
+
+# If true, an OpenSearch description file will be output, and all pages will
+# contain a <link> tag referring to it. The value of this option must be the
+# base URL from which the finished HTML is served.
+#html_use_opensearch = ''
+
+# This is the file name suffix for HTML files (e.g. ".xhtml").
+#html_file_suffix = None
+
+# Output file base name for HTML help builder.
+htmlhelp_basename = 'libmemcacheddoc'
+
+
+# -- Options for LaTeX output --------------------------------------------------
+
+# The paper size ('letter' or 'a4').
+#latex_paper_size = 'letter'
+
+# The font size ('10pt', '11pt' or '12pt').
+#latex_font_size = '10pt'
+
+# Grouping the document tree into LaTeX files. List of tuples
+# (source start file, target name, title, author, documentclass [howto/manual]).
+latex_documents = [
+ ('index', 'libmemcached.tex', u'libmemcached Documentation',
+ u'Brian Aker', 'manual'),
+]
+
+# The name of an image file (relative to this directory) to place at the top of
+# the title page.
+#latex_logo = None
+
+# For "manual" documents, if this is true, then toplevel headings are parts,
+# not chapters.
+#latex_use_parts = False
+
+# If true, show page references after internal links.
+#latex_show_pagerefs = False
+
+# If true, show URL addresses after external links.
+#latex_show_urls = False
+
+# Additional stuff for the LaTeX preamble.
+#latex_preamble = ''
+
+# Documents to append as an appendix to all manuals.
+#latex_appendices = []
+
+# If false, no module index is generated.
+#latex_domain_indices = True
+
+
+# -- Options for manual page output --------------------------------------------
+
+# One entry per manual page. List of tuples
+# (source start file, name, description, authors, manual section).
+man_pages = [
+ ('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),
+ ('hashkit_create', 'hashkit_is_allocated', u'libhashkit Documentation', [u'Brian Aker'], 3),
+ ('hashkit_functions', 'hashkit_crc32', u'libhashkit Documentation', [u'Brian Aker'], 3),
+ ('hashkit_functions', 'hashkit_fnv1_32', u'libhashkit Documentation', [u'Brian Aker'], 3),
+ ('hashkit_functions', 'hashkit_fnv1_64', u'libhashkit Documentation', [u'Brian Aker'], 3),
+ ('hashkit_functions', 'hashkit_fnv1a_32', u'libhashkit Documentation', [u'Brian Aker'], 3),
+ ('hashkit_functions', 'hashkit_fnv1a_64', u'libhashkit Documentation', [u'Brian Aker'], 3),
+ ('hashkit_functions', 'hashkit_functions', u'libhashkit Documentation', [u'Brian Aker'], 3),
+ ('hashkit_functions', 'hashkit_hsieh', u'libhashkit Documentation', [u'Brian Aker'], 3),
+ ('hashkit_functions', 'hashkit_jenkins', u'libhashkit Documentation', [u'Brian Aker'], 3),
+ ('hashkit_functions', 'hashkit_md5', u'libhashkit Documentation', [u'Brian Aker'], 3),
+ ('hashkit_functions', 'hashkit_murmur', u'libhashkit Documentation', [u'Brian Aker'], 3),
+ ('hashkit_value', 'hashkit_value', u'libhashkit Documentation', [u'Brian Aker'], 3),
+ ('libhashkit', 'libhashkit', u'libhashkit Documentation', [u'Brian Aker'], 3),
+ ('libmemcached', 'libmemcached', u'Introducing the C Client Library for memcached', [u'Brian Aker'], 3),
+ ('libmemcached_configuration', 'libmemcached_check_configuration', u'libmemcached Documentation', [u'Brian Aker'], 3),
+ ('libmemcached_configuration', 'libmemcached_configuration', u'libmemcached Documentation', [u'Brian Aker'], 3),
+ ('libmemcached_configuration', 'memcached', u'libmemcached Documentation', [u'Brian Aker'], 3),
+ ('libmemcached_examples', 'libmemcached_examples', u'libmemcached Documentation', [u'Brian Aker'], 3),
+ ('libmemcachedutil', 'libmemcachedutil', u'libmemcached Documentation', [u'Brian Aker'], 3),
+ ('memcached_analyze', 'memcached_analyze', u'libmemcached Documentation', [u'Brian Aker'], 3),
+ ('memcached_append', 'memcached_append', u'Appending to or Prepending to data on the server', [u'Brian Aker'], 3),
+ ('memcached_append', 'memcached_append_by_key', u'Appending to or Prepending to data on the server', [u'Brian Aker'], 3),
+ ('memcached_append', 'memcached_prepend', u'Appending to or Prepending to data on the server', [u'Brian Aker'], 3),
+ ('memcached_append', 'memcached_prepend_by_key', u'Appending to or Prepending to data on the server', [u'Brian Aker'], 3),
+ ('memcached_auto', 'memcached_auto', u'Incrementing and Decrementing Values', [u'Brian Aker'], 3),
+ ('memcached_auto', 'memcached_decrement', u'Incrementing and Decrementing Values', [u'Brian Aker'], 3),
+ ('memcached_auto', 'memcached_decrement_with_initial', u'Incrementing and Decrementing Values', [u'Brian Aker'], 3),
+ ('memcached_auto', 'memcached_increment', u'Incrementing and Decrementing Values', [u'Brian Aker'], 3),
+ ('memcached_auto', 'memcached_increment_with_initial', u'Incrementing and Decrementing Values', [u'Brian Aker'], 3),
+ ('memcached_behavior', 'memcached_behavior', u'libmemcached Documentation', [u'Brian Aker'], 3),
+ ('memcached_behavior', 'memcached_behavior_get', u'libmemcached Documentation', [u'Brian Aker'], 3),
+ ('memcached_behavior', 'memcached_behavior_set', u'libmemcached Documentation', [u'Brian Aker'], 3),
+ ('memcached_callback', 'memcached_callback', u'libmemcached Documentation', [u'Brian Aker'], 3),
+ ('memcached_callback', 'memcached_callback_get', u'libmemcached Documentation', [u'Brian Aker'], 3),
+ ('memcached_callback', 'memcached_callback_set', u'libmemcached Documentation', [u'Brian Aker'], 3),
+ ('memcached_cas', 'memcached_cas', u'Working with data on the server in an atomic fashion', [u'Brian Aker'], 3),
+ ('memcached_cas', 'memcached_cas_by_key', u'Storing and Replacing Data', [u'Brian Aker'], 3),
+ ('memcached_create', 'memcached_clone', u'libmemcached Documentation', [u'Brian Aker'], 3),
+ ('memcached_create', 'memcached_create', u'libmemcached Documentation', [u'Brian Aker'], 3),
+ ('memcached_create', 'memcached_free', u'libmemcached Documentation', [u'Brian Aker'], 3),
+ ('memcached_create', 'memcached_servers_reset', u'libmemcached Documentation', [u'Brian Aker'], 3),
+ ('memcached_delete', 'memcached_delete', u'libmemcached Documentation', [u'Brian Aker'], 3),
+ ('memcached_delete', 'memcached_delete_by_key', u'libmemcached Documentation', [u'Brian Aker'], 3),
+ ('libmemcached-1.0/memcached_touch', 'memcached_touch', u'libmemcached Documentation', [u'Brian Aker'], 3),
+ ('libmemcached-1.0/memcached_touch', 'memcached_touch_by_key', u'libmemcached Documentation', [u'Brian Aker'], 3),
+ ('libmemcached/memcached_exist', 'memcached_exist', u'libmemcached Documentation', [u'Brian Aker'], 3),
+ ('libmemcached/memcached_exist', 'memcached_exist_by_key', u'libmemcached Documentation', [u'Brian Aker'], 3),
+ ('memcached_dump', 'memcached_dump', u'libmemcached Documentation', [u'Brian Aker'], 3),
+ ('memcached_flush', 'memcached_flush', u'libmemcached Documentation', [u'Brian Aker'], 3),
+ ('memcached_flush_buffers', 'memcached_flush_buffers', u'libmemcached Documentation', [u'Brian Aker'], 3),
+ ('memcached_generate_hash_value', 'memcached_generate_hash', u'Generating hash values directly', [u'Brian Aker'], 3),
+ ('memcached_generate_hash_value', 'memcached_generate_hash_value', u'Generating hash values directly', [u'Brian Aker'], 3),
+ ('libmemcached/memcached_fetch', 'memcached_fetch', u'Retrieving data from the server', [u'Brian Aker'], 3),
+ ('memcached_get', 'memcached_fetch_execute', u'Retrieving data from the server', [u'Brian Aker'], 3),
+ ('memcached_get', 'memcached_fetch_result', u'Retrieving data from the server', [u'Brian Aker'], 3),
+ ('memcached_get', 'memcached_get', u'Retrieving data from the server', [u'Brian Aker'], 3),
+ ('memcached_get', 'memcached_get_by_key', u'Retrieving data from the server', [u'Brian Aker'], 3),
+ ('libmemcached/memcached_return_t', 'memcached_return_t', u'Return type values ', [u'Brian Aker'], 3),
+ ('memcached_get', 'memcached_mget', u'Retrieving data from the server', [u'Brian Aker'], 3),
+ ('memcached_get', 'memcached_mget_by_key', u'Retrieving data from the server', [u'Brian Aker'], 3),
+ ('memcached_get', 'memcached_mget_execute', u'Retrieving data from the server', [u'Brian Aker'], 3),
+ ('memcached_get', 'memcached_mget_execute_by_key', u'Retrieving data from the server', [u'Brian Aker'], 3),
+ ('libmemcached/memcached_last_error_message', 'memcached_last_error_message', u'libmemcached Documentation', [u'Brian Aker'], 3),
+ ('memcached_memory_allocators', 'memcached_get_memory_allocators', u'libmemcached Documentation', [u'Brian Aker'], 3),
+ ('memcached_memory_allocators', 'memcached_memory_allocators', u'libmemcached Documentation', [u'Brian Aker'], 3),
+ ('memcached_memory_allocators', 'memcached_set_memory_allocators', u'libmemcached Documentation', [u'Brian Aker'], 3),
+ ('memcached_memory_allocators', 'memcached_set_memory_allocators_context', u'libmemcached Documentation', [u'Brian Aker'], 3),
+ ('memcached_pool', 'memcached_pool', u'libmemcached Documentation', [u'Brian Aker'], 3),
+ ('memcached_pool', 'memcached_pool_behavior_get', u'libmemcached Documentation', [u'Brian Aker'], 3),
+ ('memcached_pool', 'memcached_pool_behavior_set', u'libmemcached Documentation', [u'Brian Aker'], 3),
+ ('memcached_pool', 'memcached_pool_create', u'libmemcached Documentation', [u'Brian Aker'], 3),
+ ('memcached_pool', 'memcached_pool_destroy', u'libmemcached Documentation', [u'Brian Aker'], 3),
+ ('memcached_pool', 'memcached_pool_fetch', u'libmemcached Documentation', [u'Brian Aker'], 3),
+ ('memcached_pool', 'memcached_pool_pop', u'libmemcached Documentation', [u'Brian Aker'], 3),
+ ('memcached_pool', 'memcached_pool_push', u'libmemcached Documentation', [u'Brian Aker'], 3),
+ ('memcached_pool', 'memcached_pool_release', u'libmemcached Documentation', [u'Brian Aker'], 3),
+ ('memcached_pool', 'memcached_pool_st', u'libmemcached Documentation', [u'Brian Aker'], 3),
+ ('memcached_quit', 'memcached_quit', u'libmemcached Documentation', [u'Brian Aker'], 3),
+ ('libmemcached-1.0/memcached_set_encoding_key', 'memcached_set_encoding_key', u'libmemcached Documentation', [u'Brian Aker'], 3),
+ ('memcached_result_st', 'memcached_result_cas', u'Working with result sets', [u'Brian Aker'], 3),
+ ('memcached_result_st', 'memcached_result_create', u'Working with result sets', [u'Brian Aker'], 3),
+ ('memcached_result_st', 'memcached_result_flags', u'Working with result sets', [u'Brian Aker'], 3),
+ ('memcached_result_st', 'memcached_result_free', u'Working with result sets', [u'Brian Aker'], 3),
+ ('memcached_result_st', 'memcached_result_key_length', u'Working with result sets', [u'Brian Aker'], 3),
+ ('memcached_result_st', 'memcached_result_key_value', u'Working with result sets', [u'Brian Aker'], 3),
+ ('memcached_result_st', 'memcached_result_length', u'Working with result sets', [u'Brian Aker'], 3),
+ ('memcached_result_st', 'memcached_result_st', u'Working with result sets', [u'Brian Aker'], 3),
+ ('memcached_result_st', 'memcached_result_value', u'Working with result sets', [u'Brian Aker'], 3),
+ ('memcached_sasl', 'memcached_destroy_sasl_auth_data', u'libmemcached Documentation', [u'Brian Aker'], 3),
+ ('memcached_sasl', 'memcached_get_sasl_callbacks', u'libmemcached Documentation', [u'Brian Aker'], 3),
+ ('memcached_sasl', 'memcached_sasl', u'libmemcached Documentation', [u'Brian Aker'], 3),
+ ('memcached_sasl', 'memcached_sasl_set_auth_data', u'libmemcached Documentation', [u'Brian Aker'], 3),
+ ('memcached_sasl', 'memcached_set_sasl_callbacks', u'libmemcached Documentation', [u'Brian Aker'], 3),
+ ('memcached_server_st', 'memcached_server_list_append', u'libmemcached Documentation', [u'Brian Aker'], 3),
+ ('memcached_server_st', 'memcached_server_list_count', u'libmemcached Documentation', [u'Brian Aker'], 3),
+ ('memcached_server_st', 'memcached_server_list_free', u'libmemcached Documentation', [u'Brian Aker'], 3),
+ ('memcached_server_st', 'memcached_servers_parse', u'libmemcached Documentation', [u'Brian Aker'], 3),
+ ('memcached_servers', 'memcached_server_add', u'libmemcached Documentation', [u'Brian Aker'], 3),
+ ('memcached_servers', 'memcached_server_add_unix_socket', u'libmemcached Documentation', [u'Brian Aker'], 3),
+ ('memcached_servers', 'memcached_server_count', u'libmemcached Documentation', [u'Brian Aker'], 3),
+ ('memcached_servers', 'memcached_server_cursor', u'libmemcached Documentation', [u'Brian Aker'], 3),
+ ('memcached_servers', 'memcached_server_list', u'libmemcached Documentation', [u'Brian Aker'], 3),
+ ('memcached_servers', 'memcached_server_push', u'libmemcached Documentation', [u'Brian Aker'], 3),
+ ('memcached_servers', 'memcached_server_st', u'libmemcached Documentation', [u'Brian Aker'], 3),
+ ('memcached_servers', 'memcached_servers', u'libmemcached Documentation', [u'Brian Aker'], 3),
+ ('memcached_set', 'memcached_add', u'Storing and Replacing Data', [u'Brian Aker'], 3),
+ ('memcached_set', 'memcached_add_by_key', u'Storing and Replacing Data', [u'Brian Aker'], 3),
+ ('memcached_set', 'memcached_replace', u'Storing and Replacing Data', [u'Brian Aker'], 3),
+ ('memcached_set', 'memcached_replace_by_key', u'Storing and Replacing Data', [u'Brian Aker'], 3),
+ ('memcached_set', 'memcached_set', u'Storing and Replacing Data', [u'Brian Aker'], 3),
+ ('memcached_set', 'memcached_set_by_key', u'Storing and Replacing Data', [u'Brian Aker'], 3),
+ ('memcached_stats', 'memcached_stat', u'libmemcached Documentation', [u'Brian Aker'], 3),
+ ('memcached_stats', 'memcached_stat_execute', u'libmemcached Documentation', [u'Brian Aker'], 3),
+ ('memcached_stats', 'memcached_stat_get_keys', u'libmemcached Documentation', [u'Brian Aker'], 3),
+ ('memcached_stats', 'memcached_stat_get_value', u'libmemcached Documentation', [u'Brian Aker'], 3),
+ ('memcached_stats', 'memcached_stat_servername', u'libmemcached Documentation', [u'Brian Aker'], 3),
+ ('memcached_stats', 'memcached_stats', u'libmemcached Documentation', [u'Brian Aker'], 3),
+ ('memcached_strerror', 'memcached_strerror', u'libmemcached Documentation', [u'Brian Aker'], 3),
+ ('memcached_user_data', 'memcached_get_user_data', u'libmemcached Documentation', [u'Brian Aker'], 3),
+ ('memcached_user_data', 'memcached_set_user_data', u'libmemcached Documentation', [u'Brian Aker'], 3),
+ ('memcached_user_data', 'memcached_user_data', u'libmemcached Documentation', [u'Brian Aker'], 3),
+ ('memcached_verbosity', 'memcached_verbosity', u'libmemcached Documentation', [u'Brian Aker'], 3),
+ ('memcached_version', 'memcached_lib_version', u'libmemcached Documentation', [u'Brian Aker'], 3),
+ ('memcached_version', 'memcached_version', u'libmemcached Documentation', [u'Brian Aker'], 3),
+ ('bin/memcapable', 'memcapable', u'libmemcached Documentation', [u'Brian Aker'], 1),
+ ('bin/memcat', 'memcat', u'libmemcached Documentation', [u'Brian Aker'], 1),
+ ('bin/memcp', 'memcp', u'libmemcached Documentation', [u'Brian Aker'], 1),
+ ('bin/memdump', 'memdump', u'libmemcached Documentation', [u'Brian Aker'], 1),
+ ('bin/memerror', 'memerror', u'libmemcached Documentation', [u'Brian Aker'], 1),
+ ('bin/memflush', 'memflush', u'libmemcached Documentation', [u'Brian Aker'], 1),
+ ('bin/memrm', 'memrm', u'libmemcached Documentation', [u'Brian Aker'], 1),
+ ('bin/memaslap', 'memaslap', u'libmemcached Documentation', [u'Brian Aker'], 1),
+ ('bin/memslap', 'memslap', u'libmemcached Documentation', [u'Brian Aker'], 1),
+ ('bin/memstat', 'memstat', u'libmemcached Documentation', [u'Brian Aker'], 1),
+ ('bin/memexist', 'memexist', u'libmemcached Documentation', [u'Brian Aker'], 1),
+ ('bin/memparse', 'memparse', u'libmemcached Documentation', [u'Brian Aker'], 1),
+ ('bin/memping', 'memping', u'libmemcached Documentation', [u'Brian Aker'], 1),
+ ('bin/memtouch', 'memtouch', u'libmemcached Documentation', [u'Brian Aker'], 1),
+ ]
--- /dev/null
+=====================
+Client Error messages
+=====================
+
+.. toctree::
+ :maxdepth: 1
+
+ client_errors/MEMCACHED_AUTH_CONTINUE
+ client_errors/MEMCACHED_AUTH_FAILURE
+ client_errors/MEMCACHED_AUTH_PROBLEM
+ client_errors/MEMCACHED_BAD_KEY_PROVIDED
+ client_errors/MEMCACHED_BUFFERED
+ client_errors/MEMCACHED_CLIENT_ERROR
+ client_errors/MEMCACHED_CONNECTION_BIND_FAILURE
+ client_errors/MEMCACHED_CONNECTION_FAILURE
+ client_errors/MEMCACHED_CONNECTION_SOCKET_CREATE_FAILURE
+ client_errors/MEMCACHED_DATA_DOES_NOT_EXIST
+ client_errors/MEMCACHED_DATA_EXISTS
+ client_errors/MEMCACHED_DELETED
+ client_errors/MEMCACHED_DEPRECATED
+ client_errors/MEMCACHED_E2BIG
+ client_errors/MEMCACHED_END
+ client_errors/MEMCACHED_ERRNO
+ client_errors/MEMCACHED_FAILURE
+ client_errors/MEMCACHED_FAIL_UNIX_SOCKET
+ client_errors/MEMCACHED_FETCH_NOTFINISHED
+ client_errors/MEMCACHED_HOST_LOOKUP_FAILURE
+ client_errors/MEMCACHED_INVALID_ARGUMENTS
+ client_errors/MEMCACHED_INVALID_HOST_PROTOCOL
+ client_errors/MEMCACHED_ITEM
+ client_errors/MEMCACHED_KEY_TOO_BIG
+ client_errors/MEMCACHED_MAXIMUM_RETURN
+ client_errors/MEMCACHED_MEMORY_ALLOCATION_FAILURE
+ client_errors/MEMCACHED_NOTFOUND
+ client_errors/MEMCACHED_NOTSTORED
+ client_errors/MEMCACHED_NOT_SUPPORTED
+ client_errors/MEMCACHED_NO_KEY_PROVIDED
+ client_errors/MEMCACHED_NO_SERVERS
+ client_errors/MEMCACHED_PARSE_ERROR
+ client_errors/MEMCACHED_PARSE_USER_ERROR
+ client_errors/MEMCACHED_PARTIAL_READ
+ client_errors/MEMCACHED_PROTOCOL_ERROR
+ client_errors/MEMCACHED_READ_FAILURE
+ client_errors/MEMCACHED_SERVER_ERROR
+ client_errors/MEMCACHED_SERVER_MARKED_DEAD
+ client_errors/MEMCACHED_SOME_ERRORS
+ client_errors/MEMCACHED_STAT
+ client_errors/MEMCACHED_STORED
+ client_errors/MEMCACHED_SUCCESS
+ client_errors/MEMCACHED_TIMEOUT
+ client_errors/MEMCACHED_UNKNOWN_READ_FAILURE
+ client_errors/MEMCACHED_UNKNOWN_STAT_KEY
+ client_errors/MEMCACHED_VALUE
+ client_errors/MEMCACHED_WRITE_FAILURE
+
--- /dev/null
+============================
+Creating a hashkit structure
+============================
+
+.. highlightlang:: c
+
+.. index:: object: hashkit_st
+
+--------
+SYNOPSIS
+--------
+
+#include <libhashkit/hashkit.h>
+
+.. c:type:: hashkit_st
+
+.. c:function:: hashkit_st *hashkit_create(hashkit_st *hash)
+
+.. c:function:: hashkit_st *hashkit_clone(hashkit_st *destination, const hashkit_st *ptr)
+
+.. c:function:: void hashkit_free(hashkit_st *hash)
+
+.. c:function:: bool hashkit_is_allocated(const hashkit_st *hash)
+
+Compile and link with -lhashkit
+
+-----------
+DESCRIPTION
+-----------
+
+
+The :c:func:`hashkit_create` function initializes a hashkit object for use. If
+you pass a NULL argument for hash, then the memory for the object is
+allocated. If you specify a pre-allocated piece of memory, that is
+initialized for use.
+
+The :c:func:`hashkit_clone` function initializes a hashkit object much like
+:c:func:`hashkit_create`, but instead of using default settings it will use
+the settings of the ptr hashkit object.
+
+The :c:func:`hashkit_free` frees any resources being consumed by the hashkit
+objects that were initialized with :c:func:`hashkit_create` or :c:func:`hashkit_clone`.
+
+The :c:func:`hashkit_is_allocated` reports where the memory was allocated
+for a hashkit object.
+
+
+------------
+RETURN VALUE
+------------
+
+
+:c:func:`hashkit_create` and :c:func:`hashkit_clone` will return NULL on
+failure or non-NULL on success.
+
+:c:func:`hashkit_is_allocated` returns true if the memory for the hashkit
+object was allocated inside of :c:func:`hashkit_create` or
+:c:func:`hashkit_clone`, otherwise it is false and was user-supplied memory.
+
+
+----
+HOME
+----
+
+
+To find out more information please check:
+`http://libmemcached.org/ <http://libmemcached.org/>`_
+
+
+
+--------
+SEE ALSO
+--------
+
+
+:manpage:`hashkit_create(3)` :manpage:`hashkit_value(3)` :manpage:`hashkit_set_hash_fn(3)`
+
--- /dev/null
+================
+Available Hashes
+================
+
+.. index:: object: hashkit_st
+
+Various hash functions to use for calculating values for keys
+
+
+--------
+SYNOPSIS
+--------
+
+#include <libhashkit/hashkit.h>
+
+.. c:function:: uint32_t hashkit_default(const char *key, size_t key_length)
+
+.. c:function:: uint32_t hashkit_fnv1_64(const char *key, size_t key_length)
+
+.. c:function:: uint32_t hashkit_fnv1a_64(const char *key, size_t key_length)
+
+.. c:function:: uint32_t hashkit_fnv1_32(const char *key, size_t key_length)
+
+.. c:function:: uint32_t hashkit_fnv1a_32(const char *key, size_t key_length)
+
+.. c:function:: uint32_t hashkit_crc32(const char *key, size_t key_length)
+
+.. c:function:: uint32_t hashkit_hsieh(const char *key, size_t key_length)
+
+.. c:function:: uint32_t hashkit_murmur(const char *key, size_t key_length)
+
+.. c:function:: uint32_t hashkit_jenkins(const char *key, size_t key_length)
+
+.. c:function:: uint32_t hashkit_md5(const char *key, size_t key_length)
+
+Compile and link with -lhashkit
+
+
+-----------
+DESCRIPTION
+-----------
+
+
+These functions generate hash values from a key using a variety of
+algorithms. These functions can be used standalone, or as arguments
+to hashkit_set_hash_fn(3) or hashkit_set_continuum_hash_fn(3).
+
+The hashkit_hsieh is only available if the library is built with
+the appropriate flag enabled.
+
+
+------------
+RETURN VALUE
+------------
+
+
+A 32-bit hash value.
+
+
+----
+HOME
+----
+
+
+To find out more information please check:
+`http://libmemcached.org/ <http://libmemcached.org/>`_
+
+
+--------
+SEE ALSO
+--------
+
+
+:manpage:`hashkit_create(3)` :manpage:`hashkit_value(3)` :manpage:`hashkit_set_hash_fn(3)` :manpage:`hashkit_set_continuum_hash_fn(3)`
+
--- /dev/null
+=============
+hashkit_value
+=============
+
+
+.. index:: object: hashkit_st
+
+Generate a value for the given key
+
+--------
+SYNOPSIS
+--------
+
+
+#include <libhashkit/hashkit.h>
+
+.. c:function:: uint32_t hashkit_value(hashkit_st *hash, const char *key, size_t key_length)
+
+Compile and link with -lhashkit
+
+-----------
+DESCRIPTION
+-----------
+
+
+The :c:func:`hashkit_value` function generates a 32-bit hash value from the
+given key and key_length. The hash argument is an initialized hashkit
+object, and distribution type and hash function is used from this
+object while generating the value.
+
+
+------------
+RETURN VALUE
+------------
+
+
+A 32-bit hash value.
+
+
+----
+HOME
+----
+
+
+To find out more information please check:
+`http://libmemcached.org/ <http://libmemcached.org/>`_
+
+
+--------
+SEE ALSO
+--------
+
+
+:manpage:`hashkit_create(3)` :manpage:`hashkit_set_distribution(3)` :manpage:`hashkit_set_hash_fn(3)`
+
--- /dev/null
+=========================================
+Welcome to the libmemcached documentation
+=========================================
+
+------------
+Libmemcached
+------------
+
+
+######
+Basics
+######
+
+
+.. toctree::
+ :maxdepth: 1
+
+ libmemcached
+ versioning
+ memcached_create
+ libmemcached_examples
+ libmemcached_configuration
+ libmemcached/memcached_last_error_message
+
+#################
+Working with data
+#################
+
+.. toctree::
+ :maxdepth: 1
+
+ memcached_auto
+ memcached_delete
+ libmemcached/memcached_exist
+ memcached_flush_buffers
+ memcached_flush
+ memcached_get
+ memcached_result_st
+ memcached_set
+ memcached_append
+ memcached_cas
+
+
+###############
+Advanced Topics
+###############
+
+.. toctree::
+ :maxdepth: 1
+
+ libmemcached-1.0/memcached_set_encoding_key
+ memcached_behavior
+ memcached_callback
+ memcached_dump
+ memcached_generate_hash_value
+ memcached_memory_allocators
+ memcached_quit
+ libmemcached/memcached_return_t
+ memcached_sasl
+ memcached_server_st
+ memcached_servers
+ memcached_strerror
+ error_messages
+ memcached_user_data
+ memcached_verbosity
+ memcached_version
+ libmemcached/defaults
+
+##################
+Interface Versions
+##################
+
+.. toctree::
+ :titlesonly:
+
+ libmemcached-1.0/index
+ libmemcached-1.1/index
+
+####################
+Deprecated Functions
+####################
+
+.. toctree::
+ :titlesonly:
+
+ libmemcached/memcached_fetch
+
+#################
+Platform Specific
+#################
+
+.. toctree::
+ :maxdepth: 1
+
+ tap
+ types
+
+#################################
+Deriving statistics from a server
+#################################
+
+.. toctree::
+ :maxdepth: 1
+
+ memcached_analyze
+ memcached_stats
+
+----------------
+Libmemcachedutil
+----------------
+
+.. toctree::
+ :maxdepth: 1
+
+ libmemcachedutil
+ memcached_pool
+
+-------------------
+Client Applications
+-------------------
+
+.. toctree::
+ :maxdepth: 1
+
+ bin/memcapable
+ bin/memcat
+ bin/memcp
+ bin/memdump
+ bin/memerror
+ bin/memflush
+ bin/memrm
+ bin/memslap
+ bin/memaslap
+ bin/memstat
+ bin/memexist.rst
+ bin/memparse.rst
+ bin/memping.rst
+ bin/memtouch.rst
+
+----------
+Libhashkit
+----------
+
+.. toctree::
+ :maxdepth: 1
+
+ libhashkit
+ hashkit_create
+ hashkit_functions
+ hashkit_value
+
+==================
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`
+
--- /dev/null
+======================
+Introducing libhashkit
+======================
+
+
+.. code-block:: c
+
+ 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:
+`http://libmemcached.org/ <http://libmemcached.org/>`_
+
+
+--------
+SEE ALSO
+--------
+
+:manpage:`libhashkit(3)`
+
--- /dev/null
+====================
+libmemcached 1.0 API
+====================
+
+
+.. toctree::
+ :titlesonly:
+
+ memcached_touch
--- /dev/null
+==================
+Set encryption key
+==================
+
+.. index:: object: memcached_st
+
+--------
+SYNOPSIS
+--------
+
+#include <libmemcached/memcached.h>
+
+.. c:function:: void memcached_set_encoding_key (memcached_st *ptr, const char *string, const size_t string_length)
+
+Compile and link with -lmemcached
+
+-----------
+DESCRIPTION
+-----------
+
+
+:c:func:`memcached_set_encoding_key` sets the key that will be used to encrypt and decrypt data as it is sent and recieved from the server.
+
+Currently only AES is is supported.
+
+
+------
+RETURN
+------
+
+
+A value of type :c:type:`memcached_return_t` is returned On success that value
+will be :c:type:`MEMCACHED_SUCCESS`. Use :c:func:`memcached_strerror` to
+translate this value to a printable string.
+
+
+----
+HOME
+----
+
+
+To find out more information please check:
+`http://libmemcached.org/ <http://libmemcached.org/>`_
+
+
+------
+AUTHOR
+------
+
+
+Brian Aker, <brian@tangent.org>
+
+
+--------
+SEE ALSO
+--------
+
+:manpage:`memcached(1)` :manpage:`libmemcached(3)` :manpage:`memcached_strerror(3)`
--- /dev/null
+===========================================
+memcached_touch, memcached_touch_by_key
+===========================================
+
+.. index:: object: memcached_st
+
+--------
+SYNOPSIS
+--------
+
+
+#include <libmemcached/memcached.h>
+
+.. c:function:: memcached_return_t memcached_touch (memcached_st *ptr, const char *key, size_t key_length, time_t expiration)
+
+.. c:function:: memcached_return_t memcached_touch_by_key (memcached_st *ptr, const char *group_key, size_t group_key_length, const char *key, size_t key_length, time_t expiration)
+
+Compile and link with -lmemcached
+
+-----------
+DESCRIPTION
+-----------
+
+
+:c:func:`memcached_touch` is used to update the expiration time on an existing key.
+:c:func:`memcached_touch_by_key` works the same, but it takes a master key
+to find the given value.
+
+
+------
+RETURN
+------
+
+
+A value of type :c:type:`memcached_return_t` is returned
+On success that value will be :c:type:`MEMCACHED_SUCCESS`.
+Use :c:func:`memcached_strerror` to translate this value to a printable
+string.
+
+----
+HOME
+----
+
+To find out more information please check:
+`http://libmemcached.org/ <http://libmemcached.org/>`_
+
+
+------
+AUTHOR
+------
+
+
+Brian Aker, <brian@tangent.org>
+
+
+--------
+SEE ALSO
+--------
+
+:manpage:`memcached(1)` :manpage:`libmemcached(3)` :manpage:`memcached_strerror(3)`
+
--- /dev/null
+====================
+libmemcached 1.1 API
+====================
+
+The 1.1 is still being finalized. It will be the 1.0 API minus deprecated functions.
--- /dev/null
+==============================================
+Introducing the C Client Library for memcached
+==============================================
+
+--------
+SYNOPSIS
+--------
+
+#include <libmemcached/memcached.h>
+
+Compile and link with -lmemcached
+
+=======
+
+libMemcached is an open source C/C++ client library and tools for the memcached server (http://memcached.org/). It has been designed to be light on memory usage, thread safe, and provide full access to server side methods.
+
+libMemcached was designed to provide the greatest number of options to use Memcached. Some of the features provided:
+
+1. Asynchronous and Synchronous Transport Support.
+2. Consistent Hashing and Distribution.
+3. Tunable Hashing algorithm to match keys.
+4. Access to large object support.
+5. Local replication.
+6. A complete reference guide and documentation to the API.
+7. Tools to Manage your Memcached networks.
+
+-----------
+DESCRIPTION
+-----------
+
+
+"Memcached is a high-performance, distributed memory object caching
+system, generic in nature, but intended for use in speeding up dynamic web
+applications by alleviating database load." `http://memcached.org/ <http://memcached.org/>`_
+
+:program:`libmemcached` is a small, thread-safe client library for the
+memcached protocol. The code has all been written to allow
+for both web and embedded usage. It handles the work behind routing
+individual keys to specific servers specified by the developer (and values are
+matched based on server order as supplied by the user). It implements
+a modular and consistent method of object distribution.
+
+There are multiple implemented routing and hashing methods. See the
+:c:func:`memcached_behavior_set` manpage for more information.
+
+All operations are performed against a :c:type:`memcached_st` structure.
+These structures can either be dynamically allocated or statically
+allocated and then initialized by :c:func:`memcached_create`. Functions have
+been written in order to encapsulate the :c:type:`memcached_st`. It is not
+recommended that you operate directly against the structure.
+
+Nearly all functions return a :c:type:`memcached_return_t` value.
+This value can be translated to a printable string with
+:c:type:`memcached_strerror`.
+
+Objects are stored on servers by hashing keys. The hash value maps the key to a particular server. All clients understand how this hashing works, so it is possibly to reliably both push data to a server and retrieve data from a server.
+
+Group keys can be optionally used to group sets of objects with servers.
+
+Namespaces are supported, and can be used to partition caches so that multiple applications can use the same memcached servers.
+
+:c:type:`memcached_st` structures are thread-safe, but each thread must
+contain its own structure (that is, if you want to share these among
+threads you must provide your own locking). No global variables are
+used in this library.
+
+If you are working with GNU autotools you will want to add the following to
+your COPYING to properly include libmemcached in your application.
+
+PKG_CHECK_MODULES(DEPS, libmemcached >= 0.8.0)
+AC_SUBST(DEPS_CFLAGS)
+AC_SUBST(DEPS_LIBS)
+
+Some features of the library must be enabled through :c:func:`memcached_behavior_set`.
+
+Hope you enjoy it!
+
+
+---------
+CONSTANTS
+---------
+
+
+A number of constants have been provided for in the library.
+
+
+.. c:macro:: MEMCACHED_DEFAULT_PORT
+
+ The default port used by memcached(3).
+
+
+.. c:macro:: MEMCACHED_MAX_KEY
+
+ Default maximum size of a key (which includes the null pointer). Master keys
+ have no limit, this only applies to keys used for storage.
+
+
+.. c:macro:: MEMCACHED_MAX_KEY
+
+ Default size of key (which includes the null pointer).
+
+
+.. c:macro:: MEMCACHED_STRIDE
+
+ This is the "stride" used in the consistent hash used between replicas.
+
+
+.. c:macro:: MEMCACHED_MAX_HOST_LENGTH
+
+ Maximum allowed size of the hostname.
+
+
+.. c:macro:: LIBMEMCACHED_VERSION_STRING
+
+ String value of libmemcached version such as "1.23.4"
+
+
+.. c:macro:: LIBMEMCACHED_VERSION_HEX
+
+ Hex value of the version number. "0x00048000" This can be used for comparing versions based on number.
+
+
+.. c:macro:: MEMCACHED_PREFIX_KEY_MAX_SIZE
+
+ Maximum length allowed for namespacing of a key.
+
+
+
+---------------------
+THREADS AND PROCESSES
+---------------------
+
+
+When using threads or forked processes it is important to keep one instance
+of :c:type:`memcached_st` per process or thread. Without creating your own
+locking structures you can not share a single :c:type:`memcached_st`. However,
+you can call :c:func:`memcached_quit` on a :c:type:`memcached_st` and then use the resulting cloned structure.
+
+
+----
+HOME
+----
+
+
+To find out more information please check:
+`http://libmemcached.org/ <http://libmemcached.org/>`_
+
+
+--------
+SEE ALSO
+--------
+
+
+:manpage:`memcached(1)` :manpage:`libmemcached_examples(3)`
+:manpage:`libmemcached(1)` :manpage:`memcat(1)` :manpage:`memcp(1)`
+:manpage:`memflush(1)` :manpage:`memrm(1)` :manpage:`memslap(1)`
+:manpage:`memstat(1)` :manpage:`memcached_fetch(3)`
+:manpage:`memcached_replace(3)` :manpage:`memcached_server_list_free(3)`
+:manpage:`libmemcached_examples(3)` :manpage:`memcached_clone(3)`
+:manpage:`memcached_free(3)` :manpage:`memcached_server_add(3)`
+:manpage:`memcached_server_push(3)` :manpage:`memcached_add(3)`
+:manpage:`memcached_get(3)` :manpage:`memcached_server_count(3)`
+:manpage:`memcached_create(3)` :manpage:`memcached_increment(3)`
+:manpage:`memcached_server_list(3)` :manpage:`memcached_set(3)`
+:manpage:`memcached_decrement(3)` :manpage:`memcached_mget(3)`
+:manpage:`memcached_server_list_append(3)` :manpage:`memcached_strerror(3)`
+:manpage:`memcached_delete(3)` :manpage:`memcached_quit(3)`
+:manpage:`memcached_server_list_count(3)` :manpage:`memcached_verbosity(3)`
+:manpage:`memcached_server_add_unix_socket(3)`
+:manpage:`memcached_result_create(3)` :manpage:`memcached_result_free(3)`
+:manpage:`memcached_result_key_value(3)`
+:manpage:`memcached_result_key_length(3)`
+:manpage:`memcached_result_value(3)` :manpage:`memcached_result_length(3)`
+:manpage:`memcached_result_flags(3)` :manpage:`memcached_result_cas(3)`
+:manpage:`memcached_result_st(3)` :manpage:`memcached_append(3)`
+:manpage:`memcached_prepend(3)` :manpage:`memcached_fetch_result(3)`
+:manpage:`memerror(1)` :manpage:`memcached_get_by_key(3)`
+:manpage:`memcached_mget_by_key(3)` :manpage:`memcached_delete_by_key(3)`
+:manpage:`memcached_fetch_execute(3)` :manpage:`memcached_callback_get(3)`
+:manpage:`memcached_callback_set(3)` :manpage:`memcached_version(3)`
+:manpage:`memcached_lib_version(3)` :manpage:`memcached_result_set_value(3)`
+:manpage:`memcached_dump(3)` :manpage:`memdump(1)`
+:manpage:`memcached_set_memory_allocators(3)`
+:manpage:`memcached_get_memory_allocators(3)`
+:manpage:`memcached_get_user_data(3)` :manpage:`memcached_set_user_data(3)`
--- /dev/null
+========
+DEFAULTS
+========
+
+
+.. c:macro:: MEMCACHED_DEFAULT_TIMEOUT
+
+Value 5000
+
+.. c:macro:: MEMCACHED_DEFAULT_CONNECT_TIMEOUT
+
+ Value 4000
+
+.. c:macro:: MEMCACHED_CONTINUUM_ADDITION
+
+ Value 10. How many extra slots we should build for in the continuum.
+
+.. c:macro:: MEMCACHED_SERVER_FAILURE_LIMIT
+
+ Value 5
+
+.. c:macro:: MEMCACHED_SERVER_FAILURE_RETRY_TIMEOUT
+
+ Value 2
+
+.. c:macro:: MEMCACHED_SERVER_FAILURE_DEAD_TIMEOUT
+
+ Value 0
+
+.. c:macro:: `MEMCACHED_PREFIX_KEY_MAX_SIZE`
+
+ Value 128
+
+.. c:macro:: MEMCACHED_VERSION_STRING_LENGTH
+
+ Value 24
--- /dev/null
+===========================
+Determine if a keys exists.
+===========================
+
+.. index:: object: memcached_st
+
+--------
+SYNOPSIS
+--------
+
+
+#include <libmemcached/memcached.h>
+
+.. c:function:: memcached_return_t memcached_exist(memcached_st *ptr, char *key, size_t *key_length)
+
+.. c:function:: memcached_return_t memcached_exist_by_key(memcached_st *ptr, char *group_key, size_t *group_key_length, char *key, size_t *key_length)
+
+ .. versionadded:: 0.53
+
+Compile and link with -lmemcached
+
+
+-----------
+DESCRIPTION
+-----------
+
+:c:func:`memcached_exist()` can be used to check to see if a key exists. No value is returned if the key exists, or does not exist, on the server.
+
+
+------
+RETURN
+------
+
+:c:func:`memcached_exist()` sets error to
+to :c:type:`MEMCACHED_SUCCESS` upon finding that the key exists.
+:c:type:`MEMCACHED_NOTFOUND` will be return if the key is not found.
+
+
+----
+HOME
+----
+
+To find out more information please check:
+`http://libmemcached.org/ <http://libmemcached.org/>`_
+
+
+--------
+SEE ALSO
+--------
+
+:manpage:`memcached(1)` :manpage:`libmemcached(3)` :manpage:`memcached_strerror(3)`
+
+
--- /dev/null
+=================
+memcached_fetch
+=================
+
+.. index:: object: memcached_st
+
+--------
+SYNOPSIS
+--------
+
+
+#include <libmemcached/memcached.h>
+
+.. c:function:: char *memcached_fetch(memcached_st *ptr, char *key, size_t *key_length, size_t *value_length, uint32_t *flags, memcached_return_t *error)
+
+ .. deprecated:: 0.50
+ Use :c:func:`memcached_fetch_result` instead.
+
+Compile and link with -lmemcached
+
+
+-----------
+DESCRIPTION
+-----------
+
+:c:func:`memcached_fetch` is used to fetch an individual value from the server. :c:func:`memcached_mget` must always be called before using this method.
+You must pass in a key and its length to fetch the object. You must supply
+three pointer variables which will give you the state of the returned
+object. A :c:type:`uint32_t` pointer to contain whatever flags you stored with the value, a :c:type:`size_t` pointer which will be filled with size of of the
+object, and a :c:type:`memcached_return_t` pointer to hold any error. The
+object will be returned upon success and NULL will be returned on failure. :c:type:`MEMCACHED_END` is returned by the \*error value when all objects that have been found are returned. The final value upon :c:type:`MEMCACHED_END` is null.
+
+Values returned by :c:func:`memcached_fetch` must be freed by the caller.
+
+All of the above functions are not tested when the
+:c:type:`MEMCACHED_BEHAVIOR_USE_UDP` has been set. Executing any of these
+functions with this behavior on will result in :c:type:`MEMCACHED_NOT_SUPPORTED` being returned, or for those functions which do not return a :c:type:`memcached_return_t`, the error function parameter will be set to :c:type:`MEMCACHED_NOT_SUPPORTED`.
+
+
+------
+RETURN
+------
+
+:c:func:`memcached_fetch` sets error to
+to :c:type:`MEMCACHED_END` upon successful conclusion.
+:c:type:`MEMCACHED_NOTFOUND` will be return if no keys at all were found.
+
+:c:type:`MEMCACHED_KEY_TOO_BIG` is set to error whenever :c:func:`memcached_fetch` was used
+and the key was set larger then :c:type:`MEMCACHED_MAX_KEY`, which was the largest
+key allowed for the original memcached ascii server.
+
+
+----
+HOME
+----
+
+To find out more information please check:
+`http://libmemcached.org/ <http://libmemcached.org/>`_
+
+
+--------
+SEE ALSO
+--------
+
+:manpage:`memcached(1)` :manpage:`libmemcached(3)` :manpage:`memcached_strerror(3)` :manpage:`memcached_fetch_result(3)`
+
--- /dev/null
+=================
+Retrieving errors
+=================
+
+
+--------
+SYNOPSIS
+--------
+
+
+#include <libmemcached/memcached.h>
+
+.. c:function:: const char *memcached_last_error_message(memcached_st *)
+
+Compile and link with -lmemcached
+
+
+-----------
+DESCRIPTION
+-----------
+
+:c:func:`memcached_last_error_message` is used to return the last error
+message that the server responded too. If this error came from a specific
+server, its hostname and port will be provided in the error message.
+
+------
+RETURN
+------
+
+memcached_last_error_message returns a const char* which does not need to be
+de-allocated. If no error has occurred then it will return NULL.
+
+----
+HOME
+----
+
+To find out more information please check:
+`http://libmemcached.org/ <http://libmemcached.org/>`_
+
+
+--------
+SEE ALSO
+--------
+
+:manpage:`memcached(1)` :manpage:`libmemcached(3)` :manpage:`memcached_strerror(3)`
+
+
--- /dev/null
+================================
+Error Codes (memcached_return_t)
+================================
+
+--------
+SYNOPSIS
+--------
+
+#include <libmemcached/memcached.h>
+
+.. c:type:: memcached_return_t
+
+.. c:function:: const char *libmemcached_strerror(memcached_return_t rc)
+
+.. c:function:: bool libmemcached_success(memcached_return_t rc)
+
+.. c:function:: bool libmemcached_failure(memcached_return_t rc)
+
+.. c:function:: bool libmemcache_continue(memcached_return_t rc)
+
+.. c:function:: bool memcached_success(memcached_return_t)
+
+.. c:function:: bool memcached_failure(memcached_return_t)
+
+
+:c:func:`memcached_success` return true if :c:type:`MEMCACHED_SUCCESS` tested true.
+
+:c:func:`memcached_failure` return true if any value other then :c:type:`MEMCACHED_SUCCESS` was provided.
+
+
+Libmemcached return types:
+++++++++++++++++++++++++++
+
+
+:c:type:`MEMCACHED_SUCCESS`
+
+:c:type:`MEMCACHED_FAILURE`
+
+:c:type:`MEMCACHED_HOST_LOOKUP_FAILURE`
+
+:c:type:`MEMCACHED_CONNECTION_FAILURE`
+
+:c:type:`MEMCACHED_CONNECTION_BIND_FAILURE`
+
+:c:type:`MEMCACHED_WRITE_FAILURE`
+
+:c:type:`MEMCACHED_READ_FAILURE`
+
+:c:type:`MEMCACHED_UNKNOWN_READ_FAILURE`
+
+:c:type:`MEMCACHED_PROTOCOL_ERROR`
+
+:c:type:`MEMCACHED_CLIENT_ERROR`
+
+:c:type:`MEMCACHED_SERVER_ERROR`
+
+:c:type:`MEMCACHED_CONNECTION_SOCKET_CREATE_FAILURE`
+
+:c:type:`MEMCACHED_DATA_EXISTS`
+
+:c:type:`MEMCACHED_DATA_DOES_NOT_EXIST`
+
+:c:type:`MEMCACHED_NOTSTORED`
+
+:c:type:`MEMCACHED_STORED`
+
+:c:type:`MEMCACHED_NOTFOUND`
+
+:c:type:`MEMCACHED_MEMORY_ALLOCATION_FAILURE`
+
+:c:type:`MEMCACHED_PARTIAL_READ`
+
+:c:type:`MEMCACHED_SOME_ERRORS`
+
+:c:type:`MEMCACHED_NO_SERVERS`
+
+:c:type:`MEMCACHED_END`
+
+:c:type:`MEMCACHED_DELETED`
+
+:c:type:`MEMCACHED_VALUE`
+
+:c:type:`MEMCACHED_STAT`
+
+:c:type:`MEMCACHED_ITEM`
+
+:c:type:`MEMCACHED_ERRNO`
+
+:c:type:`MEMCACHED_FAIL_UNIX_SOCKET`
+
+:c:type:`MEMCACHED_NOT_SUPPORTED`
+
+:c:type:`MEMCACHED_NO_KEY_PROVIDED`
+
+:c:type:`MEMCACHED_FETCH_NOTFINISHED`
+
+:c:type:`MEMCACHED_TIMEOUT`
+
+:c:type:`MEMCACHED_BUFFERED`
+
+:c:type:`MEMCACHED_BAD_KEY_PROVIDED`
+
+:c:type:`MEMCACHED_INVALID_HOST_PROTOCOL`
+
+:c:type:`MEMCACHED_SERVER_MARKED_DEAD`
+
+:c:type:`MEMCACHED_UNKNOWN_STAT_KEY`
+
+:c:type:`MEMCACHED_E2BIG`
+
+:c:type:`MEMCACHED_INVALID_ARGUMENTS`
+
+:c:type:`MEMCACHED_KEY_TOO_BIG`
+
+:c:type:`MEMCACHED_AUTH_PROBLEM`
+
+:c:type:`MEMCACHED_AUTH_FAILURE`
+
+:c:type:`MEMCACHED_AUTH_CONTINUE`
+
+:c:type:`MEMCACHED_PARSE_ERROR`
+
+:c:type:`MEMCACHED_PARSE_USER_ERROR`
+
+:c:type:`MEMCACHED_DEPRECATED`
+
+--------
+SEE ALSO
+--------
+
+:manpage:`memcached` :manpage:`libmemcached` :manpage:`memcached_client_error` or :manpage:`memcached_worker_error`
+
--- /dev/null
+========================
+Configuring Libmemcached
+========================
+
+.. highlightlang:: c
+
+--------
+SYNOPSIS
+--------
+
+#include <libmemcached-1.0/memcached.h>
+
+.. envvar:: LIBMEMCACHED
+
+.. c:function:: memcached_st *memcached(const char *string, size_t string_length)
+
+.. c:function:: memcached_return_t libmemcached_check_configuration(const char *option_string, size_t length, char *error_buffer, size_t error_buffer_size)
+
+Compile and link with -lmemcached
+
+
+-----------
+DESCRIPTION
+-----------
+
+Libmemcached implements a custom language for configuring and modifying
+servers. By passing in an option string you can generate a ``memcached_st`` object
+that you can use in your application directly.
+
+.. describe:: --SERVER=<servername>:<optional_port>/?<optional_weight>
+
+Provide a servername to be used by the client. Providing a weight will cause weighting to occur with all hosts with each server getting a default weight of 1.
+
+.. describe:: --SOCKET=\"<filepath>/?<optional_weight>\"
+
+Provide a filepath to a UNIX socket file. Providing a weight will cause weighting to occur with all hosts with each server getting a default weight of 1.
+
+.. describe:: --VERIFY-KEY
+
+Verify that keys that are being used fit within the design of the protocol being used.
+
+.. describe:: --REMOVE_FAILED_SERVERS
+
+Enable the behavior :c:type:`MEMCACHED_BEHAVIOR_REMOVE_FAILED_SERVERS`.
+
+.. describe:: --BINARY-PROTOCOL
+
+Force all connections to use the binary protocol.
+
+.. describe:: --BUFFER-REQUESTS
+
+Please see :c:type:`MEMCACHED_BEHAVIOR_BUFFER_REQUESTS`.
+
+.. describe:: --CONFIGURE-FILE=
+
+Provide a configuration file to be used to load requests. Beware that by using a configuration file libmemcached will reset memcached_st based on information only contained in the file.
+
+.. describe:: --CONNECT-TIMEOUT=
+
+Please see :c:type:`MEMCACHED_BEHAVIOR_CONNECT_TIMEOUT`.
+
+.. describe:: --DISTRIBUTION=
+
+Set the distribution model used by the client. See :manpage:`` for more details.
+
+.. describe:: --HASH=
+
+Set the hashing alogrthm used for placing keys on servers.
+
+.. describe:: --HASH-WITH-NAMESPACE
+
+When enabled the prefix key will be added to the key when determining which
+server to store the data in.
+
+.. describe:: --NOREPLY
+
+Enable "no reply" for all calls that support this. It is highly recommended
+that you use this option with the binary protocol only.
+
+.. describe:: --NUMBER-OF-REPLICAS=
+
+Set the nummber of servers that keys will be replicated to.
+
+.. describe:: --RANDOMIZE-REPLICA-READ
+
+Select randomly the server within the replication pool to read from.
+
+.. describe:: --SORT-HOSTS
+
+When adding new servers always calculate their distribution based on sorted naming order.
+
+.. describe:: --SUPPORT-CAS
+
+See :manpage:`memcached_behavior_set(3)` for :c:type:`MEMCACHED_BEHAVIOR_SUPPORT_CAS`
+
+.. describe:: --USE-UDP
+
+See :manpage:`memcached_behavior_set(3)` for :c:type:`MEMCACHED_BEHAVIOR_USE_UDP`
+
+.. describe:: --NAMESPACE=
+
+A namespace is a container that provides context for keys, only other
+requests that know the namespace can access these values. This is
+accomplished by prepending the namespace value to all keys.
+
+
+**********************
+Mecached Pool Options:
+**********************
+
+.. describe:: --POOL-MIN
+
+Initial size of pool.
+
+.. describe:: --POOL-MAX
+
+Maximize size of the pool.
+
+************
+I/O Options:
+************
+
+.. describe:: --TCP-NODELAY
+
+See :manpage:`memcached_behavior_set(3)` for MEMCACHED_BEHAVIOR_TCP_NODELAY
+
+.. describe:: --TCP-KEEPALIVE
+
+See :manpage:`memcached_behavior_set(3)` for MEMCACHED_BEHAVIOR_TCP_KEEPALIVE
+
+.. describe:: --RETRY-TIMEOUT=
+
+See :manpage:`memcached_behavior_set(3)` for MEMCACHED_BEHAVIOR_RETRY_TIMEOUT
+
+.. describe:: --SERVER-FAILURE-LIMIT=
+
+See :manpage:`memcached_behavior_set(3)` for MEMCACHED_BEHAVIOR_SERVER_FAILURE_LIMIT
+
+.. describe:: --SND-TIMEOUT=
+
+See :manpage:`memcached_behavior_set(3)` for MEMCACHED_BEHAVIOR_SND_TIMEOUT
+
+.. describe:: --SOCKET-RECV-SIZE=
+
+See :manpage:`memcached_behavior_set(3)` for MEMCACHED_BEHAVIOR_SOCKET_RECV_SIZE
+
+.. describe:: --SOCKET-SEND-SIZE=
+
+See :manpage:`memcached_behavior_set(3)` for MEMCACHED_BEHAVIOR_SOCKET_SEND_SIZE
+
+.. describe:: --POLL-TIMEOUT=
+
+That sets the value of the timeout used by :manpage: `poll()`.
+
+.. describe:: --IO-BYTES-WATERMARK=
+
+.. describe:: --IO-KEY-PREFETCH=
+
+.. describe:: --IO-MSG-WATERMARK=
+
+.. describe:: --TCP-KEEPIDLE
+
+.. describe:: --RCV-TIMEOUT=
+
+
+
+******
+Other:
+******
+
+
+.. describe:: INCLUDE
+
+Include a file in configuration. Unlike --CONFIGURE-FILE= this will not reset memcached_st
+
+.. describe:: RESET
+
+Reset memcached_st and continue to process.
+
+.. describe:: END
+
+End configutation processing.
+
+.. describe:: ERROR
+
+End configutation processing and throw an error.
+
+
+------
+RETURN
+------
+
+
+:c:func:`memcached()` returns a pointer to the memcached_st that was
+created (or initialized). On an allocation failure, it returns NULL.
+
+
+
+-------
+EXAMPLE
+-------
+
+
+.. code-block:: c
+
+ const char *config_string= "--SERVER=host10.example.com --SERVER=host11.example.com --SERVER=host10.example.com"
+ memcached_st *memc= memcached(config_string, strlen(config_string);
+ {
+ ...
+ }
+ memcached_free(memc);
+
+
+
+----
+HOME
+----
+
+
+To find out more information please check:
+`http://libmemcached.org/ <http://libmemcached.org/>`_
+
+
+
+--------
+SEE ALSO
+--------
+
+
+:manpage:`memcached(1)` :manpage:`libmemcached(3)` :manpage:`memcached_strerror(3)`
--- /dev/null
+========
+Examples
+========
+
+Examples for libmemcached
+
+-----------
+DESCRIPTION
+-----------
+
+
+For full examples, test cases are found in tests/\*.c in the main
+distribution. These are always up to date, and are used for each test run of
+the library.
+
+
+---------------------
+Connecting to servers
+---------------------
+
+
+.. code-block:: c
+
+ const char *config_string= "--SERVER=host10.example.com --SERVER=host11.example.com --SERVER=host10.example.com"
+ memcached_st *memc= memcached(config_string, strlen(config_string);
+ {
+ ...
+ }
+ memcached_free(memc);
+
+
+In the above code you create a :c:type:`memcached_st` object with three server
+by making use of :c:func:`memcached_create`.
+
+
+--------------------------
+Creating a pool of servers
+--------------------------
+
+
+
+.. code-block:: c
+
+Creating a pool of Servers::
+
+ const char *config_string= "--SERVER=host10.example.com --SERVER=host11.example.com --SERVER=host10.example.com";
+
+ memcached_pool_st* pool= memcached_pool(config_string, strlen(config_string));
+
+ memcached_return_t rc;
+
+ memcached_st *memc= memcached_pool_pop(pool, false, &rc);
+
+ .... do work
+
+ /*
+ Release the memc_ptr that was pulled from the pool
+ */
+ memcached_pool_push(pool, memc);
+
+ /*
+ Destroy the pool.
+ */
+ memcached_pool_destroy(pool);
+
+
+
+In the above code you create a :c:type:`memcached_pool_st` object with three
+server by making use of :c:func:`memcached_pool()`.
+
+When :c:func:`memcached_pool_destroy()` all memory will be released that is associated
+with the pool.
+
+
+----------------------------
+Adding a value to the server
+----------------------------
+
+
+
+.. code-block:: c
+
+Adding a value to the Server::
+
+ char *key= "foo";
+ char *value= "value";
+
+ memcached_return_t rc= memcached_set(memc, key, strlen(key), value, value_length, (time_t)0, (uint32_t)0);
+
+ if (rc != MEMCACHED_SUCCESS)
+ {
+ ... // handle failure
+ }
+
+
+It is best practice to always look at the return value of any operation.
+
+
+------------------------
+Fetching multiple values
+------------------------
+
+
+
+.. code-block:: c
+
+ memcached_return_t rc;
+ char *keys[]= {"fudge", "son", "food"};
+ size_t key_length[]= {5, 3, 4};
+ unsigned int x;
+ uint32_t flags;
+
+ char return_key[MEMCACHED_MAX_KEY];
+ size_t return_key_length;
+ char *return_value;
+ size_t return_value_length;
+
+ rc= memcached_mget(memc, keys, key_length, 3);
+
+ x= 0;
+ while ((return_value= memcached_fetch(memc, return_key, &return_key_length,
+ &return_value_length, &flags, &rc)))
+ {
+ free(return_value);
+ x++;
+ }
+
+
+Notice that you freed values returned from memcached_fetch(). The define
+:c:type:`MEMCACHED_MAX_KEY` is provided for usage.
+
+
+
+----
+HOME
+----
+
+
+To find out more information please check:
+`http://libmemcached.org/ <http://libmemcached.org/>`_
+
+
+--------
+SEE ALSO
+--------
+
+
+:manpage:`memcached(1)`
+
--- /dev/null
+===========
+Introducing
+===========
+
+
+Utility library for libmemcached
+
+
+--------
+SYNOPSIS
+--------
+
+.. code-block:: c
+
+ cc [ flag ... ] file ... -lmemcachedutil
+
+ #include <libmemcached/memcached_util.h>
+
+
+
+-----------
+DESCRIPTION
+-----------
+
+
+:program:`libmemcachedutil` is a small and thread-safe client library that
+provides extra functionality built on top of :program:`libmemcached`.
+
+
+-------
+THREADS
+-------
+
+
+Do not try to access an instance of :c:type:`memcached_st` from multiple threads
+at the same time. If you want to access memcached from multiple threads
+you should either clone the :c:type:`memcached_st`, or use the memcached pool
+implementation. see :c:func:`memcached_pool_create`.
+
+
+----
+HOME
+----
+
+
+To find out more information please check:
+`http://libmemcached.org/ <http://libmemcached.org/>`_
+
+
+--------
+SEE ALSO
+--------
+
+
+:manpage:`libmemcached(3)` :manpage:`memcached_pool_create(3)` :manpage:`memcached_pool_destroy(3)` :manpage:`memcached_pool_pop(3)` :manpage:`memcached_pool_push(3)`
+
--- /dev/null
+=================
+Anaylzing servers
+=================
+
+
+Analyze server information
+
+
+--------
+SYNOPSIS
+--------
+
+.. index:: object: memcached_analysis_st
+
+
+#include <libmemcached/memcached.h>
+
+.. c:type:: memcached_analysis_st
+
+.. c:function:: memcached_analysis_st * memcached_analyze (memcached_st *ptr, memcached_stat_st *stat, memcached_return_t *error)
+
+Compile and link with -lmemcached
+
+-----------
+DESCRIPTION
+-----------
+
+
+:program:`libmemcached` has the ability to query a memcached server (or
+collection of servers) for their current state. Queries to find state return a
+:c:type:`memcached_analysis_st` structure. You are responsible for freeing this structure.
+
+:c:func:`memcached_analyze` analyzes useful information based on the
+provided servers and sets the result to the :c:type:`memcached_analysis_st`
+structure. The return value must be freed by the calling application.
+
+A command line tool, :program:`memstat` with the option :option:`memstat --analyze`,
+is provided so that you do not have to write an application to use this method.
+
+
+------
+RETURN
+------
+
+
+A pointer to the allocated :c:type:`memcached_analysis_st` structure on
+success and a NULL pointer on failure. You may inspect the error detail by
+checking the :c:type:`memcached_return_t` value.
+
+Any method returning a :c:type:`memcached_analysis_st` expects you to free the
+memory allocated for it.
+
+
+----
+HOME
+----
+
+
+To find out more information please check:
+`http://libmemcached.org/ <http://libmemcached.org/>`_
+
+
+--------
+SEE ALSO
+--------
+
+
+:manpage:`memcached(1)` :manpage:`libmemcached(3)` :manpage:`memcached_strerror(3)`
+
--- /dev/null
+=============================================
+Appending or Prepending to data on the server
+=============================================
+
+.. index:: object: memcached_st
+
+Appending or Prepending to data on the server
+
+
+--------
+SYNOPSIS
+--------
+
+
+#include <libmemcached/memcached.h>
+
+.. c:function:: memcached_return_t memcached_prepend(memcached_st *ptr, const char *key, size_t key_length, const char *value, size_t value_length, time_t expiration, uint32_t flags)
+
+.. c:function:: memcached_return_t memcached_append(memcached_st *ptr, const char *key, size_t key_length, const char *value, size_t value_length, time_t expiration, uint32_t flags)
+
+.. c:function:: memcached_return_t memcached_prepend_by_key(memcached_st *ptr, const char *group_key, size_t group_key_length, const char *key, size_t key_length, const char *value, size_t value_length, time_t expiration, uint32_t flags)
+
+.. c:function:: memcached_return_t memcached_append_by_key(memcached_st *ptr, const char *group_key, size_t group_key_length, const char *key, size_t key_length, const char *value, size_t value_length, time_t expiration, uint32_t flags)
+
+Compile and link with -lmemcached
+
+
+-----------
+DESCRIPTION
+-----------
+
+
+:c:func:`memcached_prepend` and memcached_append are used to
+modify information on a server. All methods take a key, and its length to
+store the object. Keys are currently limited to 250 characters when using
+either a version of memcached which is 1.4 or below, or when using the text
+protocol. You must supply both a value and a length. Optionally you
+may test an expiration time for the object and a 16 byte value (it is
+meant to be used as a bitmap). "flags" is a 4byte space that is stored
+alongside of the main value. Many sub libraries make use of this field,
+so in most cases users should avoid making use of it.
+
+:c:func:`memcached_prepend` places a segment of data before the last piece
+of data stored. Currently expiration and key are not used in the server.
+
+:c:func:`memcached_append` places a segment of data at the end of the last
+piece of data stored. Currently expiration and key are not used in the server.
+
+:c:func:`memcached_prepend_by_key` and
+:c:func:`memcached_append_by_key` methods both behave in a similar
+method as the non key methods. The difference is that they use their
+group_key parameter to map objects to particular servers.
+
+If you are looking for performance, :c:func:`memcached_set` with non-blocking
+IO is the fastest way to store data on the server.
+
+All of the above functions are testsed with the
+:c:type:`MEMCACHED_BEHAVIOR_USE_UDP` behavior enabled. However, when using
+these operations with this behavior on, there are limits to the size of the
+payload being sent to the server. The reason for these limits is that the
+Memcached Server does not allow multi-datagram requests
+and the current server implementation sets a datagram size to 1400 bytes. Due
+to protocol overhead, the actual limit of the user supplied data is less than
+1400 bytes and depends on the protocol in use as, well as the operation being
+executed. When running with the binary protocol,
+:c:type:`MEMCACHED_BEHAVIOR_BINARY_PROTOCOL`, the size of the key,value,
+flags and expiry combined may not exceed 1368 bytes. When running with the
+ASCII protocol, the exact limit fluctuates depending on which function is
+being executed and whether the function is a cas operation or not. For
+non-cas ASCII set operations, there are at least 1335 bytes available
+to split among the key, key_prefix, and value; for cas ASCII operations
+there are at least 1318 bytes available to split among the key, key_prefix
+and value. If the total size of the command, including overhead, exceeds
+1400 bytes, a :c:type:`MEMCACHED_WRITE_FAILURE` will be returned.
+
+
+------
+RETURN
+------
+
+
+All methods return a value of type :c:type:`memcached_return_t`.
+On success the value will be :c:type:`MEMCACHED_SUCCESS`.
+Use :c:func:`memcached_strerror` to translate this value to a printable
+string.
+
+
+----
+HOME
+----
+
+
+To find out more information please check:
+`http://libmemcached.org/ <http://libmemcached.org/>`_
+
+
+--------
+SEE ALSO
+--------
+
+
+:manpage:`memcached(1)` :manpage:`libmemached(3)` :manpage:`memcached_strerror(3)` :manpage:`memcached_set(3)` :manpage:`memcached_add(3)` :manpage:`memcached_cas(3)` :manpage:`memcached_replace(3)`
+
--- /dev/null
+====================================
+Incrementing and Decrementing Values
+====================================
+
+.. index:: object: memcached_st
+
+--------
+SYNOPSIS
+--------
+
+#include <libmemcached/memcached.h>
+
+.. c:function:: memcached_return_t memcached_increment (memcached_st *ptr, const char *key, size_t key_length, uint32_t offset, uint64_t *value)
+
+.. c:function:: memcached_return_t memcached_decrement (memcached_st *ptr, const char *key, size_t key_length, uint32_t offset, uint64_t *value)
+
+.. c:function:: memcached_return_t memcached_increment_with_initial (memcached_st *ptr, const char *key, size_t key_length, uint64_t offset, uint64_t initial, time_t expiration, uint64_t *value)
+
+.. c:function:: memcached_return_t memcached_decrement_with_initial (memcached_st *ptr, const char *key, size_t key_length, uint64_t offset, uint64_t initial, time_t expiration, uint64_t *value)
+
+.. c:function:: memcached_return_t memcached_increment_by_key (memcached_st *ptr, const char *group_key, size_t group_key_length, const char *key, size_t key_length, uint32_t offset, uint64_t *value)
+
+.. c:function:: memcached_return_t memcached_decrement_by_key (memcached_st *ptr, const char *group_key, size_t group_key_length, const char *key, size_t key_length, uint32_t offset, uint64_t *value)
+
+.. c:function:: memcached_return_t memcached_increment_with_initial_by_key (memcached_st *ptr, const char *group_key, size_t group_key_length, const char *key, size_t key_length, uint64_t offset, uint64_t initial, time_t expiration, uint64_t *value)
+
+.. c:function:: memcached_return_t memcached_decrement_with_initial_by_key (memcached_st *ptr, const char *group_key, size_t group_key_length, const char *key, size_t key_length, uint64_t offset, uint64_t initial, time_t expiration, uint64_t *value)
+
+Compile and link with -lmemcached
+
+
+-----------
+DESCRIPTION
+-----------
+
+
+:manpage:`memcached(1)` servers have the ability to increment and decrement keys
+(overflow and underflow are not detected). This gives you the ability to use
+memcached to generate shared sequences of values.
+
+memcached_increment takes a key and keylength and increments the value by
+the offset passed to it. The value is then returned via the uint32_t
+value pointer you pass to it.
+
+memcached_decrement takes a key and keylength and decrements the value by
+the offset passed to it. The value is then returned via the uint32_t
+value pointer you pass to it.
+
+memcached_increment_with_initial takes a key and keylength and increments
+the value by the offset passed to it. If the object specified by key does
+not exist, one of two things may happen: If the expiration value is
+MEMCACHED_EXPIRATION_NOT_ADD, the operation will fail. For all other
+expiration values, the operation will succeed by seeding the value for that
+key with a initial value to expire with the provided expiration time. The
+flags will be set to zero.The value is then returned via the uint32_t
+value pointer you pass to it. memcached_increment_with_initial is only available
+when using the binary protocol.
+
+memcached_decrement_with_initial takes a key and keylength and decrements
+the value by the offset passed to it. If the object specified by key does
+not exist, one of two things may happen: If the expiration value is
+MEMCACHED_EXPIRATION_NOT_ADD, the operation will fail. For all other
+expiration values, the operation will succeed by seeding the value for that
+key with a initial value to expire with the provided expiration time. The
+flags will be set to zero.The value is then returned via the uint32_t
+value pointer you pass to it. memcached_decrement_with_initial is only available
+when using the binary protocol.
+
+:c:func:`memcached_increment_by_key`, :c:func:`memcached_decrement_by_key`,
+:c:func:`memcached_increment_with_initial_by_key`, and
+:c:func:`memcached_decrement_with_initial_by_key` are master key equivalents of the above.
+
+
+------
+RETURN
+------
+
+
+A value of type :c:type:`memcached_return_t` is returned.
+On success that value will be :c:type:`MEMCACHED_SUCCESS`.
+Use memcached_strerror to translate this value to a printable string.
+
+
+----
+HOME
+----
+
+
+To find out more information please check:
+`http://libmemcached.org/ <http://libmemcached.org/>`_
+
+
+--------
+SEE ALSO
+--------
+
+
+:manpage:`memcached(1)` :manpage:`libmemcached(3)` :manpage:`memcached_strerror(3)`
--- /dev/null
+================================
+Modifying how the driver behaves
+================================
+
+
+Manipulate the behavior of a memcached_st structure.
+
+.. index:: object: memcached_st
+
+
+--------
+SYNOPSIS
+--------
+
+
+#include <libmemcached/memcached.h>
+
+.. c:type:: memcached_behavior_t
+
+.. c:function:: uint64_t memcached_behavior_get (memcached_st *ptr, memcached_behavior_t flag)
+
+.. c:function:: memcached_return_t memcached_behavior_set (memcached_st *ptr, memcached_behavior_t flag, uint64_t data)
+
+Compile and link with -lmemcached
+
+
+-----------
+DESCRIPTION
+-----------
+
+:manpage:`libmemcached(3)` behavior can be modified by using :c:func:`memcached_behavior_set`. Default behavior is the library strives to be quick and
+accurate. Some behavior, while being faster, can also result in not entirely
+accurate behavior (for instance, :c:func:`memcached_set` will always respond
+with :c:type:`MEMCACHED_SUCCESS`).
+
+:c:func:`memcached_behavior_get` takes a behavior flag and returns whether or not that behavior is currently enabled in the client.
+
+:c:func:`memcached_behavior_set` changes the value of a particular option
+of the client. It takes both a flag (listed below) and a value. For simple
+on or off options you just need to pass in a value of 1. Calls to
+:c:func:`memcached_behavior_set` will flush and reset all connections.
+
+
+.. c:type:: MEMCACHED_BEHAVIOR_USE_UDP
+
+Causes :manpage:`libmemcached(3)` to use the UDP transport when communicating
+with a memcached server. Not all I/O operations are testsed
+when this behavior is enababled. The following operations will return
+:c:type:`MEMCACHED_NOT_SUPPORTED` when executed with the
+:c:type:`MEMCACHED_BEHAVIOR_USE_UDP` enabled: :c:func:`memcached_version`,
+:c:func:`memcached_stat`, :c:func:`memcached_get`,
+:c:func:`memcached_get_by_key`, :c:func:`memcached_mget`,
+:c:func:`memcached_mget_by_key`, :c:func:`memcached_fetch`,
+:c:func:`memcached_fetch_result`, :c:func:`memcached_fetch_execute`.
+
+All other operations are testsed but are executed in a 'fire-and-forget'
+mode, in which once the client has executed the operation, no attempt
+will be made to ensure the operation has been received and acted on by the
+server.
+
+:manpage:`libmemcached(3)` does not allow TCP and UDP servers to be shared
+within the same libmemached(3) client 'instance'. An attempt to add a TCP
+server when this behavior is enabled will result in a :c:type:`MEMCACHED_INVALID_HOST_PROTOCOL`, as will attempting to add a UDP server when this behavior has
+not been enabled.
+
+
+
+.. c:type:: MEMCACHED_BEHAVIOR_NO_BLOCK
+
+Causes :manpage:`libmemcached(3)` to use asychronous IO. This is the fastest
+transport available for storage functions.
+
+
+.. c:type:: MEMCACHED_BEHAVIOR_SND_TIMEOUT
+
+This sets the microsecond behavior of the socket against the SO_SNDTIMEO flag. In cases where you cannot use non-blocking IO this will allow you to still have timeouts on the sending of data.
+
+
+.. c:type:: MEMCACHED_BEHAVIOR_RCV_TIMEOUT
+
+This sets the microsecond behavior of the socket against the SO_RCVTIMEO flag.
+
+In cases where you cannot use non-blocking IO this will allow you to still have timeouts on the reading of data.
+
+
+
+.. c:type:: MEMCACHED_BEHAVIOR_TCP_NODELAY
+
+Turns on the no-delay feature for connecting sockets (may be faster in some
+environments).
+
+
+
+.. c:type:: MEMCACHED_BEHAVIOR_HASH
+
+Makes the default hashing algorithm for keys use MD5. The value can be set to either :c:type:`MEMCACHED_HASH_DEFAULT`, :c:type:`MEMCACHED_HASH_MD5`, :c:type:`MEMCACHED_HASH_CRC`, :c:type:`MEMCACHED_HASH_FNV1_64`, :c:type:`MEMCACHED_HASH_FNV1A_64`, :c:type:`MEMCACHED_HASH_FNV1_32`, :c:type:`MEMCACHED_HASH_FNV1A_32`, :c:type:`MEMCACHED_HASH_JENKINS`, :c:type:`MEMCACHED_HASH_HSIEH`, and :c:type:`MEMCACHED_HASH_MURMUR`.
+
+Each hash has it's advantages and it's weaknesses. If you don't know or don't
+care, just go with the default.
+
+Support for :c:type:`MEMCACHED_HASH_HSIEH` is a compile time option that is disabled by default. To enable tests for this hashing algorithm, configure and build libmemcached with the --enable-hash_hsieh.
+
+
+
+.. c:type:: MEMCACHED_BEHAVIOR_DISTRIBUTION
+
+Using this you can enable different means of distributing values to servers.
+
+The default method is MEMCACHED_DISTRIBUTION_MODULA. You can enable consistent hashing by setting MEMCACHED_DISTRIBUTION_CONSISTENT. Consistent hashing delivers better distribution and allows servers to be added to the cluster with minimal cache losses. Currently MEMCACHED_DISTRIBUTION_CONSISTENT is an alias for the value MEMCACHED_DISTRIBUTION_CONSISTENT_KETAMA.
+
+.. c:type:: MEMCACHED_BEHAVIOR_CACHE_LOOKUPS
+.. deprecated:: 0.46(?)
+ DNS lookups are now always cached until an error occurs with the server.
+
+ Memcached can cache named lookups so that DNS lookups are made only once.
+
+.. c:type:: MEMCACHED_BEHAVIOR_SUPPORT_CAS
+
+Support CAS operations (this is not enabled by default at this point in the server since it imposes a slight performance penalty).
+
+
+.. c:type:: MEMCACHED_BEHAVIOR_KETAMA
+
+Sets the default distribution to MEMCACHED_DISTRIBUTION_CONSISTENT_KETAMA and
+the hash to :c:type:`MEMCACHED_HASH_MD5`.
+
+
+.. c:type:: MEMCACHED_BEHAVIOR_KETAMA_WEIGHTED
+
+ Sets the default distribution to MEMCACHED_DISTRIBUTION_CONSISTENT_KETAMA with the weighted tests. and the hash to MEMCACHED_HASH_MD5.
+
+.. c:type:: MEMCACHED_BEHAVIOR_KETAMA_HASH
+
+Sets the hashing algorithm for host mapping on continuum. The value can be set
+to either :c:type:`MEMCACHED_HASH_DEFAULT`, :c:type:`MEMCACHED_HASH_MD5`,
+:c:type:`MEMCACHED_HASH_CRC`, :c:type:`MEMCACHED_HASH_FNV1_64`,
+:c:type:`MEMCACHED_HASH_FNV1A_64`, :c:type:`MEMCACHED_HASH_FNV1_32`, and
+:c:type:`MEMCACHED_HASH_FNV1A_32`.
+
+.. c:type:: MEMCACHED_BEHAVIOR_KETAMA_COMPAT
+
+Sets the compatibility mode. The value can be set to either MEMCACHED_KETAMA_COMPAT_LIBMEMCACHED (this is the default) or MEMCACHED_KETAMA_COMPAT_SPY to be compatible with the SPY Memcached client for Java.
+
+.. c:type:: MEMCACHED_BEHAVIOR_POLL_TIMEOUT
+
+Modify the timeout value that is used by poll. The default value is -1. An signed int must be passed to memcached_behavior_set to change this value (this requires casting). For memcached_behavior_get a signed int value will be cast and returned as the unsigned long long.
+
+.. c:type:: MEMCACHED_BEHAVIOR_USER_DATA
+.. deprecated:: < 0.30
+
+.. c:type:: MEMCACHED_BEHAVIOR_BUFFER_REQUESTS
+
+Enabling buffered IO causes commands to "buffer" instead of being sent. Any action that gets data causes this buffer to be be sent to the remote connection. Quiting the connection or closing down the connection will also cause the buffered data to be pushed to the remote connection.
+
+
+.. c:type:: MEMCACHED_BEHAVIOR_VERIFY_KEY
+
+Enabling this will cause :manpage:`libmemcached(3)` to test all keys to verify that they are valid keys.
+
+
+
+.. c:type:: MEMCACHED_BEHAVIOR_SORT_HOSTS
+
+Enabling this will cause hosts that are added to be placed in the host list in sorted order. This will defeat consisten hashing.
+
+
+.. c:type:: MEMCACHED_BEHAVIOR_CONNECT_TIMEOUT
+
+In non-blocking mode this changes the value of the timeout during socket connection in milliseconds. Specifying -1 means an infinite time‐out.
+
+
+.. c:type:: MEMCACHED_BEHAVIOR_BINARY_PROTOCOL
+
+Enable the use of the binary protocol. Please note that you cannot toggle this flag on an open connection.
+
+
+
+.. c:type:: MEMCACHED_BEHAVIOR_SERVER_FAILURE_LIMIT
+
+Set this value to enable the server be removed after continuous MEMCACHED_BEHAVIOR_SERVER_FAILURE_LIMIT times connection failure.
+
+
+
+.. c:type:: MEMCACHED_BEHAVIOR_IO_MSG_WATERMARK
+
+Set this value to tune the number of messages that may be sent before libmemcached should start to automatically drain the input queue. Setting this value to high, may cause libmemcached to deadlock (trying to send data, but the send will block because the input buffer in the kernel is full).
+
+
+
+.. c:type:: MEMCACHED_BEHAVIOR_IO_BYTES_WATERMARK
+
+Set this value to tune the number of bytes that may be sent before libmemcached should start to automatically drain the input queue (need at least 10 IO requests sent without reading the input buffer). Setting this value to high, may cause libmemcached to deadlock (trying to send data, but the send will block because the input buffer in the kernel is full).
+
+
+
+.. c:type:: MEMCACHED_BEHAVIOR_IO_KEY_PREFETCH
+
+The binary protocol works a bit different than the textual protocol in that a multiget is implemented as a pipe of single get-operations which are sent to the server in a chunk. If you are using large multigets from your application, you may improve the latency of the gets by setting this value so you send out the first chunk of requests when you hit the specified limit. It allows the servers to start processing the requests to send the data back while the rest of the requests are created and sent to the server.
+
+
+
+.. c:type:: MEMCACHED_BEHAVIOR_NOREPLY
+
+Set this value to specify that you really don't care about the result from your storage commands (set, add, replace, append, prepend).
+
+
+
+.. c:type:: MEMCACHED_BEHAVIOR_NUMBER_OF_REPLICAS
+
+If you just want "a poor mans HA", you may specify the numbers of replicas libmemcached should store of each item (on different servers). This replication does not dedicate certain memcached servers to store the replicas in, but instead it will store the replicas together with all of the other objects (on the 'n' next servers specified in your server list).
+
+
+
+.. c:type:: MEMCACHED_BEHAVIOR_RANDOMIZE_REPLICA_READ
+
+Allows randomizing the replica reads starting point. Normally the read is done from primary server and in case of miss the read is done from primary + 1, then primary + 2 all the way to 'n' replicas. If this option is set on the starting point of the replica reads is randomized between the servers. This allows distributing read load to multiple servers with the expense of more write traffic.
+
+
+
+.. c:type:: MEMCACHED_BEHAVIOR_CORK
+
+This open has been deprecated with the behavior now built and used appropriately on selected platforms.
+
+
+.. c:type:: MEMCACHED_BEHAVIOR_KEEPALIVE
+
+Enable TCP_KEEPALIVE behavior.
+
+
+
+.. c:type:: MEMCACHED_BEHAVIOR_KEEPALIVE_IDLE
+
+Specify time, in seconds, to mark a connection as idle. This is only available as an option Linux.
+
+
+.. c:type:: MEMCACHED_BEHAVIOR_SOCKET_SEND_SIZE
+
+Find the current size of SO_SNDBUF. A value of 0 means either an error occured or no hosts were available. It is safe to assume system default if this occurs. If an error occurs you can checked the last cached errno statement to find the specific error.
+
+
+.. c:type:: MEMCACHED_BEHAVIOR_SOCKET_RECV_SIZE
+
+Find the current size of SO_RCVBUF. A value of 0 means either an error occured or no hosts were available. It is safe to assume system default if this occurs. If an error occurs you can checked the last cached errno statement to find the specific error.
+
+
+.. c:type:: MEMCACHED_BEHAVIOR_SERVER_FAILURE_LIMIT
+.. deprecated:: 0.48
+ See :c:type:`MEMCACHED_BEHAVIOR_REMOVE_FAILED_SERVERS`
+
+ This number of times a host can have an error before it is disabled.
+
+
+.. c:type:: MEMCACHED_BEHAVIOR_AUTO_EJECT_HOSTS
+.. deprecated:: 0.48
+ See :c:type:`MEMCACHED_BEHAVIOR_REMOVE_FAILED_SERVERS`
+
+ If enabled any hosts which have been flagged as disabled will be removed from the list of servers in the memcached_st structure. This must be used in combination with MEMCACHED_BEHAVIOR_SERVER_FAILURE_LIMIT.
+
+.. c:type:: MEMCACHED_BEHAVIOR_REMOVE_FAILED_SERVERS
+
+ If enabled any hosts which have been flagged as disabled will be removed from the list of servers in the memcached_st structure.
+
+.. c:type:: MEMCACHED_BEHAVIOR_RETRY_TIMEOUT
+
+When enabled a host which is problematic will only be checked for usage based on the amount of time set by this behavior. The value is in seconds.
+
+
+.. c:type:: MEMCACHED_BEHAVIOR_HASH_WITH_PREFIX_KEY
+
+When enabled the prefix key will be added to the key when determining server
+by hash. See :c:type:`MEMCACHED_CALLBACK_NAMESPACE` for additional
+information.
+
+
+
+
+------
+RETURN
+------
+
+
+memcached_behavior_get returns either the current value of the get, or 0
+or 1 on simple flag behaviors (1 being enabled). memcached_behavior_set
+returns failure or success.
+
+
+-----
+NOTES
+-----
+
+
+memcached_behavior_set in version .17 was changed from taking a pointer
+to data value, to taking a uin64_t.
+
+
+----
+HOME
+----
+
+
+To find out more information please check:
+`http://libmemcached.org/ <http://libmemcached.org/>`_
+
+
+
+--------
+SEE ALSO
+--------
+
+
+:manpage:`memcached(1)` :manpage:`libmemcached(3)` :manpage:`memcached_strerror(3)`
--- /dev/null
+=================
+Setting callbacks
+=================
+
+
+Get and set a callback
+
+.. index:: object: memcached_st
+
+
+--------
+SYNOPSIS
+--------
+
+#include <libmemcached/memcached.h>
+
+.. c:type:: memcached_callback_t
+
+.. c:function:: memcached_return_t memcached_callback_set (memcached_st *ptr, memcached_callback_t flag, const void *data)
+
+.. c:function:: void * memcached_callback_get (memcached_st *ptr, memcached_callback_t flag, memcached_return_t *error)
+
+Compile and link with -lmemcached
+
+
+-----------
+DESCRIPTION
+-----------
+
+
+libmemcached(3) can have callbacks set key execution points. These either
+provide function calls at points in the code, or return pointers to
+structures for particular usages.
+
+:c:func:`memcached_callback_get` takes a callback flag and returns the
+structure or function set by :c:func:`memcached_callback_set`.
+
+:c:func:`memcached_callback_set` changes the function/structure assigned by a
+callback flag. No connections are reset.
+
+You can use :c:type:`MEMCACHED_CALLBACK_USER_DATA` to provide custom context
+if required for any of the callbacks.
+
+
+.. c:type:: MEMCACHED_CALLBACK_CLEANUP_FUNCTION
+
+When :c:func:`memcached_delete` is called this function will be excuted. At
+the point of its execution all connections are closed.
+
+
+
+.. c:type:: MEMCACHED_CALLBACK_CLONE_FUNCTION
+
+When :c:func:`memcached_delete` is called this function will be excuted.
+At the point of its execution all connections are closed.
+
+.. c:type:: MEMCACHED_CALLBACK_PREFIX_KEY
+
+ See :c:type:`MEMCACHED_CALLBACK_NAMESPACE`
+
+.. c:type:: MEMCACHED_CALLBACK_NAMESPACE
+
+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 :c:macro:`MEMCACHED_PREFIX_KEY_MAX_SIZE` - 1 and will
+reduce :c:macro:`MEMCACHED_MAX_KEY` by the value of your key.
+
+The prefix key is only applied to the primary key, not the master key.
+:c:type:`MEMCACHED_FAILURE` will be returned if no key is set. In the case of
+a key which is too long, :c:type:`MEMCACHED_BAD_KEY_PROVIDED` will be returned.
+
+If you set a value with the value being NULL then the prefix key is disabled.
+
+.. c:type:: MEMCACHED_CALLBACK_USER_DATA
+
+This allows you to store a pointer to a specifc piece of data. This can be
+retrieved from inside of :c:func:`memcached_fetch_execute`. Cloning a
+:c:type:`memcached_st` will copy the pointer to the clone.
+
+.. c:type:: MEMCACHED_CALLBACK_MALLOC_FUNCTION
+.. deprecated:: <0.32
+ Use :c:type:`memcached_set_memory_allocators` instead.
+
+.. c:type:: MEMCACHED_CALLBACK_REALLOC_FUNCTION
+.. deprecated:: <0.32
+ Use :c:type:`memcached_set_memory_allocators` instead.
+
+.. c:type:: MEMCACHED_CALLBACK_FREE_FUNCTION
+.. deprecated:: <0.32
+ Use :c:type:`memcached_set_memory_allocators` instead.
+
+.. c:type:: 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 :c:type:`memcached_st` in order to
+make use of it. The value will be stored only if you return
+:c:type:`MEMCACHED_SUCCESS` or :c:type:`MEMCACHED_BUFFERED`. Returning
+:c:type:`MEMCACHED_BUFFERED` will cause the object to be buffered and not sent
+immediatly (if this is the default behavior based on your connection setup
+this will happen automatically).
+
+The prototype for this is:
+
+.. c:function:: memcached_return_t (\*memcached_trigger_key)(memcached_st \*ptr, char \*key, size_t key_length, memcached_result_st \*result);
+
+
+
+.. c:type:: 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.
+
+The prototype for this is:
+
+.. c:function:: typedef memcached_return_t (\*memcached_trigger_delete_key)(memcached_st \*ptr, char \*key, size_t key_length);
+
+
+
+
+------
+RETURN
+------
+
+
+:c:func:`memcached_callback_get` return the function or structure that was
+provided. Upon error, nothing is set, null is returned, and the
+:c:type:`memcached_return_t` argument is set to :c:type:`MEMCACHED_FAILURE`.
+
+:c:func:`memcached_callback_set` returns :c:type:`MEMCACHED_SUCCESS` upon
+successful setting, otherwise :c:type:`MEMCACHED_FAILURE` on error.
+
+
+----
+HOME
+----
+
+
+To find out more information please check:
+`http://libmemcached.org/ <http://libmemcached.org/>`_
+
+
+------
+AUTHOR
+------
+
+
+Brian Aker, <brian@tangent.org>
+
+
+--------
+SEE ALSO
+--------
+
+
+:manpage:`memcached(1)` :manpage:`libmemcached(3)` :manpage:`memcached_strerror(3)`
--- /dev/null
+====================================================
+Working with data on the server in an atomic fashion
+====================================================
+
+.. index:: object: memcached_st
+
+
+--------
+SYNOPSIS
+--------
+
+
+#include <libmemcached/memcached.h>
+
+.. c:function:: memcached_return_t memcached_cas(memcached_st *ptr, const char *key, size_t key_length, const char *value, size_t value_length, time_t expiration, uint32_t flags, uint64_t cas)
+
+.. c:function:: memcached_return_t memcached_cas_by_key(memcached_st *ptr, const char *group_key, size_t group_key_length, const char *key, size_t key_length, const char *value, size_t value_length, time_t expiration, uint32_t flags, uint64_t cas)
+
+Compile and link with -lmemcached
+
+
+-----------
+DESCRIPTION
+-----------
+
+:c:func:`memcached_cas` overwrites data in the server as long as the "cas"
+value is still the same in the server. You can get the cas value of a result
+by calling :c:func:`memcached_result_cas` on a memcached_result_st(3)
+structure. At the point that this note was written cas is still buggy in memached. Turning on tests for it in libmemcached(3) is optional. Please see
+:c:func:`memcached_set` for information on how to do this.
+
+:c:func:`memcached_cas_by_key` method behaves in a similar method as the non
+key methods. The difference is that it uses the group_key parameter
+to map objects to particular servers.
+
+:c:func:`memcached_cas` is testsed with the :c:type:`MEMCACHED_BEHAVIOR_USE_UDP` behavior enabled. However, when using these operations with this behavior
+on, there are limits to the size of the payload being sent to the server. The
+reason for these limits is that the Memcached Server does not allow
+multi-datagram requests and the current server implementation sets a datagram
+size to 1400 bytes. Due to protocol overhead, the actual limit of the user
+supplied data is less than 1400 bytes and depends on the protocol in use as,
+well as the operation being executed. When running with the binary protocol,
+:c:type:`MEMCACHED_BEHAVIOR_BINARY_PROTOCOL`, the size of the key,value,
+flags and expiry combined may not exceed 1368 bytes. When running with the
+ASCII protocol, the exact limit fluctuates depending on which function is
+being executed and whether the function is a cas operation or not. For
+non-cas ASCII set operations, there are at least 1335 bytes available to
+split among the key, key_prefix, and value; for cas ASCII operations there
+are at least 1318 bytes available to split among the key, key_prefix and value. If the total size of the command, including overhead, exceeds 1400 bytes, a :c:type:`MEMCACHED_WRITE_FAILURE` will be returned.
+
+
+------
+RETURN
+------
+
+
+All methods return a value of type :c:type:`memcached_return_t`.
+On success the value will be :c:type:`MEMCACHED_SUCCESS`.
+Use :c:func:`memcached_strerror` to translate this value to a printable
+string.
+
+
+----
+HOME
+----
+
+
+To find out more information please check:
+`http://libmemcached.org/ <http://libmemcached.org/>`_
+
+
+--------
+SEE ALSO
+--------
+
+
+:manpage:`memcached(1)` :manpage:`libmemached(3)` :manpage:`memcached_strerror(3)` :manpage:`memcached_set(3)` :manpage:`memcached_append(3)` :manpage:`memcached_add(3)` :manpage:`memcached_prepend(3)` :manpage:`memcached_replace(3)`
+
--- /dev/null
+======================================
+Creating and destroying a memcached_st
+======================================
+
+--------
+SYNOPSIS
+--------
+
+#include <libmemcached/memcached.h>
+
+.. c:type:: memcached_st
+
+.. c:function:: memcached_st* memcached_create(memcached_st *ptr)
+
+.. c:function:: void memcached_free(memcached_st *ptr)
+
+.. c:function:: memcached_st* memcached_clone(memcached_st *destination, memcached_st *source)
+
+.. c:function:: void memcached_servers_reset(memcached_st)
+
+Compile and link with -lmemcached
+
+
+-----------
+DESCRIPTION
+-----------
+
+:c:func:`memcached_create` is used to create a :c:type:`memcached_st`
+structure that will then be used by other libmemcached(3) functions to
+communicate with the server. You should either pass a statically declared
+:c:type:`memcached_st` to :c:func:`memcached_create` or
+a NULL. If a NULL passed in then a structure is allocated for you.
+
+Please note, when you write new application use
+:c:func:`memcached` over :c:func:`memcached_create`.
+
+:c:func:`memcached_clone` is similar to :c:func:`memcached_create` but
+it copies the defaults and list of servers from the source
+:c:type:`memcached_st`. If you pass a null as the argument for the source
+to clone, it is the same as a call to :c:func:`memcached_create`.
+If the destination argument is NULL a :c:type:`memcached_st` will be allocated
+for you.
+
+:c:func:`memcached_servers_reset` allows you to zero out the list of
+servers that the :c:type:`memcached_st` has.
+
+To clean up memory associated with a :c:type:`memcached_st` structure you
+should pass it to :c:func:`memcached_free` when you are finished using it.
+:c:func:`memcached_free` is the only way to make sure all memory is
+deallocated when you finish using the structure.
+
+You may wish to avoid using memcached_create(3) or memcached_clone(3) with a
+stack based allocation. The most common issues related to ABI safety involve
+heap allocated structures.
+
+
+------
+RETURN
+------
+
+
+:c:func:`memcached_create` returns a pointer to the :c:type:`memcached_st`
+that was created (or initialized). On an allocation failure, it returns NULL.
+
+:c:func:`memcached_clone` returns a pointer to the :c:type:`memcached_st`
+that was created (or initialized). On an allocation failure, it returns NULL.
+
+
+----
+HOME
+----
+
+
+To find out more information please check:
+`http://libmemcached.org/ <http://libmemcached.org/>`_
+
+
+--------
+SEE ALSO
+--------
+
+
+:manpage:`memcached(1)` :manpage:`libmemcached(3)` :manpage:`memcached_strerror(3)`
--- /dev/null
+===========================
+Deleting data from a server
+===========================
+
+.. index:: object: memcached_st
+
+--------
+SYNOPSIS
+--------
+
+
+#include <libmemcached/memcached.h>
+
+.. c:function:: memcached_return_t memcached_delete (memcached_st *ptr, const char *key, size_t key_length, time_t expiration)
+
+.. c:function:: memcached_return_t memcached_delete_by_key (memcached_st *ptr, const char *group_key, size_t group_key_length, const char *key, size_t key_length, time_t expiration)
+
+Compile and link with -lmemcached
+
+-----------
+DESCRIPTION
+-----------
+
+
+:c:func:`memcached_delete` is used to delete a particular key.
+:c:func:`memcached_delete_by_key` works the same, but it takes a master key
+to find the given value.
+
+Expiration works by placing the item into a delete queue, which means that
+it won't be possible to retrieve it by the "get" command. The "add" and
+"replace" commands with this key will also fail (the "set" command will
+succeed, however). After the time passes, the item is finally deleted from server memory.
+
+Please note the the Danga memcached server removed tests for expiration in
+the 1.4 version.
+
+
+------
+RETURN
+------
+
+
+A value of type :c:type:`memcached_return_t` is returned
+On success that value will be :c:type:`MEMCACHED_SUCCESS`.
+Use :c:func:`memcached_strerror` to translate this value to a printable
+string.
+
+If you are using the non-blocking mode of the library, success only
+means that the message was queued for delivery.
+
+
+----
+HOME
+----
+
+
+To find out more information please check:
+`http://libmemcached.org/ <http://libmemcached.org/>`_
+
+
+------
+AUTHOR
+------
+
+
+Brian Aker, <brian@tangent.org>
+
+
+--------
+SEE ALSO
+--------
+
+:manpage:`memcached(1)` :manpage:`libmemcached(3)` :manpage:`memcached_strerror(3)`
--- /dev/null
+==========================
+Dumping data from a server
+==========================
+
+
+Get a list of keys found on memcached servers
+
+.. index:: object: memcached_st
+
+
+--------
+SYNOPSIS
+--------
+
+
+#include <libmemcached/memcached.h>
+
+.. c:function:: memcached_return_t memcached_dump (memcached_st *ptr, memcached_dump_fn *function, void *context, uint32_t number_of_callbacks)
+
+.. c:type:: memcached_return_t (*memcached_dump_fn)(memcached_st *ptr, const char *key, size_t key_length, void *context)
+
+Compile and link with -lmemcached
+
+
+
+-----------
+DESCRIPTION
+-----------
+
+
+:c:func:`memcached_dump` is used to get a list of keys found in memcached(1)
+servers. Because memcached(1) does not guarentee to dump all keys you can not
+assume you have fetched all keys from the server. The function takes an array
+of callbacks that it will use to execute on keys as they are found.
+
+Currently the binary protocol is not testsed.
+
+
+------
+RETURN
+------
+
+
+A value of type :c:type:`memcached_return_t` is returned
+On success that value will be :c:type:`MEMCACHED_SUCCESS`.
+Use :c:func:`memcached_strerror` to translate this value to a printable
+string.
+
+
+----
+HOME
+----
+
+
+To find out more information please check:
+`http://libmemcached.org/ <http://libmemcached.org/>`_
+
+
+------
+AUTHOR
+------
+
+
+Brian Aker, <brian@tangent.org>
+
+
+--------
+SEE ALSO
+--------
+
+
+:manpage:`memcached(1)` :manpage:`libmemcached(3)` :manpage:`memcached_strerror(3)`
--- /dev/null
+=====================================
+Wiping clean the contents of a server
+=====================================
+
+.. index:: object: memcached_st
+
+Wipe contents of memcached servers
+
+
+--------
+SYNOPSIS
+--------
+
+
+#include <libmemcached/memcached.h>
+
+.. c:function:: memcached_return_t memcached_flush (memcached_st *ptr, time_t expiration)
+
+Compile and link with -lmemcached
+
+
+-----------
+DESCRIPTION
+-----------
+
+
+:c:func::`memcached_flush` is used to wipe clean the contents of :program:`memcached` servers.
+It will either do this immediately or expire the content based on the
+expiration time passed to the method (a value of zero causes an immediate
+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.
+
+
+------
+RETURN
+------
+
+
+A value of type :c:type:`memcached_return_t` is returned
+On success that value will be :c:type:`MEMCACHED_SUCCESS`.
+Use :c:type:`memcached_strerror` to translate this value to a printable string.
+
+----
+HOME
+----
+
+
+To find out more information please check:
+`http://libmemcached.org/ <http://libmemcached.org/>`_
+
+
+------
+AUTHOR
+------
+
+
+Brian Aker, <brian@tangent.org>
+
+
+--------
+SEE ALSO
+--------
+
+:manpage:`memcached(1)` :manpage:`libmemcached(3)` :manpage:`memcached_strerror(3)`
--- /dev/null
+=======================
+Flushing client buffers
+=======================
+
+
+.. index:: object: memcached_st
+
+Flush and senf buffered commands
+
+--------
+SYNOPSIS
+--------
+
+#include <libmemcached/memcached.h>
+
+.. c:function:: memcached_return_t memcached_flush_buffers (memcached_st *ptr)
+
+Compile and link with -lmemcached
+
+
+-----------
+DESCRIPTION
+-----------
+
+
+:c:func:`memcached_flush_buffers` is used in conjunction with
+:c:type:`MEMCACHED_BEHAVIOR_BUFFER_REQUESTS` (see memcached_behavior(3)) to flush all buffers by sending the buffered commands to the server for processing.
+
+
+------
+RETURN
+------
+
+
+A value of type :c:type:`memcached_return_t` is returned
+On success that value will be :c:type:`MEMCACHED_SUCCESS`.
+Use :c:func:`memcached_strerror` to translate this value to a printable
+string.
+
+
+----
+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>
+
+
+--------
+SEE ALSO
+--------
+
+
+:manpage:`memcached(1)` :manpage:`libmemcached(3)` :manpage:`memcached_strerror(3)`
--- /dev/null
+===============================
+Generating hash values directly
+===============================
+
+.. index:: object: memcached_st
+
+Hash a key value
+
+
+--------
+SYNOPSIS
+--------
+
+
+#include <libmemcached/memcached.h>
+
+.. c:type:: memcached_hash_t
+
+.. c:function:: uint32_t memcached_generate_hash_value (const char *key, size_t key_length, memcached_hash_t hash_algorithm)
+
+.. c:function:: uint32_t memcached_generate_hash (memcached_st *ptr, const char *key, size_t key_length)
+
+.. c:type:: MEMCACHED_HASH_DEFAULT
+
+.. c:type:: MEMCACHED_HASH_MD5
+
+.. c:type:: MEMCACHED_HASH_CRC
+
+.. c:type:: MEMCACHED_HASH_FNV1_64
+
+.. c:type:: MEMCACHED_HASH_FNV1A_64
+
+.. c:type:: MEMCACHED_HASH_FNV1_32
+
+.. c:type:: MEMCACHED_HASH_FNV1A_32
+
+.. c:type:: MEMCACHED_HASH_JENKINS
+
+.. c:type:: MEMCACHED_HASH_MURMUR
+
+.. c:type:: MEMCACHED_HASH_HSIEH
+
+.. c:type:: MEMCACHED_HASH_MURMUR3
+
+
+Compile and link with -lmemcachedutil -lmemcached
+
+
+-----------
+DESCRIPTION
+-----------
+
+
+:c:func:`memcached_generate_hash_value` allows you to hash a key using one of
+the hash functions defined in the library. This method is provided for
+the convenience of higher-level language bindings and is not necessary
+for normal memcache operations.
+
+The allowed hash algorithm constants are listed in the manpage for
+:c:func:`memcached_behavior_set`.
+
+:c:func:`memcached_generate_hash` takes a :c:type:`memcached_st` struture
+and produces the hash value that would have been generated based on the
+defaults of :c:type:`memcached_st`.
+
+As of version 0.36 all hash methods have been placed into the library
+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.
+For 64-bit hash algorithms, only the least-significant 32 bits are
+returned.
+
+
+----
+HOME
+----
+
+
+To find out more information please check:
+`http://libmemcached.org/ <http://libmemcached.org/>`_
+
+
+------
+AUTHOR
+------
+
+
+Brian Aker, <brian@tangent.org>
+
+
+--------
+SEE ALSO
+--------
+
+
+:manpage:`memcached(1)` :manpage:`libmemcached(3)` :manpage:`memcached_strerror(3)`
--- /dev/null
+===============================
+Retrieving data from the server
+===============================
+
+.. index:: object: memcached_st
+
+--------
+SYNOPSIS
+--------
+
+
+#include <libmemcached/memcached.h>
+
+.. c:function:: memcached_result_st * memcached_fetch_result (memcached_st *ptr, memcached_result_st *result, memcached_return_t *error)
+
+.. c:function:: char * memcached_get (memcached_st *ptr, const char *key, size_t key_length, size_t *value_length, uint32_t *flags, memcached_return_t *error)
+
+.. c:function:: memcached_return_t memcached_mget (memcached_st *ptr, const char * const *keys, const size_t *key_length, size_t number_of_keys)
+
+.. c:function:: char * memcached_get_by_key (memcached_st *ptr, const char *group_key, size_t group_key_length, const char *key, size_t key_length, size_t *value_length, uint32_t *flags, memcached_return_t *error)
+
+.. c:function:: memcached_return_t memcached_mget_by_key (memcached_st *ptr, const char *group_key, size_t group_key_length, const char * const *keys, const size_t *key_length, size_t number_of_keys)
+
+.. c:function:: memcached_return_t memcached_fetch_execute (memcached_st *ptr, memcached_execute_fn *callback, void *context, uint32_t number_of_callbacks)
+
+.. c:function:: memcached_return_t memcached_mget_execute (memcached_st *ptr, const char * const *keys, const size_t *key_length, size_t number_of_keys, memcached_execute_fn *callback, void *context, uint32_t number_of_callbacks)
+
+.. c:function:: memcached_return_t memcached_mget_execute_by_key (memcached_st *ptr, const char *group_key, size_t group_key_length, const char * const *keys, const size_t *key_length, size_t number_of_keys, memcached_execute_fn *callback, void *context, uint32_t number_of_callbacks)
+
+.. c:type:: memcached_return_t (*memcached_execute_fn)(const memcached_st *ptr, memcached_result_st *result, void *context)
+
+Compile and link with -lmemcached
+
+
+-----------
+DESCRIPTION
+-----------
+
+
+:c:func:`memcached_get` is used to fetch an individual value from the server.
+You must pass in a key and its length to fetch the object. You must supply
+three pointer variables which will give you the state of the returned
+object. A :c:type:`uint32_t` pointer to contain whatever flags you stored with the value, a :c:type:`size_t` pointer which will be filled with size of of
+the object, and a :c:type:`memcached_return_t` pointer to hold any error. The
+object will be returned upon success and NULL will be returned on failure. Any
+object returned by :c:func:`memcached_get` must be released by the caller
+application.
+
+:c:func:`memcached_mget` is used to select multiple keys at once. For
+multiple key operations it is always faster to use this function. This function always works asynchronously.
+
+To retrieve data after a successful execution of :c:func:`memcached_mget`, you will need to
+call :c:func:`memcached_fetch_result`. You should continue to call this function until
+it returns a NULL (i.e. no more values). If you need to quit in the middle of a
+:c:func:`memcached_mget` call, you can execute a :c:func:`memcached_quit`, those this is not required.
+
+:c:func:`memcached_fetch_result` is used to fetch an individual value from the server. :c:func:`memcached_mget` must always be called before using this method.
+You must pass in a key and its length to fetch the object. You must supply
+three pointer variables which will give you the state of the returned
+object. A :c:type:`uint32_t` pointer to contain whatever flags you stored with the value, a :c:type:`size_t` pointer which will be filled with size of of the
+object, and a :c:type:`memcached_return_t` pointer to hold any error. The
+object will be returned upon success and NULL will be returned on failure. :c:type:`MEMCACHED_END` is returned by the \*error value when all objects that have been found are returned. The final value upon :c:type:`MEMCACHED_END` is null.
+
+:c:func:`memcached_fetch_result` is used to return a :c:type:`memcached_result_st` structure from a memcached server. The result object is forward compatible
+with changes to the server. For more information please refer to the
+:c:type:`memcached_result_st` help. This function will dynamically allocate a
+result structure for you if you do not pass one to the function.
+
+:c:func:`memcached_fetch_execute` is a callback function for result sets.
+Instead of returning the results to you for processing, it passes each of the
+result sets to the list of functions you provide. It passes to the function
+a :c:type:`memcached_st` that can be cloned for use in the called
+function (it can not be used directly). It also passes a result set which does
+not need to be freed. Finally it passes a "context". This is just a pointer to
+a memory reference you supply the calling function. Currently only one value
+is being passed to each function call. In the future there will be an option
+to allow this to be an array.
+
+:c:func:`memcached_mget_execute` and :c:func:`memcached_mget_execute_by_key`
+is similar to :c:func:`memcached_mget`, but it may trigger the supplied
+callbacks with result sets while sending out the queries. If you try to
+perform a really large multiget with :c:func:`memcached_mget` you may
+encounter a deadlock in the OS kernel (it will fail to write data to the
+socket because the input buffer is full). :c:func:`memcached_mget_execute`
+solves this problem by processing some of the results before continuing
+sending out requests. Please note that this function is only available in
+the binary protocol.
+
+:c:func:`memcached_get_by_key` and :c:func:`memcached_mget_by_key` behave
+in a similar nature as :c:func:`memcached_get` and :c:func:`memcached_mget`.
+The difference is that they take a master key that is used for determining
+which server an object was stored if key partitioning was used for storage.
+
+All of the above functions are not tested when the
+:c:type:`MEMCACHED_BEHAVIOR_USE_UDP` has been set. Executing any of these
+functions with this behavior on will result in :c:type:`MEMCACHED_NOT_SUPPORTED` being returned, or for those functions which do not return a :c:type:`memcached_return_t`, the error function parameter will be set to :c:type:`MEMCACHED_NOT_SUPPORTED`.
+
+
+------
+RETURN
+------
+
+
+All objects retrieved via :c:func:`memcached_get` or :c:func:`memcached_get_by_key` must be freed with :manpage:`free(3)`.
+
+:c:func:`memcached_get` will return NULL on
+error. You must look at the value of error to determine what the actual error
+was.
+
+:c:func:`memcached_fetch_execute` return :c:type:`MEMCACHED_SUCCESS` if
+all keys were successful. :c:type:`MEMCACHED_NOTFOUND` will be return if no
+keys at all were found.
+
+:c:func:`memcached_fetch_result` sets error
+to :c:type:`MEMCACHED_END` upon successful conclusion.
+:c:type:`MEMCACHED_NOTFOUND` will be return if no keys at all were found.
+
+----
+HOME
+----
+
+
+To find out more information please check:
+`http://libmemcached.org/ <http://libmemcached.org/>`_
+
+
+--------
+SEE ALSO
+--------
+
+:manpage:`memcached(1)` :manpage:`libmemcached(3)` :manpage:`memcached_strerror(3)`
--- /dev/null
+========================================
+Use custom allocators for embedded usage
+========================================
+
+.. index:: object: memcached_st
+
+Manage memory allocator functions
+
+--------
+SYNOPSIS
+--------
+
+
+#include <libmemcached/memcached.h>
+
+.. c:function:: memcached_return_t memcached_set_memory_allocators (memcached_st *ptr, memcached_malloc_fn mem_malloc, memcached_free_fn mem_free, memcached_realloc_fn mem_realloc, memcached_calloc_fn mem_calloc, void *context)
+
+.. c:function:: void memcached_get_memory_allocators (memcached_st *ptr, memcached_malloc_fn *mem_malloc, memcached_free_fn *mem_free, memcached_realloc_fn *mem_realloc, memcached_calloc_fn *mem_calloc)
+
+.. c:function:: void * memcached_get_memory_allocators_context(const memcached_st *ptr)
+
+.. c:function:: void * (*memcached_malloc_fn) (memcached_st *ptr, const size_t size, void *context)
+
+.. c:function:: void * (*memcached_realloc_fn) (memcached_st *ptr, void *mem, const size_t size, void *context)
+
+.. c:function:: void (*memcached_free_fn) (memcached_st *ptr, void *mem, void *context)
+
+.. c:function:: void * (*memcached_calloc_fn) (memcached_st *ptr, size_t nelem, const size_t elsize, void *context)
+
+Compile and link with -lmemcached
+
+
+
+-----------
+DESCRIPTION
+-----------
+
+
+libmemcached(3) allows you to specify your own memory allocators, optimized
+for your application. This enables libmemcached to be used inside of applications that have their own malloc implementation.
+
+:c:func:`memcached_set_memory_allocators` is used to set the memory
+allocators used by the memcached instance specified by ptr. Please note that
+you cannot override only one of the memory allocators, you have to specify a
+complete new set if you want to override one of them. All of the memory
+allocation functions should behave as specified in the C99 standard. Specify
+NULL as all functions to reset them to the default values.
+
+:c:func:`memcached_get_memory_allocators` is used to get the currently used
+memory allocators by a mamcached handle.
+
+:c:func:`memcached_get_memory_allocators_context` returns the void \* that
+was passed in during the call to :c:func:`memcached_set_memory_allocators`.
+
+The first argument to the memory allocator functions is a pointer to a
+memcached structure, the is passed as const and you will need to clone
+it in order to make use of any operation which would modify it.
+
+
+-----
+NOTES
+-----
+
+
+In version 0.38 all functions were modified to have a context void pointer
+passed to them. This was so that customer allocators could have their
+own space for memory.
+
+
+------
+RETURN
+------
+
+
+:c:func:`memcached_set_memory_allocators` return :c:type:`MEMCACHED_SUCCESS`
+upon success, and :c:type:`MEMCACHED_FAILURE` if you don't pass a complete set
+of function pointers.
+
+
+----
+HOME
+----
+
+
+To find out more information please check:
+`http://libmemcached.org/ <http://libmemcached.org/>`_
+
+
+--------
+SEE ALSO
+--------
+
+:manpage:`memcached(1)` :manpage:`libmemcached(3)` :manpage:`memcached_strerror(3)`
--- /dev/null
+============================
+Working with memcached pools
+============================
+
+--------
+SYNOPSIS
+--------
+
+#include <libmemcached/memcached_pool.h>
+
+.. c:type:: memcached_pool_st
+
+.. c:function:: memcached_pool_st* memcached_pool(const char *option_string, size_t option_string_length)
+
+.. c:function:: memcached_pool_st* memcached_pool_create(memcached_st* mmc, int initial, int max)
+.. deprecated:: 0.46
+ Use :c:func:`memcached_pool`
+
+.. c:function:: 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)
+.. deprecated:: 0.53
+ Use :c:func:`memcached_pool_fetch`
+
+.. c:function:: memcached_st* memcached_pool_fetch(memcached_pool_st*, struct timespec* relative_time, memcached_return_t* rc)
+
+.. versionadded:: 0.53
+ Synonym for memcached_pool_pop
+
+.. c:function:: memcached_return_t memcached_pool_push(memcached_pool_st* pool, memcached_st *mmc)
+.. deprecated:: 0.53
+ Use :c:func:`memcached_pool_push`
+
+.. c:function:: memcached_return_t memcached_pool_release(memcached_pool_st* pool, memcached_st* mmc)
+.. versionadded:: 0.53
+ Synonym for memcached_pool_push.
+
+.. c:function:: memcached_return_t memcached_pool_behavior_set(memcached_pool_st *pool, memcached_behavior_t flag, uint64_t data)
+
+.. 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
+
+-----------
+DESCRIPTION
+-----------
+
+
+:c:func:`memcached_pool` is used to create a connection pool of objects you
+may use to remove the overhead of using memcached_clone for short lived
+:c:type:`memcached_st` objects. Please see :doc:`libmemcached_configuration` for details on the format of the configuration string.
+
+:c:func:`memcached_pool_destroy` is used to destroy the connection pool
+created with :c:func:`memcached_pool_create` and release all allocated
+resources. It will return the pointer to the :c:type:`memcached_st` structure
+passed as an argument to :c:func:`memcached_pool_create`, and returns the ownership of the pointer to the caller when created with :c:func:`memcached_pool_create`, otherwise NULL is returned..
+
+:c:func:`memcached_pool_fetch` is used to fetch a connection structure from the
+connection pool. The relative_time argument specifies if the function should
+block and wait for a connection structure to be available if we try
+to exceed the maximum size. You need to specify time in relative time.
+
+:c:func:`memcached_pool_release` is used to return a connection structure back to the pool.
+
+:c:func:`memcached_pool_behavior_get` and :c:func:`memcached_pool_behavior_set` is used to get/set behavior flags on all connections in the pool.
+
+Both :c:func:`memcached_pool_release` and :c:func:`memcached_pool_fetch` are thread safe.
+
+------
+RETURN
+------
+
+:c:func:`memcached_pool_destroy` returns the pointer (and ownership) to the :c:type:`memcached_st` structure used to create the pool. If connections are in use it returns NULL.
+
+:c:func:`memcached_pool_pop` returns a pointer to a :c:type:`memcached_st` structure from the pool (or NULL if an allocation cannot be satisfied).
+
+:c:func:`memcached_pool_release` returns :c:type:`MEMCACHED_SUCCESS` upon success.
+
+:c:func:`memcached_pool_behavior_get` and :c:func:`memcached_pool_behavior_get` returns :c:type:`MEMCACHED_SUCCESS` upon success.
+
+If any methods returns MEMCACHED_IN_PROGRESS then a lock on the pool could not be obtained. If any of the parameters passed to any of these functions is invalid, MEMCACHED_INVALID_ARGUMENTS will be returned.
+
+memcached_pool_fetch may return MEMCACHED_TIMEOUT if a timeout occurs while waiting for a free memcached_st. MEMCACHED_NOTFOUND if no memcached_st was available.
+
+
+----
+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>
+
+
+--------
+SEE ALSO
+--------
+
+:manpage:`memcached(1)` :manpage:`libmemcached(3)` :manpage:`memcached_strerror(3)` :manpage:`libmemcached_configuration(3)`
--- /dev/null
+====================================
+Disconnecting a client from a server
+====================================
+
+.. index:: object: memcached_st
+
+--------
+SYNOPSIS
+--------
+
+#include <libmemcached/memcached.h>
+
+.. c:function:: void memcached_quit (memcached_st *ptr)
+
+Compile and link with -lmemcached
+
+-----------
+DESCRIPTION
+-----------
+
+
+:c:func:`memcached_quit` will disconnect you from all currently connected
+servers. It will also reset the state of the connection (ie, any :c:func:`memcached_fetch` you are in the middle of will be terminated). This function is
+called automatically when you call :c:func:`memcached_free` on the :c:type:`memcached_st` structure.
+
+You do not need to call this on your own. All operations to change server
+hashes and parameters will handle connections to the server for you. This
+function is provided mainly so that you can timeout your connections or
+reset connections during the middle of a :c:func:`memcached_fetch`.
+
+
+------
+RETURN
+------
+
+
+A value of type :c:type:`memcached_return_t` is returned On success that value
+will be :c:type:`MEMCACHED_SUCCESS`. Use :c:func:`memcached_strerror` to
+translate this value to a printable string.
+
+
+----
+HOME
+----
+
+
+To find out more information please check:
+`http://libmemcached.org/ <http://libmemcached.org/>`_
+
+
+------
+AUTHOR
+------
+
+
+Brian Aker, <brian@tangent.org>
+
+
+--------
+SEE ALSO
+--------
+
+:manpage:`memcached(1)` :manpage:`libmemcached(3)` :manpage:`memcached_strerror(3)`
--- /dev/null
+========================
+Working with result sets
+========================
+
+--------
+SYNOPSIS
+--------
+
+#include <libmemcached/memcached_pool.h>
+
+.. c:type:: memcached_result_st
+
+.. c:function:: memcached_result_st * memcached_result_create (memcached_st *ptr, memcached_result_st *result)
+
+.. c:function:: void memcached_result_free (memcached_result_st *result)
+
+.. c:function:: const char * memcached_result_key_value (memcached_result_st *result)
+
+.. c:function:: size_t memcached_result_key_length (const memcached_result_st *result)
+
+.. c:function:: const char *memcached_result_value (memcached_result_st *ptr)
+
+.. c:function:: char *memcached_result_take_value (memcached_result_st *ptr)
+
+.. c:function:: size_t memcached_result_length (const memcached_result_st *ptr)
+
+.. c:function:: uint32_t memcached_result_flags (const memcached_result_st *result)
+
+.. c:function:: uint64_t memcached_result_cas (const memcached_result_st *result)
+
+.. c:function:: memcached_return_t memcached_result_set_value (memcached_result_st *ptr, const char *value, size_t length)
+
+.. c:function:: void memcached_result_set_flags (memcached_result_st *ptr, uint32_t flags)
+
+.. c:function:: void memcached_result_set_expiration (memcached_result_st *ptr, time_t)
+
+Compile and link with -lmemcachedutil -lmemcached
+
+
+
+-----------
+DESCRIPTION
+-----------
+
+
+libmemcached(3) can optionally return a :c:type:`memcached_result_st` which
+acts as a result object. The result objects have added benefits over the
+character pointer returns, in that they are forward compatible with new
+return items that future memcached servers may implement (the best current
+example of this is the CAS return item). The structures can also be reused,
+which will save on calls to malloc(3). It is suggested that you use result
+objects over char \* return functions.
+
+The structure of :c:type:`memcached_result_st` has been encapsulated, you should
+not write code to directly access members of the structure.
+
+:c:func:`memcached_result_create` will either allocate memory for a
+:c:type:`memcached_result_st` or will initialize a structure passed to it.
+
+:c:func:`memcached_result_free` will deallocate any memory attached to the
+structure. If the structure was also allocated, it will deallocate it.
+
+:c:func:`memcached_result_key_value` returns the key value associated with the
+current result object.
+
+:c:func:`memcached_result_key_length` returns the key length associated with
+the current result object.
+
+:c:func:`memcached_result_value` returns the result value associated with the
+current result object.
+
+:c:func:`memcached_result_take_value` returns and hands over the result value
+associated with the current result object. You must call free() to release this
+value, unless you have made use of a custom allocator. Use of a custom
+allocator requires that you create your own custom free() to release it.
+
+:c:func:`memcached_result_length` returns the result length associated with
+the current result object.
+
+:c:func:`memcached_result_flags` returns the flags associated with the
+current result object.
+
+:c:func:`memcached_result_cas` returns the cas associated with the
+current result object. This value will only be available if the server
+tests it.
+
+:c:func:`memcached_result_set_value` takes a byte array and a size and sets
+the result to this value. This function is used for trigger responses.
+
+:c:func:`memcached_result_set_flags` takes a result structure and stores a new
+value for the flags field.
+
+:c:func:`memcached_result_set_expiration` takes a result structure and stores
+a new value for the expiration field (this is only used by read through
+triggers).
+
+You may wish to avoid using memcached_result_create(3) with a
+stack based allocation. The most common issues related to ABI safety involve
+heap allocated structures.
+
+
+------
+RETURN
+------
+
+
+Varies, see particular functions. All structures must have
+:c:func:`memcached_result_free` called on them for cleanup purposes. Failure
+to do this will result in leaked memory.
+
+
+----
+HOME
+----
+
+
+To find out more information please check:
+`http://libmemcached.org/ <http://libmemcached.org/>`_
+
+
+--------
+SEE ALSO
+--------
+
+:manpage:`memcached(1)` :manpage:`libmemcached(3)` :manpage:`memcached_strerror(3)`
--- /dev/null
+============
+SASL support
+============
+
+.. index:: object: memcached_st
+
+
+--------
+SYNOPSIS
+--------
+
+#include <libmemcached/memcached_pool.h>
+
+.. c:function:: void memcached_set_sasl_callbacks(memcached_st *ptr, const sasl_callback_t *callbacks)
+
+.. c:function:: const sasl_callback_t *memcached_get_sasl_callbacks(memcached_st *ptr)
+
+.. c:function:: memcached_return_t memcached_set_sasl_auth_data(memcached_st *ptr, const char *username, const char *password)
+
+.. c:function:: memcached_return_t memcached_destroy_sasl_auth_data(memcached_st *ptr)
+
+Compile and link with -lmemcached
+
+
+
+-----------
+DESCRIPTION
+-----------
+
+
+libmemcached(3) allows you to plug in your own callbacks function used by
+libsasl to perform SASL authentication.
+
+Please note that SASL requires the memcached binary protocol, and you have
+to specify the callbacks before you connect to the server.
+
+:c:func:`memcached_set_sasl_auth_data` is a helper function defining
+the basic functionality for you, but it will store the username and password
+in memory. If you choose to use this method you have to call
+:c:type:`memcached_destroy_sasl_auth_data` before calling
+:c:type:`memcached_free` to avoid a memory leak. You should NOT call
+:c:type:`memcached_destroy_sasl_auth_data` if you specify your own callback
+function with :c:func:`memcached_set_sasl_callbacks`.
+
+
+------
+RETURN
+------
+
+
+:c:func:`memcached_get_sasl_callbacks` returns the callbacks currently used by
+this memcached handle. :c:func:`memcached_set_sasl_auth_data` returns
+:c:type:`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>
+
+
+--------
+SEE ALSO
+--------
+
+
+:manpage:`memcached(1)` :manpage:`libmemcached(3)` :manpage:`memcached_strerror(3)`
--- /dev/null
+=========================
+Managing lists of servers
+=========================
+
+
+--------
+SYNOPSIS
+--------
+
+
+
+#include <libmemcached/memcached.h>
+
+.. c:type:: const memcached_instance_st *
+
+.. c:type:: memcached_server_list_st
+
+.. c:type:: memcached_server_st
+
+.. c:function:: const const memcached_instance_st * memcached_server_list (memcached_st *ptr)
+
+.. c:function:: void memcached_server_list_free (memcached_server_list_st list)
+
+.. c:function:: memcached_server_list_st memcached_server_list_append (memcached_server_list_st list, const char *hostname, in_port_t port, memcached_return_t *error)
+
+.. c:function:: uint32_t memcached_server_list_count (memcached_server_list_st list)
+
+.. c:function:: const char *memcached_server_error (const memcached_instance_st * instance)
+
+.. c:function:: void memcached_server_error_reset (const memcached_instance_st * list)
+.. deprecated:: 0.39
+
+.. c:function:: void memcached_servers_parse ()
+.. deprecated:: 0.39
+
+Compile and link with -lmemcached
+
+
+-----------
+DESCRIPTION
+-----------
+
+
+libmemcached(3) operates on a list of hosts which are stored in
+:c:type:`memcached_server_st` structures. You should not modify these structures
+directly. Functions are provided to modify these structures (and more can be
+added, just ask!).
+
+:c:func:`memcached_server_list` is used to provide an array of all defined hosts. This was incorrectly documented as "requiring free" up till version 0.39.
+
+:c:func:`memcached_server_list_free` deallocates all memory associated with the array of :c:type:`memcached_server_st` that you passed to it.
+
+:c:func:`memcached_server_list_append` adds a server to the end of a
+:c:type:`memcached_server_st` array. On error null will be returned and the
+:c:type:`memcached_return_t` pointer you passed into the function will be set with the appropriate error. If the value of port is zero, it is set to the default
+port of a memcached server.
+
+DEPRECATED :c:func:`memcached_servers_parse`, please see :c:func:`memcached`
+
+:c:func:`memcached_server_error` can be used to look at the text of the last error message sent by the server to to the client.
+
+Before version 0.39 theses functions used a memcache_server_st \*. In 0.39
+memcached_server_st \* was aliased to :c:type:`memcached_server_list_st`. This was done for a style reason to help clean up some concepts in the code.
+
+
+------
+RETURN
+------
+
+
+Varies, see particular functions.
+
+
+----
+HOME
+----
+
+
+To find out more information please check:
+`http://libmemcached.org/ <http://libmemcached.org/>`_
+
+
+
+--------
+SEE ALSO
+--------
+
+
+:manpage:`memcached(1)` :manpage:`libmemcached(3)` :manpage:`memcached_strerror(3)`
--- /dev/null
+========================================================
+Manipulate the server information stored in memcached_st
+========================================================
+
+--------
+SYNOPSIS
+--------
+
+#include <libmemcached/memcached.h>
+
+.. c:type:: memcached_server_fn
+
+.. c:function:: uint32_t memcached_server_count (memcached_st *ptr)
+
+.. c:function:: memcached_return_t memcached_server_add (memcached_st *ptr, const char *hostname, in_port_t port)
+
+.. c:function:: memcached_return_t memcached_server_add_udp (memcached_st *ptr, const char *hostname, in_port_t port)
+
+.. c:function:: memcached_return_t memcached_server_add_unix_socket (memcached_st *ptr, const char *socket)
+
+.. c:function:: memcached_return_t memcached_server_push (memcached_st *ptr, const memcached_server_st *list)
+
+.. c:function:: const memcached_instance_st * memcached_server_by_key (memcached_st *ptr, const char *key, size_t key_length, memcached_return_t *error)
+
+.. c:function:: const memcached_instance_st * memcached_server_get_last_disconnect (const memcached_st *ptr)
+
+.. c:function:: memcached_return_t memcached_server_cursor(const memcached_st *ptr, const memcached_server_fn *callback, void *context, uint32_t number_of_callbacks)
+
+compile and link with -lmemcached
+
+
+
+-----------
+DESCRIPTION
+-----------
+
+
+:doc:`libmemcached` performs operations on a list of hosts. The order of
+these hosts determine routing to keys. Functions are provided to add keys to
+memcached_st structures. To manipulate lists of servers see
+memcached_server_st(3).
+
+:c:func:`memcached_server_count` provides you a count of the current number of
+servers being used by a :c:type:`memcached_st` structure.
+
+:c:func:`memcached_server_add` pushes a single TCP server into the :c:type:`memcached_st` structure. This server will be placed at the end. Duplicate servers
+ are allowed, so duplication is not checked. Executing this function with the :c:type:`MEMCACHED_BEHAVIOR_USE_UDP` behavior set will result in a :c:type:`MEMCACHED_INVALID_HOST_PROTOCOL`.
+
+:c:func:`memcached_server_add_udp` pushes a single UDP server into the :c:type:`memcached_st` structure. This server will be placed at the end. Duplicate
+servers are allowed, so duplication is not checked. Executing this function with out setting the :c:type:`MEMCACHED_BEHAVIOR_USE_UDP` behavior will result in a
+:c:type:`MEMCACHED_INVALID_HOST_PROTOCOL`.
+
+:c:func:`memcached_server_add_unix_socket` pushes a single UNIX socket into the :c:type:`memcached_st` structure. This UNIX socket will be placed at the end.
+Duplicate servers are allowed, so duplication is not checked. The length
+of the filename must be one character less than :c:type:`MEMCACHED_MAX_HOST_LENGTH`.
+
+:c:func:`memcached_server_push` pushes an array of :c:type:`memcached_server_st` into the :c:type:`memcached_st` structure. These servers will be placed at
+the end. Duplicate servers are allowed, so duplication is not checked. A
+copy is made of structure so the list provided (and any operations on
+the list) are not saved.
+
+:c:func:`memcached_server_by_key` allows you to provide a key and retrieve the
+server which would be used for assignment.
+
+:c:func:`memcached_server_get_last_disconnect` returns a pointer to the last
+server for which there was a connection problem. It does not mean this
+particular server is currently dead but if the library is reporting a server
+is, the returned server is a very good candidate.
+
+:c:func:`memcached_server_cursor` takes a memcached_st and loops through the
+list of hosts currently in the cursor calling the list of callback
+functions provided. You can optionally pass in a value via
+context which will be provided to each callback function. An error
+return from any callback will terminate the loop. :c:func:`memcached_server_cursor` is passed the original caller :c:type:`memcached_st` in its current state.
+
+
+------
+RETURN
+------
+
+
+Varies, see particular functions.
+
+
+----
+HOME
+----
+
+
+To find out more information please check:
+`http://libmemcached.org/ <http://libmemcached.org/>`_
+
+
+--------
+SEE ALSO
+--------
+
+
+:manpage:`memcached(1)` :manpage:`libmemcached(3)` :manpage:`memcached_strerror(3)`
--- /dev/null
+=========================================================
+Store, replace, add, or atomically add data to the server
+=========================================================
+
+.. index:: object: memcached_st
+
+
+--------
+SYNOPSIS
+--------
+
+
+#include <libmemcached/memcached.h>
+
+.. c:function:: memcached_return_t memcached_set (memcached_st *ptr, const char *key, size_t key_length, const char *value, size_t value_length, time_t expiration, uint32_t flags)
+
+.. c:function:: memcached_return_t memcached_add (memcached_st *ptr, const char *key, size_t key_length, const char *value, size_t value_length, time_t expiration, uint32_t flags)
+
+.. c:function:: memcached_return_t memcached_replace (memcached_st *ptr, const char *key, size_t key_length, const char *value, size_t value_length, time_t expiration, uint32_t flags)
+
+.. c:function:: memcached_return_t memcached_set_by_key(memcached_st *ptr, const char *group_key, size_t group_key_length, const char *key, size_t key_length, const char *value, size_t value_length, time_t expiration, uint32_t flags)
+
+.. c:function:: memcached_return_t memcached_add_by_key(memcached_st *ptr, const char *group_key, size_t group_key_length, const char *key, size_t key_length, const char *value, size_t value_length, time_t expiration, uint32_t flags)
+
+.. c:function:: memcached_return_t memcached_replace_by_key(memcached_st *ptr, const char *group_key, size_t group_key_length, const char *key, size_t key_length, const char *value, size_t value_length, time_t expiration, uint32_t flags)
+
+Compile and link with -lmemcached
+
+
+-----------
+DESCRIPTION
+-----------
+
+
+:c:func:`memcached_set`, :c:func:`memcached_add`, and :c:func:`memcached_replace` are all used to store information on the server. All methods take a key, and its length to store the object. Keys are currently limited to 250 characters when using either a version of memcached(1) which is 1.4 or below, or when using the text protocol. You must supply both a value and a length. Optionally you
+store the object. Keys are currently limited to 250 characters by the
+memcached(1) server. You must supply both a value and a length. Optionally you
+may test an expiration time for the object and a 16 byte value (it is meant to be used as a bitmap). "flags" is a 4byte space that is stored alongside of the main value. Many sub libraries make use of this field, so in most cases users should avoid making use of it.
+
+:c:func:`memcached_set` will write an object to the server. If an object
+already exists it will overwrite what is in the server. If the object does not
+exist it will be written. If you are using the non-blocking mode this function
+will always return true unless a network error occurs.
+
+:c:func:`memcached_replace` replaces an object on the server. If the object is not found on the server an error occurs.
+
+:c:func:`memcached_add` adds an object to the server. If the object is found on the server an error occurs, otherwise the value is stored.
+
+:c:func:`memcached_cas` overwrites data in the server as long as the "cas"
+value is still the same in the server. You can get the cas value of a result by
+calling :c:func:`memcached_result_cas` on a memcached_result_st(3) structure. At the point
+that this note was written cas is still buggy in memached. Turning on tests
+for it in libmemcached(3) is optional. Please see memcached_set for
+information on how to do this.
+
+:c:func:`memcached_set_by_key`, :c:func:`memcached_add_by_key`, and :c:func:`memcached_replace_by_key` methods all behave in a similar method as the non
+key methods. The difference is that they use their group_key parameter to map
+objects to particular servers.
+
+If you are looking for performance, :c:func:`memcached_set` with non-blocking IO is the fastest way to store data on the server.
+
+All of the above functions are testsed with the :c:type:`MEMCACHED_BEHAVIOR_USE_UDP` behavior enabled. However, when using these operations with this behavior
+on, there are limits to the size of the payload being sent to the server.
+The reason for these limits is that the Memcached Server does not allow
+multi-datagram requests and the current server implementation sets a datagram
+size to 1400 bytes. Due to protocol overhead, the actual limit of the user supplied data is less than 1400 bytes and depends on the protocol in use as, well as the operation being
+executed. When running with the binary protocol, :c:type:`MEMCACHED_BEHAVIOR_BINARY_PROTOCOL`, the size of the key,value, flags and expiry combined may not
+exceed 1368 bytes. When running with the ASCII protocol, the exact limit fluctuates depending on which function is being executed and whether the function is a cas operation or not. For non-cas ASCII set operations, there are at least
+1335 bytes available to split among the key, key_prefix, and value; for cas
+ASCII operations there are at least 1318 bytes available to split among the key, key_prefix and value. If the total size of the command, including overhead,
+exceeds 1400 bytes, a :c:type:`MEMCACHED_WRITE_FAILURE` will be returned.
+
+
+------
+RETURN
+------
+
+
+All methods return a value of type :c:type:`memcached_return_t`.
+On success the value will be :c:type:`MEMCACHED_SUCCESS`.
+Use :c:func:`memcached_strerror` to translate this value to a printable string.
+
+For :c:func:`memcached_replace` and :c:func:`memcached_add`, :c:type:`MEMCACHED_NOTSTORED` is a legitmate error in the case of a collision.
+
+
+----
+HOME
+----
+
+
+To find out more information please check:
+`http://libmemcached.org/ <http://libmemcached.org/>`_
+
+
+--------
+SEE ALSO
+--------
+
+
+:manpage:`memcached(1)` :manpage:`libmemached(3)` :manpage:`memcached_strerror(3)` :manpage:`memcached_prepend(3)` :manpage:`memcached_cas(3)` :manpage:`memcached_append(3)`
+
--- /dev/null
+==================================================
+Working with statistical information from a server
+==================================================
+
+
+Get memcached statistics
+
+.. index:: object: memcached_st
+
+
+--------
+SYNOPSIS
+--------
+
+#include <libmemcached/memcached.h>
+
+.. c:type:: memcached_stat_st
+
+.. c:type:: memcached_return_t (*memcached_stat_fn)(const memcached_instance_st * server, const char *key, size_t key_length, const char *value, size_t value_length, void *context)
+
+.. c:function:: memcached_stat_st *memcached_stat (memcached_st *ptr, char *args, memcached_return_t *error)
+
+.. c:function:: memcached_return_t memcached_stat_servername (memcached_stat_st *stat, char *args, const char *hostname, in_port_t port)
+
+.. c:function:: char * memcached_stat_get_value (memcached_st *ptr, memcached_stat_st *stat, const char *key, memcached_return_t *error)
+
+.. c:function:: char ** memcached_stat_get_keys (memcached_st *ptr, memcached_stat_st *stat, memcached_return_t *error)
+
+.. c:function:: memcached_return_t memcached_stat_execute (memcached_st *memc, const char *args, memcached_stat_fn func, void *context)
+
+Compile and link with -lmemcached
+
+-----------
+DESCRIPTION
+-----------
+
+
+libmemcached(3) has the ability to query a memcached server (or collection
+of servers) for their current state. Queries to find state return a
+:c:type:`memcached_stat_st` structure. You are responsible for freeing this structure. While it is possible to access the structure directly it is not advisable. :c:func:`memcached_stat_get_value` has been provided to query the structure.
+
+:c:func:`memcached_stat_execute` uses the servers found in :c:type:`memcached_stat_st` and executes a "stat" command on each server. args is an optional argument that can be passed in to modify the behavior of "stats". You will need to supply a callback function that will be supplied each pair of values returned by
+the memcached server.
+
+:c:func:`memcached_stat` fetches an array of :c:type:`memcached_stat_st` structures containing the state of all available memcached servers. The return value must be freed by the calling application. If called with the :c:type:`MEMCACHED_BEHAVIOR_USE_UDP` behavior set, a NULL value is returned and the error parameter is set to :c:type:`MEMCACHED_NOT_SUPPORTED`.
+
+:c:func:`memcached_stat_servername` can be used standalone without a :c:type:`memcached_st` to obtain the state of a particular server. "args" is used to define a particular state object (a list of these are not provided for by either
+the :c:func:`memcached_stat_get_keys` call nor are they defined in the memcached protocol). You must specify the hostname and port of the server you want to
+obtain information on.
+
+:c:func:`memcached_stat_get_value` returns the value of a particular state key. You specify the key you wish to obtain. The key must be null terminated.
+
+:c:func:`memcached_stat_get_keys` returns a list of keys that the server has state objects on. You are responsible for freeing this list.
+
+A command line tool, memstat(1), is provided so that you do not have to write
+an application to do this.
+
+
+------
+RETURN
+------
+
+
+Varies, see particular functions.
+
+Any method returning a :c:type:`memcached_stat_st` expects you to free the
+memory allocated for it.
+
+
+----
+HOME
+----
+
+
+To find out more information please check:
+`http://libmemcached.org/ <http://libmemcached.org/>`_
+
+
+------
+AUTHOR
+------
+
+
+Brian Aker, <brian@tangent.org>
+
+
+--------
+SEE ALSO
+--------
+
+
+:manpage:`memcached(1)` :manpage:`libmemcached(3)` :manpage:`memcached_strerror(3)`
+
--- /dev/null
+================================================
+Coverting Errors, memcached_return_t, to strings
+================================================
+
+
+.. index:: object: memcached_st
+
+--------
+SYNOPSIS
+--------
+
+#include <libmemcached/memcached.h>
+
+.. c:function:: const char * memcached_strerror (memcached_st *ptr, memcached_return_t rc)
+
+Compile and link with -lmemcached
+
+
+-----------
+DESCRIPTION
+-----------
+
+
+:c:func:`memcached_strerror` takes a :c:type:`memcached_return_t` value and returns a string describing the error.
+
+This string must not be modified by the application.
+
+:c:type:`memcached_return_t` values are returned from nearly all libmemcached(3) functions.
+
+:c:type:`memcached_return_t` values are of an enum type so that you can set up responses with switch/case and know that you are capturing all possible return values.
+
+
+------
+RETURN
+------
+
+
+:c:func:`memcached_strerror` returns a string describing a :c:type:`memcached_return_t` value.
+
+
+----
+HOME
+----
+
+
+To find out more information please check:
+`http://libmemcached.org/ <http://libmemcached.org/>`_
+
+
+
+--------
+SEE ALSO
+--------
+
+
+:manpage:`memcached(1)` :manpage:`libmemcached(3)`
+
--- /dev/null
+==============================================
+Storing custom user information in the client.
+==============================================
+
+.. index:: object: memcached_st
+
+Manage user specific data
+
+
+-------
+LIBRARY
+-------
+
+
+C Client Library for memcached (libmemcached, -lmemcached)
+
+
+--------
+SYNOPSIS
+--------
+
+
+
+.. code-block:: c
+
+#include <libmemcached/memcached.h>
+
+.. c:function:: void *memcached_get_user_data (memcached_st *ptr)
+
+.. c:function:: void *memcached_set_user_data (memcached_st *ptr, void *data)
+
+Compile and link with -lmemcached
+
+
+
+-----------
+DESCRIPTION
+-----------
+
+
+libmemcached(3) allows you to store a pointer to a user specific data inside
+the memcached_st structure.
+
+:c:func:`memcached_set_user_data` is used to set the user specific data in the
+:c:type:`memcached_st` structure.
+
+:c:func:`memcached_get_user_data` is used to retrieve the user specific data in the :c:type:`memcached_st` structure.
+
+
+------
+RETURN
+------
+
+
+:c:func:`memcached_set_user_data` returns the previous value of the user specific data.
+
+:c:func:`memcached_get_user_data` returns the current value uf the user specific data.
+
+
+----
+HOME
+----
+
+
+To find out more information please check:
+`http://libmemcached.org/ <http://libmemcached.org/>`_
+
+
+--------
+SEE ALSO
+--------
+
+
+:manpage:`memcached(1)` :manpage:`libmemcached(3)`
+
--- /dev/null
+=================================
+Setting the verbosity of a server
+=================================
+
+.. index:: object: memcached_st
+
+Modifiy verbosity of servers
+
+--------
+SYNOPSIS
+--------
+
+#include <libmemcached/memcached.h>
+
+.. c:function:: memcached_return_t memcached_verbosity (memcached_st *ptr, uint32_t verbosity)
+
+Compile and link with -lmemcached
+
+
+-----------
+DESCRIPTION
+-----------
+
+
+:c:func:`memcached_verbosity` modifies the "verbosity" of the
+memcached(1) servers referenced in the :c:type:`memcached_st` parameter.
+
+
+------
+RETURN
+------
+
+
+A value of type :c:type:`memcached_return_t` is returned.
+
+On success that value will be :c:type:`MEMCACHED_SUCCESS`.
+
+Use :c:func:`memcached_strerror` to translate this value to a printable string.
+
+
+----
+HOME
+----
+
+
+To find out more information please check:
+`http://libmemcached.org/ <http://libmemcached.org/>`_
+
+
+--------
+SEE ALSO
+--------
+
+
+:manpage:`memcached(1)` :manpage:`libmemcached(3)` :manpage:`memcached_strerror(3)`
+
--- /dev/null
+=======================================================
+Getting version information about the client and server
+=======================================================
+
+
+--------
+SYNOPSIS
+--------
+
+#include <libmemcached/memcached.h>
+
+.. c:function:: const char * memcached_lib_version (void)
+
+.. c:function:: memcached_return_t memcached_version (memcached_st *ptr)
+
+
+Compile and link with -lmemcached
+
+
+
+-----------
+DESCRIPTION
+-----------
+
+
+:c:func:`memcached_lib_version` is used to return a simple version string representing the libmemcached version (client library version, not server version)
+
+:c:func:`memcached_version` is used to set the major, minor, and micro versions of each memcached server being used by the memcached_st connection structure. It returns the memcached server return code.
+
+
+------
+RETURN
+------
+
+
+:c:func:`memcached_lib_version` returns a string with the version of the libmemcached driver.
+
+A value of :c:type:`memcached_return_t` is returned from :c:func:'memcached_version'
+
+On success that value will be :c:type:`MEMCACHED_SUCCESS`.
+
+If called with the :c:func:`MEMCACHED_BEHAVIOR_USE_UDP` behavior set, the value :c:type:`MEMCACHED_NOT_SUPPORTED` will be returned.
+
+Use :c:func:`memcached_strerror` to translate this value to
+a printable string.
+
+
+----
+HOME
+----
+
+
+To find out more information please check:
+`http://libmemcached.org/ <http://libmemcached.org/>`_
+
+
+--------
+SEE ALSO
+--------
+
+
+:manpage:`memcached(1)` :manpage:`libmemcached(3)` :manpage:`memcached_strerror(3)`
+
--- /dev/null
+=================
+Systemtap support
+=================
+
+By default on Linux libmemcached is compiled to support Systemtap. This enabled/disabled during compiles via the dtrace configure flag.
+
+Please see :manpage: `stapex` for more information about Systemtap.
--- /dev/null
+================
+Required C types
+================
+
+.. highlightlang:: c
+
+Types
+-----
+
+C Types Used
+------------
+
+.. c:type:: bool
+
+.. c:type:: uint32_t
+
+.. c:type:: uint64_t
+
+.. c:type:: in_port_t
+
+.. c:type:: size_t
+
+.. c:type:: time_t
+
+.. c:type:: struct timespec
+
+.. c:type:: sasl_callback_t
--- /dev/null
+==========
+Versioning
+==========
+
+Libmemcached is layed out by interface version. The 1.0 version would be found in: libmemcached-1.0/memcached.h
+
+The historic libmemcached/memcached.h includes libmemcached-1.0/memcached.h. For best practice you should include the version of libmemcacached that you used during development.
+
+++ /dev/null
-=================
-Systemtap support
-=================
-
-By default on Linux libmemcached is compiled to support Systemtap. This enabled/disabled during compiles via the dtrace configure flag.
-
-Please see :manpage: `stapex` for more information about Systemtap.
+++ /dev/null
-================
-Required C types
-================
-
-.. highlightlang:: c
-
-Types
------
-
-C Types Used
-------------
-
-.. c:type:: bool
-
-.. c:type:: uint32_t
-
-.. c:type:: uint64_t
-
-.. c:type:: in_port_t
-
-.. c:type:: size_t
-
-.. c:type:: time_t
-
-.. c:type:: struct timespec
-
-.. c:type:: sasl_callback_t
+++ /dev/null
-==========
-Versioning
-==========
-
-Libmemcached is layed out by interface version. The 1.0 version would be found in: libmemcached-1.0/memcached.h
-
-The historic libmemcached/memcached.h includes libmemcached-1.0/memcached.h. For best practice you should include the version of libmemcacached that you used during development.
-
# included from Top Level Makefile.am
# All paths should be given relative to the root
-# Build rule for documentation
-$(dist_man_MANS): $(top_srcdir)/configure.ac
- $(MAKE) $(AM_MAKEFLAGS) man
+RST_FILES= $(shell find $(top_builddir)/docs/source -type f -name '*.rst')
-.NOTPARALLEL: $(dist_man_MANS)
+# Build rule for documentation
+$(dist_man_MANS): $(RST_FILES)
+ @cp docs/build/$@ $@
dist_man_MANS+= man/memaslap.1
dist_man_MANS+= man/memcapable.1
projects / awesomized / libmemcached / commitdiff
