← Back to branch summary

~drizzle-trunk/drizzle/development

« back to all changes in this revision

Viewing changes to libdrizzle-2.0/pack.h

  • Committer: Mark Atwood
  • Date: 2012-01-04 16:59:32 UTC
  • mfrom: (2478.2.3 real-key-use-catalog)
  • Revision ID: me@mark.atwood.name-20120104165932-cm0xqs4by0u3p4cy
merge lp:~stewart/drizzle/key-use-catalog

Show diffs side-by-side

added added

removed removed

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