X-Git-Url: https://git.m6w6.name/?a=blobdiff_plain;f=docs%2Fmemcached_quit.rst;h=b94832ec9d8259b42ba64cb339284117d951e42c;hb=dbc62573e1a6dc8cbcc97d0898e8615b0916d6ab;hp=8377f63ce51c0c98abf4fd1b3fc68ef3ea5ce0c3;hpb=50dc8599f105fe915607e6f2d57851fd9acad839;p=awesomized%2Flibmemcached diff --git a/docs/memcached_quit.rst b/docs/memcached_quit.rst index 8377f63c..b94832ec 100644 --- a/docs/memcached_quit.rst +++ b/docs/memcached_quit.rst @@ -10,7 +10,7 @@ SYNOPSIS #include -.. c:function:: void memcached_quit (memcached_st *ptr); +.. c:function:: void memcached_quit (memcached_st *ptr) Compile and link with -lmemcached @@ -19,14 +19,14 @@ 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. +: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()`. +reset connections during the middle of a :c:func:`memcached_fetch`. ------ @@ -34,9 +34,9 @@ RETURN ------ -A value of type :c:type:`memcached_return` 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. +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. ----