~patrick-crews/drizzle/dbqp_server_setup

« back to all changes in this revision

Viewing changes to libdrizzle-2.0/libdrizzle/result_client.h

  • Committer: Monty Taylor
  • Date: 2011-03-22 18:39:54 UTC
  • mto: (2246.1.1 build)
  • mto: This revision was merged to the branch mainline in revision 2247.
  • Revision ID: mordred@inaugust.com-20110322183954-fz8ciuywjz2llbyo
Split libdrizzle into 1.0 and 2.0. Applied the C++ changes to 2.0 branch.

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
/*
 
2
 * Drizzle Client & Protocol Library
 
3
 *
 
4
 * Copyright (C) 2008 Eric Day (eday@oddments.org)
 
5
 * All rights reserved.
 
6
 *
 
7
 * Redistribution and use in source and binary forms, with or without
 
8
 * modification, are permitted provided that the following conditions are
 
9
 * met:
 
10
 *
 
11
 *     * Redistributions of source code must retain the above copyright
 
12
 * notice, this list of conditions and the following disclaimer.
 
13
 *
 
14
 *     * Redistributions in binary form must reproduce the above
 
15
 * copyright notice, this list of conditions and the following disclaimer
 
16
 * in the documentation and/or other materials provided with the
 
17
 * distribution.
 
18
 *
 
19
 *     * The names of its contributors may not be used to endorse or
 
20
 * promote products derived from this software without specific prior
 
21
 * written permission.
 
22
 *
 
23
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 
24
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 
25
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
 
26
 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
 
27
 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 
28
 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 
29
 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 
30
 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
 
31
 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 
32
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 
33
 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 
34
 *
 
35
 */
 
36
 
 
37
/**
 
38
 * @file
 
39
 * @brief Result Declarations for Clients
 
40
 */
 
41
 
 
42
#ifndef __DRIZZLE_RESULT_CLIENT_H
 
43
#define __DRIZZLE_RESULT_CLIENT_H
 
44
 
 
45
#ifdef __cplusplus
 
46
extern "C" {
 
47
#endif
 
48
 
 
49
/**
 
50
 * @addtogroup drizzle_result_client Result Declarations for Clients
 
51
 * @ingroup drizzle_client_interface
 
52
 *
 
53
 * These functions read or buffer the result for a client command.
 
54
 * @{
 
55
 */
 
56
 
 
57
/**
 
58
 * Read result packet.
 
59
 */
 
60
DRIZZLE_API
 
61
drizzle_result_st *drizzle_result_read(drizzle_con_st *con,
 
62
                                       drizzle_result_st *result,
 
63
                                       drizzle_return_t *ret_ptr);
 
64
 
 
65
/**
 
66
 * Buffer all data for a result.
 
67
 */
 
68
DRIZZLE_API
 
69
drizzle_return_t drizzle_result_buffer(drizzle_result_st *result);
 
70
 
 
71
/**
 
72
 * Get result row packet size.
 
73
 */
 
74
DRIZZLE_API
 
75
size_t drizzle_result_row_size(drizzle_result_st *result);
 
76
 
 
77
/** @} */
 
78
 
 
79
#ifdef __cplusplus
 
80
}
 
81
#endif
 
82
 
 
83
#endif /* __DRIZZLE_RESULT_CLIENT_H */