-=================
Analyzing servers
=================
Analyze server information
---------
SYNOPSIS
--------
.. function:: memcached_analysis_st *memcached_analyze(memcached_st *ptr, memcached_stat_st *stat, memcached_return_t *error)
------------
DESCRIPTION
-----------
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
------
Any method returning a :type:`memcached_analysis_st` expects you to free the
memory allocated for it.
---------
SEE ALSO
--------
-=============================================
Appending or Prepending to data on the server
=============================================
Appending or Prepending to data on the server
---------
SYNOPSIS
--------
Compile and link with -lmemcached
------------
DESCRIPTION
-----------
and value. If the total size of the command, including overhead, exceeds
1400 bytes, a `MEMCACHED_WRITE_FAILURE` will be returned.
-------
RETURN
------
Use :func:`memcached_strerror` to translate this value to a printable
string.
---------
SEE ALSO
--------
-====================================
Incrementing and Decrementing Values
====================================
.. index:: object: memcached_st
---------
SYNOPSIS
--------
Compile and link with -lmemcached
------------
DESCRIPTION
-----------
:func:`memcached_increment_with_initial_by_key`, and
:func:`memcached_decrement_with_initial_by_key` are master key equivalents of the above.
-------
RETURN
------
On success that value will be `MEMCACHED_SUCCESS`.
Use memcached_strerror to translate this value to a printable string.
---------
SEE ALSO
--------
-====================================================
Working with data on the server in an atomic fashion
====================================================
.. index:: object: memcached_st
---------
SYNOPSIS
--------
Compile and link with -lmemcached
------------
DESCRIPTION
-----------
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 `MEMCACHED_WRITE_FAILURE` will be returned.
-------
RETURN
------
Use :func:`memcached_strerror` to translate this value to a printable
string.
---------
SEE ALSO
--------
-======================================
Creating and destroying a memcached_st
======================================
---------
SYNOPSIS
--------
Compile and link with -lmemcached
------------
DESCRIPTION
-----------
stack based allocation. The most common issues related to ABI safety involve
heap allocated structures.
-------
RETURN
------
:func:`memcached_clone` returns a pointer to the :type:`memcached_st`
that was created (or initialized). On an allocation failure, it returns NULL.
---------
SEE ALSO
--------
-==========================
Dumping data from a server
==========================
.. index:: object: memcached_st
---------
SYNOPSIS
--------
Compile and link with -lmemcached
------------
DESCRIPTION
-----------
Use :func:`memcached_strerror` to translate this value to a printable
string.
---------
SEE ALSO
--------
.. index:: object: memcached_st
---------
SYNOPSIS
--------
.. versionadded:: 0.53
------------
DESCRIPTION
-----------
:func:`memcached_exist()` can be used to check if a key exists.
-------
RETURN
------
`MEMCACHED_NOTFOUND`
The key was not found.
---------
SEE ALSO
--------
-=================
memcached_fetch
=================
.. index:: object: memcached_st
---------
SYNOPSIS
--------
Compile and link with -lmemcached
------------
DESCRIPTION
-----------
`MEMCACHED_BEHAVIOR_USE_UDP` has been set. Executing any of these
functions with this behavior on will result in `MEMCACHED_NOT_SUPPORTED` being returned, or for those functions which do not return a :type:`memcached_return_t`, the error function parameter will be set to `MEMCACHED_NOT_SUPPORTED`.
-------
RETURN
------
and the key was set larger then `MEMCACHED_MAX_KEY`, which was the largest
key allowed for the original memcached ascii server.
---------
SEE ALSO
--------
-=====================================
Wiping clean the contents of a server
=====================================
Wipe contents of memcached servers
---------
SYNOPSIS
--------
Compile and link with -lmemcached
------------
DESCRIPTION
-----------
On success that value will be `MEMCACHED_SUCCESS`.
Use :type:`memcached_strerror` to translate this value to a printable string.
---------
SEE ALSO
--------
-=======================
Flushing client buffers
=======================
Flush and send buffered commands
---------
SYNOPSIS
--------
Compile and link with -lmemcached
------------
DESCRIPTION
-----------
:func:`memcached_flush_buffers` is used in conjunction with
`MEMCACHED_BEHAVIOR_BUFFER_REQUESTS` (see memcached_behavior(3)) to flush all buffers by sending the buffered commands to the server for processing.
-------
RETURN
------
Use :func:`memcached_strerror` to translate this value to a printable
string.
---------
SEE ALSO
--------
-===============================
Generating hash values directly
===============================
Compile and link with -lmemcachedutil -lmemcached
------------
DESCRIPTION
-----------
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
------
For 64-bit hash algorithms, only the least-significant 32 bits are
returned.
---------
SEE ALSO
--------
-===============================
Retrieving data from the server
===============================
.. index:: object: memcached_st
---------
SYNOPSIS
--------
Compile and link with -lmemcached
------------
DESCRIPTION
-----------
to `MEMCACHED_END` upon successful conclusion.
`MEMCACHED_NOTFOUND` will be return if no keys at all were found.
---------
SEE ALSO
--------
-========================================
Use custom allocators for embedded usage
========================================
Manage memory allocator functions
---------
SYNOPSIS
--------
Compile and link with -lmemcached
------------
DESCRIPTION
-----------
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
-----
passed to them. This was so that customer allocators could have their
own space for memory.
-------
RETURN
------
upon success, and `MEMCACHED_FAILURE` if you don't pass a complete set
of function pointers.
---------
SEE ALSO
--------
-====================================
Disconnecting a client from a server
====================================
.. index:: object: memcached_st
---------
SYNOPSIS
--------
Compile and link with -lmemcached
------------
DESCRIPTION
-----------
function is provided mainly so that you can timeout your connections or
reset connections during the middle of a :func:`memcached_fetch`.
-------
RETURN
------
will be `MEMCACHED_SUCCESS`. Use :func:`memcached_strerror` to
translate this value to a printable string.
---------
SEE ALSO
--------
-========================
Working with result sets
========================
---------
SYNOPSIS
--------
Compile and link with -lmemcachedutil -lmemcached
------------
DESCRIPTION
-----------
stack based allocation. The most common issues related to ABI safety involve
heap allocated structures.
-------
RETURN
------
:func:`memcached_result_free` called on them for cleanup purposes. Failure
to do this will result in leaked memory.
---------
SEE ALSO
--------
-============
SASL support
============
.. index:: object: memcached_st
---------
SYNOPSIS
--------
Compile and link with -lmemcached
------------
DESCRIPTION
-----------
:type:`memcached_destroy_sasl_auth_data` if you specify your own callback
function with :func:`memcached_set_sasl_callbacks`.
-------
RETURN
------
this memcached handle. :func:`memcached_set_sasl_auth_data` returns
`MEMCACHED_SUCCESS` upon success.
---------
SEE ALSO
--------
-========================================================
Manipulate the server information stored in memcached_st
========================================================
context which will be provided to each callback function. An error
return from any callback will terminate the loop. :func:`memcached_server_cursor` is passed the original caller :type:`memcached_st` in its current state.
-------
RETURN
------
Varies, see particular functions.
---------
SEE ALSO
--------
.. index:: object: memcached_st
---------
SYNOPSIS
--------
.. 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)
------------
DESCRIPTION
-----------
-==================
Set encryption key
==================
.. index:: object: memcached_st
---------
SYNOPSIS
--------
Compile and link with -lmemcached
------------
DESCRIPTION
-----------
will be `MEMCACHED_SUCCESS`. Use :func:`memcached_strerror` to
translate this value to a printable string.
---------
SEE ALSO
--------
-==================================================
Working with statistical information from a server
==================================================
.. index:: object: memcached_st
---------
SYNOPSIS
--------
Compile and link with -lmemcached
------------
DESCRIPTION
-----------
A command line tool, memstat(1), is provided so that you do not have to write
an application to do this.
-------
RETURN
------
Any method returning a :type:`memcached_stat_st` expects you to free the
memory allocated for it.
---------
SEE ALSO
--------
.. index:: object: memcached_st
---------
SYNOPSIS
--------
Compile and link with -lmemcached
------------
DESCRIPTION
-----------
:func:`memcached_touch_by_key` works the same, but it takes a master key
to find the given value.
-------
RETURN
------
Use :func:`memcached_strerror` to translate this value to a printable
string.
---------
SEE ALSO
--------
Manage user specific data
--------
LIBRARY
-------
C Client Library for memcached (libmemcached, -lmemcached)
---------
SYNOPSIS
--------
Compile and link with -lmemcached
------------
DESCRIPTION
-----------
:func:`memcached_get_user_data` is used to retrieve the user specific data in the :type:`memcached_st` structure.
-------
RETURN
------
:func:`memcached_get_user_data` returns the current value uf the user specific data.
---------
SEE ALSO
--------
-=================================
Setting the verbosity of a server
=================================
Modify verbosity of servers
---------
SYNOPSIS
--------
Compile and link with -lmemcached
------------
DESCRIPTION
-----------
:func:`memcached_verbosity` modifies the "verbosity" of the
memcached(1) servers referenced in the :type:`memcached_st` parameter.
-------
RETURN
------
Use :func:`memcached_strerror` to translate this value to a printable string.
---------
SEE ALSO
--------
-=======================================================
Getting version information about the client and server
=======================================================
---------
SYNOPSIS
--------
Compile and link with -lmemcached
------------
DESCRIPTION
-----------
: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
------
Use :func:`memcached_strerror` to translate this value to
a printable string.
---------
SEE ALSO
--------