~drizzle-trunk/libdrizzle/jenkins-Libdrizzle-78

« back to all changes in this revision

Viewing changes to libdrizzle/state.h

  • Committer: Andrew Hutchings
  • Date: 2012-09-03 18:38:34 UTC
  • Revision ID: git-v1:e936672f2f2e4af2b54de08ebf06d53ca1dc6872
The "it compiles!" version

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
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
#pragma once
 
38
 
 
39
/**
 
40
 * @file
 
41
 * @brief State Machine Declarations
 
42
 */
 
43
 
 
44
#ifdef __cplusplus
 
45
extern "C" {
 
46
#endif
 
47
 
 
48
/**
 
49
 * @addtogroup drizzle_state State Machine Declarations
 
50
 *
 
51
 * These functions are used in the protocol parsing state machine. Not all
 
52
 * functions are defined in state.c, they are in the most appropriate source
 
53
 * file (for example, handshake.c for drizzle_state_handshake_server_read).
 
54
 * @{
 
55
 */
 
56
 
 
57
/**
 
58
 * Main state loop for connections.
 
59
 *
 
60
 * @param[in] con Connection structure previously initialized with
 
61
 *  drizzle_con_create(), drizzle_con_clone(), or related functions.
 
62
 * @return Standard drizzle return value.
 
63
 */
 
64
drizzle_return_t drizzle_state_loop(drizzle_con_st *con);
 
65
 
 
66
/* Functions in state.c */
 
67
drizzle_return_t drizzle_state_packet_read(drizzle_con_st *con);
 
68
 
 
69
/* Functions in conn.c */
 
70
drizzle_return_t drizzle_state_addrinfo(drizzle_con_st *con);
 
71
drizzle_return_t drizzle_state_connect(drizzle_con_st *con);
 
72
drizzle_return_t drizzle_state_connecting(drizzle_con_st *con);
 
73
drizzle_return_t drizzle_state_read(drizzle_con_st *con);
 
74
drizzle_return_t drizzle_state_write(drizzle_con_st *con);
 
75
drizzle_return_t drizzle_state_listen(drizzle_con_st *con);
 
76
 
 
77
/* Functions in handshake.c */
 
78
drizzle_return_t drizzle_state_handshake_server_read(drizzle_con_st *con);
 
79
drizzle_return_t drizzle_state_handshake_server_write(drizzle_con_st *con);
 
80
drizzle_return_t drizzle_state_handshake_client_read(drizzle_con_st *con);
 
81
drizzle_return_t drizzle_state_handshake_client_write(drizzle_con_st *con);
 
82
drizzle_return_t drizzle_state_handshake_ssl_client_write(drizzle_con_st *con);
 
83
drizzle_return_t drizzle_state_handshake_result_read(drizzle_con_st *con);
 
84
 
 
85
/* Functions in command.c */
 
86
drizzle_return_t drizzle_state_command_read(drizzle_con_st *con);
 
87
drizzle_return_t drizzle_state_command_write(drizzle_con_st *con);
 
88
 
 
89
/* Functions in result.c */
 
90
drizzle_return_t drizzle_state_result_read(drizzle_con_st *con);
 
91
drizzle_return_t drizzle_state_result_write(drizzle_con_st *con);
 
92
 
 
93
/* Functions in column.c */
 
94
drizzle_return_t drizzle_state_column_read(drizzle_con_st *con);
 
95
drizzle_return_t drizzle_state_column_write(drizzle_con_st *con);
 
96
 
 
97
/* Functions in row.c */
 
98
drizzle_return_t drizzle_state_row_read(drizzle_con_st *con);
 
99
drizzle_return_t drizzle_state_row_write(drizzle_con_st *con);
 
100
 
 
101
/* Functions in field.c */
 
102
drizzle_return_t drizzle_state_field_read(drizzle_con_st *con);
 
103
drizzle_return_t drizzle_state_field_write(drizzle_con_st *con);
 
104
 
 
105
/** @} */
 
106
 
 
107
#ifdef __cplusplus
 
108
}
 
109
#endif