BadVPN – Blame information for rev 1

Subversion Repositories:
Rev:
Rev Author Line No. Line
1 office 1 /**
2 * @file PacketProtoFlow.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 * Buffer which encodes packets with PacketProto, with {@link BufferWriter}
32 * input and {@link PacketPassInterface} output.
33 */
34  
35 #ifndef BADVPN_FLOW_PACKETPROTOFLOW_H
36 #define BADVPN_FLOW_PACKETPROTOFLOW_H
37  
38 #include <misc/debug.h>
39  
40 #include <base/DebugObject.h>
41 #include <flow/BufferWriter.h>
42 #include <flow/PacketProtoEncoder.h>
43 #include <flow/PacketBuffer.h>
44  
45 /**
46 * Buffer which encodes packets with PacketProto, with {@link BufferWriter}
47 * input and {@link PacketPassInterface} output.
48 */
49 typedef struct {
50 BufferWriter ainput;
51 PacketProtoEncoder encoder;
52 PacketBuffer buffer;
53 DebugObject d_obj;
54 } PacketProtoFlow;
55  
56 /**
57 * Initializes the object.
58 *
59 * @param o the object
60 * @param input_mtu maximum input packet size. Must be >=0 and <=PACKETPROTO_MAXPAYLOAD.
61 * @param num_packets minimum number of packets the buffer should hold. Must be >0.
62 * @param output output interface. Its MTU must be >=PACKETPROTO_ENCLEN(input_mtu).
63 * @param pg pending group
64 * @return 1 on success, 0 on failure
65 */
66 int PacketProtoFlow_Init (PacketProtoFlow *o, int input_mtu, int num_packets, PacketPassInterface *output, BPendingGroup *pg) WARN_UNUSED;
67  
68 /**
69 * Frees the object.
70 *
71 * @param o the object
72 */
73 void PacketProtoFlow_Free (PacketProtoFlow *o);
74  
75 /**
76 * Returns the input interface.
77 *
78 * @param o the object
79 * @return input interface
80 */
81 BufferWriter * PacketProtoFlow_GetInput (PacketProtoFlow *o);
82  
83 #endif