BadVPN – Blame information for rev 1

Subversion Repositories:
Rev:
Rev Author Line No. Line
1 office 1 /**
2 * @file PacketCopier.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 * Object which copies packets.
32 */
33  
34 #ifndef BADVPN_FLOW_PACKETCOPIER_H
35 #define BADVPN_FLOW_PACKETCOPIER_H
36  
37 #include <stdint.h>
38  
39 #include <flow/PacketPassInterface.h>
40 #include <flow/PacketRecvInterface.h>
41  
42 /**
43 * Object which copies packets.
44 * Input is via {@link PacketPassInterface}.
45 * Output is via {@link PacketRecvInterface}.
46 */
47 typedef struct {
48 DebugObject d_obj;
49 PacketPassInterface input;
50 PacketRecvInterface output;
51 int in_len;
52 uint8_t *in;
53 int out_have;
54 uint8_t *out;
55 } PacketCopier;
56  
57 /**
58 * Initializes the object.
59 *
60 * @param o the object
61 * @param mtu maximum packet size. Must be >=0.
62 * @param pg pending group
63 */
64 void PacketCopier_Init (PacketCopier *o, int mtu, BPendingGroup *pg);
65  
66 /**
67 * Frees the object.
68 *
69 * @param o the object
70 */
71 void PacketCopier_Free (PacketCopier *o);
72  
73 /**
74 * Returns the input interface.
75 * The MTU of the interface will as in {@link PacketCopier_Init}.
76 * The interface will support cancel functionality.
77 *
78 * @return input interface
79 */
80 PacketPassInterface * PacketCopier_GetInput (PacketCopier *o);
81  
82 /**
83 * Returns the output interface.
84 * The MTU of the interface will be as in {@link PacketCopier_Init}.
85 *
86 * @return output interface
87 */
88 PacketRecvInterface * PacketCopier_GetOutput (PacketCopier *o);
89  
90 #endif