|
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 Packing Declarations
|
|
40 |
*/
|
|
41 |
||
42 |
#ifndef __DRIZZLE_PACK_H
|
|
43 |
#define __DRIZZLE_PACK_H
|
|
44 |
||
45 |
#ifdef __cplusplus
|
|
46 |
extern "C" { |
|
47 |
#endif
|
|
48 |
||
49 |
/**
|
|
50 |
* @addtogroup drizzle_pack Packing Declarations
|
|
51 |
*
|
|
52 |
* These functions are used internally to pack various parts of the protocol.
|
|
53 |
* Not all functions are defined in pack.c, they are in the most appropriate
|
|
54 |
* source file (for example, handshake.c for drizzle_pack_client_handshake).
|
|
55 |
* @{
|
|
56 |
*/
|
|
57 |
||
58 |
/**
|
|
59 |
* Pack length-encoded number.
|
|
60 |
*/
|
|
61 |
DRIZZLE_API
|
|
62 |
uint8_t *drizzle_pack_length(uint64_t number, uint8_t *ptr); |
|
63 |
||
64 |
/**
|
|
65 |
* Unpack length-encoded number.
|
|
66 |
*/
|
|
67 |
DRIZZLE_API
|
|
68 |
uint64_t drizzle_unpack_length(drizzle_con_st *con, drizzle_return_t *ret_ptr); |
|
69 |
||
70 |
/**
|
|
71 |
* Pack length-encoded string.
|
|
72 |
*/
|
|
73 |
DRIZZLE_API
|
|
74 |
uint8_t *drizzle_pack_string(char *string, uint8_t *ptr); |
|
75 |
||
76 |
/**
|
|
77 |
* Unpack length-encoded string.
|
|
78 |
*/
|
|
79 |
DRIZZLE_API
|
|
80 |
drizzle_return_t drizzle_unpack_string(drizzle_con_st *con, char *buffer, |
|
81 |
uint64_t max_size); |
|
82 |
||
83 |
/**
|
|
84 |
* Pack user, scramble, and db.
|
|
85 |
*/
|
|
86 |
DRIZZLE_API
|
|
87 |
uint8_t *drizzle_pack_auth(drizzle_con_st *con, uint8_t *ptr, |
|
88 |
drizzle_return_t *ret_ptr); |
|
89 |
||
90 |
/** @} */
|
|
91 |
||
92 |
#ifdef __cplusplus
|
|
93 |
}
|
|
94 |
#endif
|
|
95 |
||
96 |
#endif /* __DRIZZLE_PACK_H */ |