~drizzle-trunk/drizzle/development

1712.1.1 by Monty Taylor
Merged libdrizzle directly into tree.
1
/*
2
 * Drizzle Client & Protocol Library
3
 *
4
 * Copyright (C) 2008 Eric Day (eday@oddments.org)
5
 * All rights reserved.
6
 *
1971.2.1 by kalebral at gmail
update files that did not have license or had incorrect license structure
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
 *
1712.1.1 by Monty Taylor
Merged libdrizzle directly into tree.
35
 */
36
2449.1.4 by Brian Aker
Complete update of libdrizzle
37
#pragma once
38
1712.1.1 by Monty Taylor
Merged libdrizzle directly into tree.
39
/**
40
 * @file
41
 * @brief Result Declarations for Servers
42
 */
43
44
#ifdef __cplusplus
45
extern "C" {
46
#endif
47
48
/**
49
 * @addtogroup drizzle_result_server Result Declarations for Servers
50
 * @ingroup drizzle_server_interface
51
 *
52
 * These functions allow you to send result packets over a connection.
53
 * @{
54
 */
55
56
/**
57
 * Write result packet.
58
 */
59
DRIZZLE_API
60
drizzle_return_t drizzle_result_write(drizzle_con_st *con,
61
                                      drizzle_result_st *result, bool flush);
62
63
/**
64
 * Set result row packet size.
65
 */
66
DRIZZLE_API
67
void drizzle_result_set_row_size(drizzle_result_st *result, size_t size);
68
69
/**
70
 * Set result row packet size from field and size arrays.
71
 */
72
DRIZZLE_API
73
void drizzle_result_calc_row_size(drizzle_result_st *result,
74
                                  const drizzle_field_t *field,
75
                                  const size_t *size);
76
77
/**
78
 * Set information string for a result.
79
 */
80
DRIZZLE_API
81
void drizzle_result_set_eof(drizzle_result_st *result, bool eof);
82
83
/**
84
 * Set information string for a result.
85
 */
86
DRIZZLE_API
87
void drizzle_result_set_info(drizzle_result_st *result, const char *info);
88
89
/**
90
 * Set error string for a result.
91
 */
92
DRIZZLE_API
93
void drizzle_result_set_error(drizzle_result_st *result, const char *error);
94
95
/**
96
 * Set server defined error code for a result.
97
 */
98
DRIZZLE_API
99
void drizzle_result_set_error_code(drizzle_result_st *result,
100
                                   uint16_t error_code);
101
102
/**
103
 * Set SQL state code for a result.
104
 */
105
DRIZZLE_API
106
void drizzle_result_set_sqlstate(drizzle_result_st *result,
107
                                 const char *sqlstate);
108
109
/**
110
 * Set the number of warnings encounted during a command.
111
 */
112
DRIZZLE_API
113
void drizzle_result_set_warning_count(drizzle_result_st *result,
114
                                      uint16_t warning_count);
115
116
/**
117
 * Set inet ID of the last command, if any.
118
 */
119
DRIZZLE_API
120
void drizzle_result_set_insert_id(drizzle_result_st *result,
121
                                  uint64_t insert_id);
122
123
/**
124
 * Set the number of affected rows during the command.
125
 */
126
DRIZZLE_API
127
void drizzle_result_set_affected_rows(drizzle_result_st *result,
128
                                      uint64_t affected_rows);
129
130
/**
131
 * Set the number of fields in a result set.
132
 */
133
DRIZZLE_API
134
void drizzle_result_set_column_count(drizzle_result_st *result,
135
                                     uint16_t column_count);
136
137
/** @} */
138
139
#ifdef __cplusplus
140
}
141
#endif