~drizzle-trunk/drizzle/development

2244.1.1 by Monty Taylor
Split libdrizzle into 1.0 and 2.0. Applied the C++ changes to 2.0 branch.
1
/*
2
 * Drizzle Client & Protocol Library
3
 *
4
 * Copyright (C) 2008 Eric Day (eday@oddments.org)
5
 * All rights reserved.
6
 *
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
 *
35
 */
36
2449.1.4 by Brian Aker
Complete update of libdrizzle
37
#pragma once
38
2244.1.1 by Monty Taylor
Split libdrizzle into 1.0 and 2.0. Applied the C++ changes to 2.0 branch.
39
/**
40
 * @file
41
 * @brief Drizzle Declarations for Servers
42
 */
43
2449.1.2 by Brian Aker
Additional fixes for libdrizzle.
44
#include <libdrizzle-2.0/drizzle.h>
45
#include <libdrizzle-2.0/conn_server.h>
46
#include <libdrizzle-2.0/handshake_server.h>
47
#include <libdrizzle-2.0/command_server.h>
48
#include <libdrizzle-2.0/result_server.h>
49
#include <libdrizzle-2.0/column_server.h>
50
#include <libdrizzle-2.0/row_server.h>
51
#include <libdrizzle-2.0/field_server.h>
2244.1.1 by Monty Taylor
Split libdrizzle into 1.0 and 2.0. Applied the C++ changes to 2.0 branch.
52
53
#ifdef __cplusplus
54
extern "C" {
55
#endif
56
57
/**
58
 * @defgroup drizzle_server_interface Drizzle Server Interface
59
 */
60
61
/**
62
 * @addtogroup drizzle_server Drizzle Declarations for Servers
63
 * @ingroup drizzle_server_interface
64
 * @{
65
 */
66
67
/**
68
 * Add TCP (IPv4 or IPv6) connection for listening with common arguments.
69
 *
70
 * @param[in] drizzle Drizzle structure previously initialized with
71
 *  drizzle_create() or drizzle_clone().
72
 * @param[in] con Caller allocated structure, or NULL to allocate one.
73
 * @param[in] host Host to listen on. This may be a hostname to resolve, an
74
 *  IPv4 address, or an IPv6 address. This is passed directly to getaddrinfo().
75
 * @param[in] port Port to connect to.
76
 * @param[in] backlog Number of backlog connections passed to listen().
77
 * @param[in] options Drizzle connection options to add.
78
 * @return Same return as drizzle_con_create().
79
 */
80
DRIZZLE_API
81
drizzle_con_st *drizzle_con_add_tcp_listen(drizzle_st *drizzle,
82
                                           const char *host, in_port_t port,
83
                                           int backlog,
84
                                           drizzle_con_options_t options);
85
86
/**
87
 * Add unix domain socket connection for listening with common arguments.
88
 *
89
 * @param[in] drizzle Drizzle structure previously initialized with
90
 *  drizzle_create() or drizzle_clone().
91
 * @param[in] uds Path to unix domain socket to use for listening.
92
 * @param[in] backlog Number of backlog connections passed to listen().
93
 * @param[in] options Drizzle connection options to add.
94
 * @return Same return as drizzle_con_create().
95
 */
96
DRIZZLE_API
97
drizzle_con_st *drizzle_con_add_uds_listen(drizzle_st *drizzle,
98
                                           const char *uds, int backlog,
99
                                           drizzle_con_options_t options);
100
101
/**
102
 * Get next connection marked for listening that is ready for I/O.
103
 *
104
 * @param[in] drizzle Drizzle structure previously initialized with
105
 *  drizzle_create() or drizzle_clone().
106
 * @return Connection that is ready to accept, or NULL if there are none.
107
 */
108
DRIZZLE_API
109
drizzle_con_st *drizzle_con_ready_listen(drizzle_st *drizzle);
110
111
/**
112
 * Accept a new connection and initialize the connection structure for it.
113
 *
114
 * @param[in] drizzle Drizzle structure previously initialized with
115
 *  drizzle_create() or drizzle_clone().
116
 * @param[out] ret_ptr Standard drizzle return value.
117
 * @return Same return as drizzle_con_create().
118
 */
119
DRIZZLE_API
2463.1.4 by Brian Aker
Remove con from being passed object.
120
drizzle_con_st *drizzle_con_accept(drizzle_st *drizzle,
2244.1.1 by Monty Taylor
Split libdrizzle into 1.0 and 2.0. Applied the C++ changes to 2.0 branch.
121
                                   drizzle_return_t *ret_ptr);
122
123
/** @} */
124
125
#ifdef  __cplusplus
126
}
127
#endif