← Back to branch summary

~drizzle-trunk/drizzle/development

« back to all changes in this revision

Viewing changes to libdrizzle/handshake_server.h

  • Committer: Monty Taylor
  • Date: 2010-08-20 15:05:54 UTC
  • mfrom: (1720.1.7 build)
  • Revision ID: mordred@inaugust.com-20100820150554-fuwf8zs8qpzhpx6y
Added libdrizzle to the tree.

Show diffs side-by-side

added added

removed removed

Lines of Context:
libdrizzle/handshake_server.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 Servers
 
14
 */
 
15
 
 
16
#ifndef __DRIZZLE_HANDSHAKE_SERVER_H
 
17
#define __DRIZZLE_HANDSHAKE_SERVER_H
 
18
 
 
19
#ifdef __cplusplus
 
20
extern "C" {
 
21
#endif
 
22
 
 
23
/**
 
24
 * @addtogroup drizzle_handshake_server Handshake Declarations for Servers
 
25
 * @ingroup drizzle_server_interface
 
26
 *
 
27
 * These functions are used to send and receive handshake packets in a server.
 
28
 * @{
 
29
 */
 
30
 
 
31
/**
 
32
 * Write server handshake packet to a client.
 
33
 *
 
34
 * @param[in] con Connection structure previously initialized with
 
35
 *  drizzle_con_create(), drizzle_con_clone(), or related functions.
 
36
 * @return Standard drizzle return value.
 
37
 */
 
38
DRIZZLE_API
 
39
drizzle_return_t drizzle_handshake_server_write(drizzle_con_st *con);
 
40
 
 
41
/**
 
42
 * Read handshake packet from the client in a server.
 
43
 *
 
44
 * @param[in] con Connection structure previously initialized with
 
45
 *  drizzle_con_create(), drizzle_con_clone(), or related functions.
 
46
 * @return Standard drizzle return value.
 
47
 */
 
48
DRIZZLE_API
 
49
drizzle_return_t drizzle_handshake_client_read(drizzle_con_st *con);
 
50
 
 
51
/** @} */
 
52
 
 
53
#ifdef __cplusplus
 
54
}
 
55
#endif
 
56
 
 
57
#endif /* __DRIZZLE_HANDSHAKE_SERVER_H */