Merge from Trond
[m6w6/libmemcached] / docs / memcached_quit.pod
1 =head1 NAME
2
3 memcached_quit - Disconnect from all servers
4
5 =head1 LIBRARY
6
7 C Client Library for memcached (libmemcached, -lmemcached)
8
9 =head1 SYNOPSIS
10
11 #include <memcached.h>
12
13 void memcached_quit (memcached_st *ptr);
14
15 =head1 DESCRIPTION
16
17 memcached_quit() will disconnect you from all currently connected servers.
18 It will also reset the state of the connection (ie, any memcached_fetch() you
19 are in the middle of will be terminated). This function is called
20 automatically when you call memcached_free() on the C<memcached_st> structure.
21
22 You do not need to call this on your own. All operations to change server
23 hashes and parameters will handle connections to the server for you. This
24 function is provided mainly so that you can timeout your connections or
25 reset connections during the middle of a memcached_fetch().
26
27 =head1 RETURN
28
29 A value of type C<memcached_return> is returned
30 On success that value will be C<MEMCACHED_SUCCESS>.
31 Use memcached_strerror() to translate this value to a printable string.
32
33 =head1 HOME
34
35 To find out more information please check:
36 L<http://tangent.org/552/libmemcached.html>
37
38 =head1 AUTHOR
39
40 Brian Aker, E<lt>brian@tangent.orgE<gt>
41
42 =head1 SEE ALSO
43
44 memcached(1) libmemcached(3) memcached_strerror(3)
45
46 =cut
47