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