diff options
Diffstat (limited to 'docs/source/memcached_quit.rst')
| -rw-r--r-- | docs/source/memcached_quit.rst | 63 |
1 files changed, 63 insertions, 0 deletions
diff --git a/docs/source/memcached_quit.rst b/docs/source/memcached_quit.rst new file mode 100644 index 00000000..b94832ec --- /dev/null +++ b/docs/source/memcached_quit.rst @@ -0,0 +1,63 @@ +==================================== +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)` |