libdrizzle Developer Documentation

drizzle.h
Go to the documentation of this file.
1/*
2 * Drizzle Client & Protocol Library
3 *
4 * Copyright (C) 2008 Eric Day (eday@oddments.org)
5 * All rights reserved.
6 *
7 * Use and distribution licensed under the BSD license. See
8 * the COPYING file in this directory for full text.
9 */
10
16#ifndef __DRIZZLE_H
17#define __DRIZZLE_H
18
19#if !defined(__cplusplus) && !defined(_WIN32)
20# include <stdbool.h>
21#endif
22
23#include <inttypes.h>
24#include <sys/types.h>
25
26#ifdef _WIN32
27# include <winsock2.h>
28# include <Ws2tcpip.h>
29#else
30# include <sys/socket.h>
31# include <netinet/in.h>
32# include <arpa/inet.h>
33# include <sys/un.h>
34# include <netdb.h>
35# include <poll.h>
36#endif
37
40#include <libdrizzle/structs.h>
41#include <libdrizzle/conn.h>
42#include <libdrizzle/result.h>
43#include <libdrizzle/column.h>
44
45#ifdef __cplusplus
46extern "C" {
47#endif
48
69const char *drizzle_version(void);
70
77const char *drizzle_bugreport(void);
78
86const char *drizzle_verbose_name(drizzle_verbose_t verbose);
87
98
107drizzle_st *drizzle_clone(drizzle_st *drizzle, const drizzle_st *from);
108
116void drizzle_free(drizzle_st *drizzle);
117
126const char *drizzle_error(const drizzle_st *drizzle);
127
136int drizzle_errno(const drizzle_st *drizzle);
137
146uint16_t drizzle_error_code(const drizzle_st *drizzle);
147
156const char *drizzle_sqlstate(const drizzle_st *drizzle);
157
167
176void drizzle_set_options(drizzle_st *drizzle, drizzle_options_t options);
177
186void drizzle_add_options(drizzle_st *drizzle, drizzle_options_t options);
187
197
206void *drizzle_context(const drizzle_st *drizzle);
207
216void drizzle_set_context(drizzle_st *drizzle, void *context);
217
228 drizzle_context_free_fn *function);
229
239int drizzle_timeout(const drizzle_st *drizzle);
240
250void drizzle_set_timeout(drizzle_st *drizzle, int timeout);
251
261
272void drizzle_set_verbose(drizzle_st *drizzle, drizzle_verbose_t verbose);
273
285void drizzle_set_log_fn(drizzle_st *drizzle, drizzle_log_fn *function,
286 void *context);
287
305 drizzle_event_watch_fn *function,
306 void *context);
307
321
333 const drizzle_con_st *from);
334
343
351void drizzle_con_free_all(drizzle_st *drizzle);
352
362
372
375#ifdef __cplusplus
376}
377#endif
378
379#endif /* __DRIZZLE_H */
Column Declarations.
Connection Declarations.
Defines, typedefs, enums, and macros.
drizzle_return_t
Definition constants.h:69
drizzle_verbose_t
Definition constants.h:102
void drizzle_context_free_fn(drizzle_st *drizzle, void *context)
Definition constants.h:417
drizzle_return_t drizzle_event_watch_fn(drizzle_con_st *con, short events, void *context)
Definition constants.h:438
void drizzle_log_fn(const char *line, drizzle_verbose_t verbose, void *context)
Definition constants.h:419
drizzle_options_t drizzle_options(const drizzle_st *drizzle)
Definition drizzle.c:166
void drizzle_remove_options(drizzle_st *drizzle, drizzle_options_t options)
Definition drizzle.c:181
drizzle_con_st * drizzle_con_clone(drizzle_st *drizzle, drizzle_con_st *con, const drizzle_con_st *from)
Definition drizzle.c:309
drizzle_con_st * drizzle_con_create(drizzle_st *drizzle, drizzle_con_st *con)
Definition drizzle.c:237
const char * drizzle_version(void)
Definition drizzle.c:43
void drizzle_set_options(drizzle_st *drizzle, drizzle_options_t options)
Definition drizzle.c:171
void * drizzle_context(const drizzle_st *drizzle)
Definition drizzle.c:186
const char * drizzle_verbose_name(drizzle_verbose_t verbose)
Definition drizzle.c:53
const char * drizzle_error(const drizzle_st *drizzle)
Definition drizzle.c:146
void drizzle_set_log_fn(drizzle_st *drizzle, drizzle_log_fn *function, void *context)
Definition drizzle.c:222
int drizzle_errno(const drizzle_st *drizzle)
Definition drizzle.c:151
drizzle_st * drizzle_clone(drizzle_st *drizzle, const drizzle_st *from)
Definition drizzle.c:101
void drizzle_set_timeout(drizzle_st *drizzle, int timeout)
Definition drizzle.c:207
drizzle_con_st * drizzle_con_ready(drizzle_st *drizzle)
Definition drizzle.c:462
void drizzle_set_context_free_fn(drizzle_st *drizzle, drizzle_context_free_fn *function)
Definition drizzle.c:196
void drizzle_set_verbose(drizzle_st *drizzle, drizzle_verbose_t verbose)
Definition drizzle.c:217
void drizzle_set_event_watch_fn(drizzle_st *drizzle, drizzle_event_watch_fn *function, void *context)
Definition drizzle.c:229
const char * drizzle_sqlstate(const drizzle_st *drizzle)
Definition drizzle.c:161
void drizzle_free(drizzle_st *drizzle)
Definition drizzle.c:123
void drizzle_add_options(drizzle_st *drizzle, drizzle_options_t options)
Definition drizzle.c:176
int drizzle_timeout(const drizzle_st *drizzle)
Definition drizzle.c:202
drizzle_st * drizzle_create(drizzle_st *drizzle)
Definition drizzle.c:61
uint16_t drizzle_error_code(const drizzle_st *drizzle)
Definition drizzle.c:156
void drizzle_con_free_all(drizzle_st *drizzle)
Definition drizzle.c:370
drizzle_verbose_t drizzle_verbose(const drizzle_st *drizzle)
Definition drizzle.c:212
drizzle_return_t drizzle_con_wait(drizzle_st *drizzle)
Definition drizzle.c:376
void drizzle_set_context(drizzle_st *drizzle, void *context)
Definition drizzle.c:191
void drizzle_con_free(drizzle_con_st *con)
Definition drizzle.c:343
const char * drizzle_bugreport(void)
Definition drizzle.c:48
drizzle_options_t
Definition constants.h:119
Result Declarations.
Struct Definitions.
Visibility Control Macros.
#define DRIZZLE_API
Definition visibility.h:45