X-Git-Url: https://git.m6w6.name/?a=blobdiff_plain;f=docs%2Fsource%2Flibmemcached%2Fmemcached_quit.rst;h=3421d47be8e51ac406fb53139d7d3bdb76551394;hb=061e8ab40e94b47b8f268ad718d82b43004d42e2;hp=6559a7c4a0020c4a74132003191e7c6169dccaa7;hpb=43032f572a83233b5183ed6989921efe930aa719;p=awesomized%2Flibmemcached diff --git a/docs/source/libmemcached/memcached_quit.rst b/docs/source/libmemcached/memcached_quit.rst index 6559a7c4..3421d47b 100644 --- a/docs/source/libmemcached/memcached_quit.rst +++ b/docs/source/libmemcached/memcached_quit.rst @@ -7,25 +7,28 @@ SYNOPSIS -------- #include + Compile and link with -lmemcached .. function:: void memcached_quit (memcached_st *ptr) -Compile and link with -lmemcached + :param ptr: pointer to initialized `memcached_st` struct DESCRIPTION ----------- :func:`memcached_quit` will disconnect you from all currently connected -servers. It will also reset the state of the connection (ie, any :func:`memcached_fetch` you are in the middle of will be terminated). This function is -called automatically when you call :func:`memcached_free` on the :type:`memcached_st` structure. +servers. It will also reset the state of the connection (i.e., any +:func:`memcached_fetch` you are in the middle of will be terminated). This +function is called automatically when you call :func:`memcached_free` on the +: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 :func:`memcached_fetch`. -RETURN ------- +RETURN VALUE +------------ A value of type :type:`memcached_return_t` is returned On success that value will be `MEMCACHED_SUCCESS`. Use :func:`memcached_strerror` to @@ -36,4 +39,12 @@ SEE ALSO .. only:: man - :manpage:`memcached(1)` :manpage:`libmemcached(3)` :manpage:`memcached_strerror(3)` + :manpage:`memcached(1)` + :manpage:`libmemcached(3)` + :manpage:`memcached_strerror(3)` + +.. only:: html + + * :manpage:`memcached(1)` + * :doc:`../libmemcached` + * :doc:`memcached_strerror`