Drizzled Public API Documentation

conn_client.h
Go to the documentation of this file.
00001 /*
00002  * Drizzle Client & Protocol Library
00003  *
00004  * Copyright (C) 2008 Eric Day (eday@oddments.org)
00005  * All rights reserved.
00006  *
00007  * Redistribution and use in source and binary forms, with or without
00008  * modification, are permitted provided that the following conditions are
00009  * met:
00010  *
00011  *     * Redistributions of source code must retain the above copyright
00012  * notice, this list of conditions and the following disclaimer.
00013  *
00014  *     * Redistributions in binary form must reproduce the above
00015  * copyright notice, this list of conditions and the following disclaimer
00016  * in the documentation and/or other materials provided with the
00017  * distribution.
00018  *
00019  *     * The names of its contributors may not be used to endorse or
00020  * promote products derived from this software without specific prior
00021  * written permission.
00022  *
00023  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
00024  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
00025  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
00026  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
00027  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
00028  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
00029  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
00030  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
00031  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
00032  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
00033  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
00034  *
00035  */
00036 
00042 #ifndef __DRIZZLE_CON_CLIENT_H
00043 #define __DRIZZLE_CON_CLIENT_H
00044 
00045 #ifdef __cplusplus
00046 extern "C" {
00047 #endif
00048 
00062 DRIZZLE_API
00063 drizzle_return_t drizzle_con_connect(drizzle_con_st *con);
00064 
00075 DRIZZLE_API
00076 drizzle_result_st *drizzle_con_quit(drizzle_con_st *con,
00077                                     drizzle_result_st *result,
00078                                     drizzle_return_t *ret_ptr);
00079 
00083 DRIZZLE_API
00084 drizzle_result_st *drizzle_quit(drizzle_con_st *con,
00085                                 drizzle_result_st *result,
00086                                 drizzle_return_t *ret_ptr);
00087 
00099 DRIZZLE_API
00100 drizzle_result_st *drizzle_con_select_db(drizzle_con_st *con,
00101                                          drizzle_result_st *result,
00102                                          const char *db,
00103                                          drizzle_return_t *ret_ptr);
00104 
00108 DRIZZLE_API
00109 drizzle_result_st *drizzle_select_db(drizzle_con_st *con,
00110                                      drizzle_result_st *result,
00111                                      const char *db,
00112                                      drizzle_return_t *ret_ptr);
00113 
00124 DRIZZLE_API
00125 drizzle_result_st *drizzle_con_shutdown(drizzle_con_st *con,
00126                                         drizzle_result_st *result,
00127                                         drizzle_return_t *ret_ptr);
00128 
00129 DRIZZLE_API
00130 drizzle_result_st *drizzle_kill(drizzle_con_st *con,
00131                                 drizzle_result_st *result,
00132                                 uint32_t query_id,
00133                                 drizzle_return_t *ret_ptr);
00134 
00138 #define DRIZZLE_SHUTDOWN_DEFAULT 0
00139 DRIZZLE_API
00140 drizzle_result_st *drizzle_shutdown(drizzle_con_st *con,
00141                                     drizzle_result_st *result, uint32_t level,
00142                                     drizzle_return_t *ret_ptr);
00143 
00154 DRIZZLE_API
00155 drizzle_result_st *drizzle_con_ping(drizzle_con_st *con,
00156                                     drizzle_result_st *result,
00157                                     drizzle_return_t *ret_ptr);
00158 
00162 DRIZZLE_API
00163 drizzle_result_st *drizzle_ping(drizzle_con_st *con,
00164                                 drizzle_result_st *result,
00165                                 drizzle_return_t *ret_ptr);
00166 
00181 DRIZZLE_API
00182 drizzle_result_st *drizzle_con_command_write(drizzle_con_st *con,
00183                                              drizzle_result_st *result,
00184                                              drizzle_command_t command,
00185                                              const void *data, size_t size,
00186                                              size_t total,
00187                                              drizzle_return_t *ret_ptr);
00188 
00191 #ifdef __cplusplus
00192 }
00193 #endif
00194 
00195 #endif /* __DRIZZLE_CON_CLIENT_H */