X-Git-Url: https://git.m6w6.name/?a=blobdiff_plain;f=docs%2Fmemcached_quit.pod;h=98fd393f5948e36d4bfa1bae9b03200eba53fc10;hb=53034e4b367749c1a4e3771dd85ed27bd3b701cf;hp=b438e3c0bf389e94c28a1149476007b2605e2e47;hpb=a11143256264a00e7437fa23ec8ff5196c5a5c0b;p=awesomized%2Flibmemcached diff --git a/docs/memcached_quit.pod b/docs/memcached_quit.pod index b438e3c0..98fd393f 100755 --- a/docs/memcached_quit.pod +++ b/docs/memcached_quit.pod @@ -8,16 +8,16 @@ C Client Library for memcached (libmemcached, -lmemcached) =head1 SYNOPSIS -#include -void memcached_quit(memcached_st *ptr); + #include -=head1 DESCRIPTION + void memcached_quit (memcached_st *ptr); +=head1 DESCRIPTION memcached_quit() will disconnect you from all currently connected servers. -It will also reset the state of the connection (aka any memcached_fetch you +It will also reset the state of the connection (ie, any memcached_fetch() you are in the middle of will be terminated). This function is called -automatically when you call memcached_free() on the memcached_st structure. +automatically when you call memcached_free() on the C 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 @@ -26,15 +26,18 @@ reset connections during the middle of a memcached_fetch(). =head1 RETURN -memcached_quit() returns memcached_return. The value on success will be MEMCACHED_SUCCESS. For all errors check with memcached_strerror(). +A value of type C is returned +On success that value will be C. +Use memcached_strerror() to translate this value to a printable string. =head1 HOME -To find out more information please check: http://tangent.org/552/libmemcached.html +To find out more information please check: +L =head1 AUTHOR -Brian Aker, brian@tangent.org +Brian Aker, Ebrian@tangent.orgE =head1 SEE ALSO