Merge from build trunk.
[m6w6/libmemcached] / libmemcached / io.hpp
1 /* vim:expandtab:shiftwidth=2:tabstop=2:smarttab:
2 *
3 * LibMemcached
4 *
5 * Copyright (C) 2011 Data Differential, http://datadifferential.com/
6 * Copyright (C) 2006-2009 Brian Aker
7 * All rights reserved.
8 *
9 * Redistribution and use in source and binary forms, with or without
10 * modification, are permitted provided that the following conditions are
11 * met:
12 *
13 * * Redistributions of source code must retain the above copyright
14 * notice, this list of conditions and the following disclaimer.
15 *
16 * * Redistributions in binary form must reproduce the above
17 * copyright notice, this list of conditions and the following disclaimer
18 * in the documentation and/or other materials provided with the
19 * distribution.
20 *
21 * * The names of its contributors may not be used to endorse or
22 * promote products derived from this software without specific prior
23 * written permission.
24 *
25 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
26 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
27 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
28 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
29 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
30 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
31 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
32 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
33 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
34 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
35 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
36 *
37 */
38
39 #pragma once
40
41 bool memcached_io_write(memcached_server_write_instance_st ptr);
42
43 ssize_t memcached_io_write(memcached_server_write_instance_st ptr,
44 const void *buffer, size_t length, bool with_flush);
45
46 ssize_t memcached_io_writev(memcached_server_write_instance_st ptr,
47 libmemcached_io_vector_st vector[],
48 const size_t number_of, const bool with_flush);
49
50 memcached_return_t memcached_io_wait_for_write(memcached_server_write_instance_st ptr);
51
52 void memcached_io_reset(memcached_server_write_instance_st ptr);
53
54 memcached_return_t memcached_io_read(memcached_server_write_instance_st ptr,
55 void *buffer, size_t length, ssize_t& nread);
56
57 /* Read a line (terminated by '\n') into the buffer */
58 memcached_return_t memcached_io_readline(memcached_server_write_instance_st ptr,
59 char *buffer_ptr,
60 size_t size,
61 size_t& total);
62
63 void memcached_io_close(memcached_server_write_instance_st ptr);
64
65 /* Read n bytes of data from the server and store them in dta */
66 memcached_return_t memcached_safe_read(memcached_server_write_instance_st ptr,
67 void *dta,
68 const size_t size);
69
70 memcached_server_write_instance_st memcached_io_get_readable_server(memcached_st *memc);
71
72 memcached_return_t memcached_io_slurp(memcached_server_write_instance_st ptr);