BadVPN – Blame information for rev 1

Subversion Repositories:
Rev:
Rev Author Line No. Line
1 office 1 /**
2 * @file StreamBuffer.h
3 * @author Ambroz Bizjak <ambrop7@gmail.com>
4 *
5 * @section LICENSE
6 *
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions are met:
9 * 1. Redistributions of source code must retain the above copyright
10 * notice, this list of conditions and the following disclaimer.
11 * 2. Redistributions in binary form must reproduce the above copyright
12 * notice, this list of conditions and the following disclaimer in the
13 * documentation and/or other materials provided with the distribution.
14 * 3. Neither the name of the author nor the
15 * names of its contributors may be used to endorse or promote products
16 * derived from this software without specific prior written permission.
17 *
18 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
19 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
20 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
21 * DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY
22 * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
23 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
24 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
25 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
26 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
27 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
28 */
29  
30 #ifndef BADVPN_STREAMBUFFER_H
31 #define BADVPN_STREAMBUFFER_H
32  
33 #include <misc/debug.h>
34 #include <base/DebugObject.h>
35 #include <flow/StreamRecvInterface.h>
36 #include <flow/StreamPassInterface.h>
37  
38 /**
39 * Buffer object which reads data from a \link StreamRecvInterface and writes
40 * it to a \link StreamPassInterface.
41 */
42 typedef struct {
43 int buf_size;
44 StreamRecvInterface *input;
45 StreamPassInterface *output;
46 uint8_t *buf;
47 int buf_start;
48 int buf_used;
49 DebugObject d_obj;
50 } StreamBuffer;
51  
52 /**
53 * Initializes the buffer object.
54 *
55 * @param o object to initialize
56 * @param buf_size size of the buffer. Must be >0.
57 * @param input input interface
58 * @param outout output interface
59 * @return 1 on success, 0 on failure
60 */
61 int StreamBuffer_Init (StreamBuffer *o, int buf_size, StreamRecvInterface *input, StreamPassInterface *output) WARN_UNUSED;
62  
63 /**
64 * Frees the buffer object.
65 *
66 * @param o object to free
67 */
68 void StreamBuffer_Free (StreamBuffer *o);
69  
70 #endif