~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 Local Connection Declarations
42
 */
43
44
#ifdef __cplusplus
45
extern "C" {
46
#endif
47
48
/**
49
 * @addtogroup drizzle_con_local Local Connection Declarations
50
 * @ingroup drizzle_con
51
 * @{
52
 */
53
54
/**
55
 * Clear address info, freeing structs if needed.
56
 *
57
 * @param[in] con Connection structure previously initialized with
58
 *  drizzle_con_create(), drizzle_con_clone(), or related functions.
59
 */
60
DRIZZLE_LOCAL
61
void drizzle_con_reset_addrinfo(drizzle_con_st *con);
62
 
63
/**
64
 * Check if state stack is empty.
65
 *
66
 * @param[in] con Connection structure previously initialized with
67
 *  drizzle_con_create(), drizzle_con_clone(), or related functions.
68
 * @return True if empty, false if something is on the stack.
69
 */
70
static inline bool drizzle_state_none(drizzle_con_st *con)
71
{
72
  return con->state_current == 0;
73
}
74
75
/**
76
 * Push a function onto the stack.
77
 *
78
 * @param[in] con Connection structure previously initialized with
79
 *  drizzle_con_create(), drizzle_con_clone(), or related functions.
80
 * @param[in] function Function to push.
81
 */
82
static inline void drizzle_state_push(drizzle_con_st *con,
83
                                      drizzle_state_fn *function)
84
{
85
  /* The maximum stack depth can be determined at compile time, so bump this
86
     constant if needed to avoid the dynamic memory management. */
87
  assert(con->state_current < DRIZZLE_STATE_STACK_SIZE);
88
  con->state_stack[con->state_current]= function;
89
  con->state_current++;
90
}
91
92
/**
93
 * Pop a function off of the stack.
94
 *
95
 * @param[in] con Connection structure previously initialized with
96
 *  drizzle_con_create(), drizzle_con_clone(), or related functions.
97
 */
98
static inline void drizzle_state_pop(drizzle_con_st *con)
99
{
100
  con->state_current--;
101
}
102
103
/**
104
 * Reset the stack so it is empty.
105
 *
106
 * @param[in] con Connection structure previously initialized with
107
 *  drizzle_con_create(), drizzle_con_clone(), or related functions.
108
 */
109
static inline void drizzle_state_reset(drizzle_con_st *con)
110
{
111
  con->state_current= 0;
112
}
113
114
/** @} */
115
116
#ifdef __cplusplus
117
}
118
#endif