← Back to branch summary

~drizzle-trunk/drizzle/development

« back to all changes in this revision

Viewing changes to libdrizzle/handshake_client.h

Added libdrizzle to the tree.

Show diffs side-by-side

added added

removed removed

Lines of Context:
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
 * Use and distribution licensed under the BSD license.  See
 
8
 * the COPYING file in this directory for full text.
 
9
 */
 
10
 
 
11
/**
 
12
 * @file
 
13
 * @brief Handshake Declarations for Clients
 
14
 */
 
15
 
 
16
#ifndef __DRIZZLE_HANDSHAKE_CLIENT_H
 
17
#define __DRIZZLE_HANDSHAKE_CLIENT_H
 
18
 
 
19
#ifdef __cplusplus
 
20
extern "C" {
 
21
#endif
 
22
 
 
23
/**
 
24
 * @addtogroup drizzle_handshake_client Handshake Declarations for Clients
 
25
 * @ingroup drizzle_client_interface
 
26
 *
 
27
 * These functions are used to send and receive handshake packets for a client.
 
28
 * These are only used by low-level clients when the DRIZZLE_CON_RAW_PACKET
 
29
 * option is set, so most applications will never need to use these.
 
30
 * @{
 
31
 */
 
32
 
 
33
/**
 
34
 * Read handshake packet from the server in a client.
 
35
 *
 
36
 * @param[in] con Connection structure previously initialized with
 
37
 *  drizzle_con_create(), drizzle_con_clone(), or related functions.
 
38
 * @return Standard drizzle return value.
 
39
 */
 
40
DRIZZLE_API
 
41
drizzle_return_t drizzle_handshake_server_read(drizzle_con_st *con);
 
42
 
 
43
/**
 
44
 * Write client handshake packet to a server.
 
45
 *
 
46
 * @param[in] con Connection structure previously initialized with
 
47
 *  drizzle_con_create(), drizzle_con_clone(), or related functions.
 
48
 * @return Standard drizzle return value.
 
49
 */
 
50
DRIZZLE_API
 
51
drizzle_return_t drizzle_handshake_client_write(drizzle_con_st *con);
 
52
 
 
53
/** @} */
 
54
 
 
55
#ifdef __cplusplus
 
56
}
 
57
#endif
 
58
 
 
59
#endif /* __DRIZZLE_HANDSHAKE_CLIENT_H */