BadVPN – Blame information for rev 1

Subversion Repositories:
Rev:
Rev Author Line No. Line
1 office 1 /**
2 * @file PacketBuffer.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 * @section DESCRIPTION
30 *
31 * Packet buffer with {@link PacketRecvInterface} input and {@link PacketPassInterface} output.
32 */
33  
34 #ifndef BADVPN_FLOW_PACKETBUFFER_H
35 #define BADVPN_FLOW_PACKETBUFFER_H
36  
37 #include <stdint.h>
38  
39 #include <misc/debug.h>
40 #include <base/DebugObject.h>
41 #include <structure/ChunkBuffer2.h>
42 #include <flow/PacketRecvInterface.h>
43 #include <flow/PacketPassInterface.h>
44  
45 /**
46 * Packet buffer with {@link PacketRecvInterface} input and {@link PacketPassInterface} output.
47 */
48 typedef struct {
49 DebugObject d_obj;
50 PacketRecvInterface *input;
51 int input_mtu;
52 PacketPassInterface *output;
53 struct ChunkBuffer2_block *buf_data;
54 ChunkBuffer2 buf;
55 } PacketBuffer;
56  
57 /**
58 * Initializes the buffer.
59 * Output MTU must be >= input MTU.
60 *
61 * @param buf the object
62 * @param input input interface
63 * @param output output interface
64 * @param num_packets minimum number of packets the buffer must hold. Must be >0.
65 * @param pg pending group
66 * @return 1 on success, 0 on failure
67 */
68 int PacketBuffer_Init (PacketBuffer *buf, PacketRecvInterface *input, PacketPassInterface *output, int num_packets, BPendingGroup *pg) WARN_UNUSED;
69  
70 /**
71 * Frees the buffer.
72 *
73 * @param buf the object
74 */
75 void PacketBuffer_Free (PacketBuffer *buf);
76  
77 #endif