~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
1971.2.1 by kalebral at gmail
update files that did not have license or had incorrect license structure
37
1712.1.1 by Monty Taylor
Merged libdrizzle directly into tree.
38
/**
39
 * @file
40
 * @brief Drizzle Declarations for Clients
41
 */
42
2449.1.2 by Brian Aker
Additional fixes for libdrizzle.
43
#pragma once
1712.1.1 by Monty Taylor
Merged libdrizzle directly into tree.
44
2449.1.2 by Brian Aker
Additional fixes for libdrizzle.
45
#include <libdrizzle-1.0/drizzle.h>
46
#include <libdrizzle-1.0/conn_client.h>
47
#include <libdrizzle-1.0/handshake_client.h>
48
#include <libdrizzle-1.0/command_client.h>
49
#include <libdrizzle-1.0/query.h>
50
#include <libdrizzle-1.0/result_client.h>
51
#include <libdrizzle-1.0/column_client.h>
52
#include <libdrizzle-1.0/row_client.h>
53
#include <libdrizzle-1.0/field_client.h>
1712.1.1 by Monty Taylor
Merged libdrizzle directly into tree.
54
55
#ifdef __cplusplus
56
extern "C" {
57
#endif
58
59
/**
60
 * @defgroup drizzle_client_interface Drizzle Client Interface
61
 */
62
63
/**
64
 * @addtogroup drizzle_client Drizzle Declarations for Clients
65
 * @ingroup drizzle_client_interface
66
 * @{
67
 */
68
69
/**
70
 * Add TCP (IPv4 or IPv6) connection with common arguments.
71
 *
72
 * @param[in] drizzle Drizzle structure previously initialized with
73
 *  drizzle_create() or drizzle_clone().
74
 * @param[in] con Caller allocated structure, or NULL to allocate one.
75
 * @param[in] host Host to connect to. This may be a hostname to resolve, an
76
 *  IPv4 address, or an IPv6 address. This is passed directly to getaddrinfo().
77
 * @param[in] port Remote port to connect to.
78
 * @param[in] user User to use while establishing the connection.
79
 * @param[in] password Password to use while establishing the connection.
80
 * @param[in] db Initial database to connect to.
81
 * @param[in] options Drizzle connection options to add.
82
 * @return Same return as drizzle_con_create().
83
 */
84
DRIZZLE_API
85
drizzle_con_st *drizzle_con_add_tcp(drizzle_st *drizzle, drizzle_con_st *con,
86
                                    const char *host, in_port_t port,
87
                                    const char *user, const char *password,
88
                                    const char *db,
89
                                    drizzle_con_options_t options);
90
91
/**
92
 * Add unix domain socket connection with common arguments.
93
 *
94
 * @param[in] drizzle Drizzle structure previously initialized with
95
 *  drizzle_create() or drizzle_clone().
96
 * @param[in] con Caller allocated structure, or NULL to allocate one.
97
 * @param[in] uds Path to unix domain socket to use for connection.
98
 * @param[in] user User to use while establishing the connection.
99
 * @param[in] password Password to use while establishing the connection.
100
 * @param[in] db Initial database to connect to.
101
 * @param[in] options Drizzle connection options to add.
102
 * @return Same return as drizzle_con_create().
103
 */
104
DRIZZLE_API
105
drizzle_con_st *drizzle_con_add_uds(drizzle_st *drizzle, drizzle_con_st *con,
106
                                    const char *uds, const char *user,
107
                                    const char *password, const char *db,
108
                                    drizzle_con_options_t options);
109
110
/** @} */
111
112
#ifdef  __cplusplus
113
}
114
#endif