~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
37
/**
38
 * @file
39
 * @brief Result Declarations for Servers
40
 */
41
42
#ifndef __DRIZZLE_RESULT_SERVER_H
43
#define __DRIZZLE_RESULT_SERVER_H
44
45
#ifdef __cplusplus
46
extern "C" {
47
#endif
48
49
/**
50
 * @addtogroup drizzle_result_server Result Declarations for Servers
51
 * @ingroup drizzle_server_interface
52
 *
53
 * These functions allow you to send result packets over a connection.
54
 * @{
55
 */
56
57
/**
58
 * Write result packet.
59
 */
60
DRIZZLE_API
61
drizzle_return_t drizzle_result_write(drizzle_con_st *con,
62
                                      drizzle_result_st *result, bool flush);
63
64
/**
65
 * Set result row packet size.
66
 */
67
DRIZZLE_API
68
void drizzle_result_set_row_size(drizzle_result_st *result, size_t size);
69
70
/**
71
 * Set result row packet size from field and size arrays.
72
 */
73
DRIZZLE_API
74
void drizzle_result_calc_row_size(drizzle_result_st *result,
75
                                  const drizzle_field_t *field,
76
                                  const size_t *size);
77
78
/**
79
 * Set information string for a result.
80
 */
81
DRIZZLE_API
82
void drizzle_result_set_eof(drizzle_result_st *result, bool eof);
83
84
/**
85
 * Set information string for a result.
86
 */
87
DRIZZLE_API
88
void drizzle_result_set_info(drizzle_result_st *result, const char *info);
89
90
/**
91
 * Set error string for a result.
92
 */
93
DRIZZLE_API
94
void drizzle_result_set_error(drizzle_result_st *result, const char *error);
95
96
/**
97
 * Set server defined error code for a result.
98
 */
99
DRIZZLE_API
100
void drizzle_result_set_error_code(drizzle_result_st *result,
101
                                   uint16_t error_code);
102
103
/**
104
 * Set SQL state code for a result.
105
 */
106
DRIZZLE_API
107
void drizzle_result_set_sqlstate(drizzle_result_st *result,
108
                                 const char *sqlstate);
109
110
/**
111
 * Set the number of warnings encounted during a command.
112
 */
113
DRIZZLE_API
114
void drizzle_result_set_warning_count(drizzle_result_st *result,
115
                                      uint16_t warning_count);
116
117
/**
118
 * Set inet ID of the last command, if any.
119
 */
120
DRIZZLE_API
121
void drizzle_result_set_insert_id(drizzle_result_st *result,
122
                                  uint64_t insert_id);
123
124
/**
125
 * Set the number of affected rows during the command.
126
 */
127
DRIZZLE_API
128
void drizzle_result_set_affected_rows(drizzle_result_st *result,
129
                                      uint64_t affected_rows);
130
131
/**
132
 * Set the number of fields in a result set.
133
 */
134
DRIZZLE_API
135
void drizzle_result_set_column_count(drizzle_result_st *result,
136
                                     uint16_t column_count);
137
138
/** @} */
139
140
#ifdef __cplusplus
141
}
142
#endif
143
144
#endif /* __DRIZZLE_RESULT_SERVER_H */