← Back to branch summary

~drizzle-trunk/drizzle/development

« back to all changes in this revision

Viewing changes to libdrizzle-2.0/libdrizzle/handshake_client.h

  • Committer: Andrew Hutchings
  • Date: 2011-02-01 10:23:22 UTC
  • mto: (2136.1.1 build)
  • mto: This revision was merged to the branch mainline in revision 2137.
  • Revision ID: andrew@linuxjedi.co.uk-20110201102322-oxztcyrjzg3c7yta
Fix counters cleanup

Show diffs side-by-side

added added

removed removed

Lines of Context:
libdrizzle-2.0/libdrizzle/handshake_client.h
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 Handshake Declarations for Clients
40
 
 */
41
 
 
42
 
#ifndef __DRIZZLE_HANDSHAKE_CLIENT_H
43
 
#define __DRIZZLE_HANDSHAKE_CLIENT_H
44
 
 
45
 
#ifdef __cplusplus
46
 
extern "C" {
47
 
#endif
48
 
 
49
 
/**
50
 
 * @addtogroup drizzle_handshake_client Handshake Declarations for Clients
51
 
 * @ingroup drizzle_client_interface
52
 
 *
53
 
 * These functions are used to send and receive handshake packets for a client.
54
 
 * These are only used by low-level clients when the DRIZZLE_CON_RAW_PACKET
55
 
 * option is set, so most applications will never need to use these.
56
 
 * @{
57
 
 */
58
 
 
59
 
/**
60
 
 * Read handshake packet from the server in a client.
61
 
 *
62
 
 * @param[in] con Connection structure previously initialized with
63
 
 *  drizzle_con_create(), drizzle_con_clone(), or related functions.
64
 
 * @return Standard drizzle return value.
65
 
 */
66
 
DRIZZLE_API
67
 
drizzle_return_t drizzle_handshake_server_read(drizzle_con_st *con);
68
 
 
69
 
/**
70
 
 * Write client handshake packet to a server.
71
 
 *
72
 
 * @param[in] con Connection structure previously initialized with
73
 
 *  drizzle_con_create(), drizzle_con_clone(), or related functions.
74
 
 * @return Standard drizzle return value.
75
 
 */
76
 
DRIZZLE_API
77
 
drizzle_return_t drizzle_handshake_client_write(drizzle_con_st *con);
78
 
 
79
 
/** @} */
80
 
 
81
 
#ifdef __cplusplus
82
 
}
83
 
#endif
84
 
 
85
 
#endif /* __DRIZZLE_HANDSHAKE_CLIENT_H */