1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
|
/*
* Copyright (C) 2012 Tobias Brunner
* Hochschule fuer Technik Rapperswil
*
* Copyright (C) 2010 Martin Willi
* Copyright (C) 2010 revosec AG
*
* This program is free software; you can redistribute it and/or modify it
* under the terms of the GNU General Public License as published by the
* Free Software Foundation; either version 2 of the License, or (at your
* option) any later version. See <http://www.fsf.org/copyleft/gpl.txt>.
*
* This program is distributed in the hope that it will be useful, but
* WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
* or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
* for more details.
*/
/**
* @defgroup bio_writer bio_writer
* @{ @ingroup bio
*/
#ifndef BIO_WRITER_H_
#define BIO_WRITER_H_
typedef struct bio_writer_t bio_writer_t;
#include <library.h>
/**
* Buffered output generator.
*
* @note Integers are converted to network byte order before writing.
*/
struct bio_writer_t {
/**
* Append a 8-bit integer to the buffer.
*
* @param value value to append
*/
void (*write_uint8)(bio_writer_t *this, uint8_t value);
/**
* Append a 16-bit integer to the buffer.
*
* @param value value to append
*/
void (*write_uint16)(bio_writer_t *this, uint16_t value);
/**
* Append a 24-bit integer to the buffer.
*
* @param value value to append
*/
void (*write_uint24)(bio_writer_t *this, uint32_t value);
/**
* Append a 32-bit integer to the buffer.
*
* @param value value to append
*/
void (*write_uint32)(bio_writer_t *this, uint32_t value);
/**
* Append a 64-bit integer to the buffer.
*
* @param value value to append
*/
void (*write_uint64)(bio_writer_t *this, uint64_t value);
/**
* Append a chunk of data without a length header.
*
* @param value value to append
*/
void (*write_data)(bio_writer_t *this, chunk_t value);
/**
* Append a chunk of data with a 8-bit length header.
*
* @param value value to append
*/
void (*write_data8)(bio_writer_t *this, chunk_t value);
/**
* Append a chunk of data with a 16-bit length header.
*
* @param value value to append
*/
void (*write_data16)(bio_writer_t *this, chunk_t value);
/**
* Append a chunk of data with a 24-bit length header.
*
* @param value value to append
*/
void (*write_data24)(bio_writer_t *this, chunk_t value);
/**
* Append a chunk of data with a 32-bit length header.
*
* @param value value to append
*/
void (*write_data32)(bio_writer_t *this, chunk_t value);
/**
* Prepend a 8-bit length header to existing data.
*/
void (*wrap8)(bio_writer_t *this);
/**
* Prepend a 16-bit length header to existing data.
*/
void (*wrap16)(bio_writer_t *this);
/**
* Prepend a 24-bit length header to existing data.
*/
void (*wrap24)(bio_writer_t *this);
/**
* Prepend a 32-bit length header to existing data.
*/
void (*wrap32)(bio_writer_t *this);
/**
* Skips len bytes in the buffer, return chunk of skipped data.
*
* The returned chunk is not valid after calling any other writer function
* (except get_buf()), because a buffer reallocation might move the
* internal buffer to a different memory location!
*
* @param len number of bytes to skip
* @return chunk pointing to skipped bytes in the internal buffer
*/
chunk_t (*skip)(bio_writer_t *this, size_t len);
/**
* Get the encoded data buffer.
*
* @return chunk to internal buffer
*/
chunk_t (*get_buf)(bio_writer_t *this);
/**
* Return the encoded data buffer and detach it from the writer (resets
* the internal buffer).
*
* @return chunk to internal buffer (has to be freed)
*/
chunk_t (*extract_buf)(bio_writer_t *this);
/**
* Destroy a bio_writer_t.
*/
void (*destroy)(bio_writer_t *this);
};
/**
* Create a bio_writer instance.
*
* The size of the internal buffer is increased automatically by bufsize (or a
* default if not given) if the initial size does not suffice.
*
* @param bufsize initially allocated buffer size
*/
bio_writer_t *bio_writer_create(uint32_t bufsize);
#endif /** BIO_WRITER_H_ @}*/
|
