Updating for 1.0.2 release
[awesomized/libmemcached] / libmemcached / quit.cc
1 /* vim:expandtab:shiftwidth=2:tabstop=2:smarttab:
2 *
3 * Libmemcached library
4 *
5 * Copyright (C) 2011 Data Differential, http://datadifferential.com/
6 * Copyright (C) 2010 Brian Aker All rights reserved.
7 *
8 * Redistribution and use in source and binary forms, with or without
9 * modification, are permitted provided that the following conditions are
10 * met:
11 *
12 * * Redistributions of source code must retain the above copyright
13 * notice, this list of conditions and the following disclaimer.
14 *
15 * * Redistributions in binary form must reproduce the above
16 * copyright notice, this list of conditions and the following disclaimer
17 * in the documentation and/or other materials provided with the
18 * distribution.
19 *
20 * * The names of its contributors may not be used to endorse or
21 * promote products derived from this software without specific prior
22 * written permission.
23 *
24 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
25 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
26 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
27 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
28 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
29 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
30 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
31 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
32 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
33 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
34 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
35 *
36 */
37
38 #include <libmemcached/common.h>
39
40 /*
41 This closes all connections (forces flush of input as well).
42
43 Maybe add a host specific, or key specific version?
44
45 The reason we send "quit" is that in case we have buffered IO, this
46 will force data to be completed.
47 */
48
49 void memcached_quit_server(memcached_server_st *ptr, bool io_death)
50 {
51 if (ptr->fd != INVALID_SOCKET)
52 {
53 if (io_death == false and memcached_is_udp(ptr->root) == false and ptr->options.is_shutting_down == false)
54 {
55 ptr->options.is_shutting_down= true;
56
57 memcached_return_t rc;
58 if (ptr->root->flags.binary_protocol)
59 {
60 protocol_binary_request_quit request= {}; // = {.bytes= {0}};
61 request.message.header.request.magic = PROTOCOL_BINARY_REQ;
62 request.message.header.request.opcode = PROTOCOL_BINARY_CMD_QUIT;
63 request.message.header.request.datatype = PROTOCOL_BINARY_RAW_BYTES;
64 rc= memcached_do(ptr, request.bytes, sizeof(request.bytes), true);
65 }
66 else
67 {
68 rc= memcached_do(ptr, memcached_literal_param("quit\r\n"), true);
69 }
70
71 WATCHPOINT_ASSERT(rc == MEMCACHED_SUCCESS or rc == MEMCACHED_FETCH_NOTFINISHED);
72
73 /* read until socket is closed, or there is an error
74 * closing the socket before all data is read
75 * results in server throwing away all data which is
76 * not read
77 *
78 * In .40 we began to only do this if we had been doing buffered
79 * requests of had replication enabled.
80 */
81 if (ptr->root->flags.buffer_requests or ptr->root->number_of_replicas)
82 {
83 memcached_return_t rc_slurp;
84 while (memcached_continue(rc_slurp= memcached_io_slurp(ptr))) {} ;
85 WATCHPOINT_ASSERT(rc_slurp == MEMCACHED_CONNECTION_FAILURE);
86 }
87
88 /*
89 * memcached_io_read may call memcached_quit_server with io_death if
90 * it encounters problems, but we don't care about those occurences.
91 * The intention of that loop is to drain the data sent from the
92 * server to ensure that the server processed all of the data we
93 * sent to the server.
94 */
95 ptr->server_failure_counter= 0;
96 }
97 memcached_io_close(ptr);
98 }
99
100 ptr->state= MEMCACHED_SERVER_STATE_NEW;
101 ptr->cursor_active= 0;
102 ptr->io_bytes_sent= 0;
103 ptr->write_buffer_offset= size_t(ptr->root and memcached_is_udp(ptr->root) ? UDP_DATAGRAM_HEADER_LENGTH : 0);
104 ptr->read_buffer_length= 0;
105 ptr->read_ptr= ptr->read_buffer;
106 ptr->options.is_shutting_down= false;
107 memcached_server_response_reset(ptr);
108
109 // We reset the version so that if we end up talking to a different server
110 // we don't have stale server version information.
111 ptr->major_version= ptr->minor_version= ptr->micro_version= UINT8_MAX;
112
113 if (io_death)
114 {
115 memcached_mark_server_for_timeout(ptr);
116 }
117 }
118
119 void send_quit(memcached_st *ptr)
120 {
121 for (uint32_t x= 0; x < memcached_server_count(ptr); x++)
122 {
123 memcached_server_write_instance_st instance=
124 memcached_server_instance_fetch(ptr, x);
125
126 memcached_quit_server(instance, false);
127 }
128 }
129
130 void memcached_quit(memcached_st *ptr)
131 {
132 if (memcached_failed(initialize_query(ptr)))
133 {
134 return;
135 }
136
137 send_quit(ptr);
138 }