BadVPN – Blame information for rev 1
?pathlinks?
Rev | Author | Line No. | Line |
---|---|---|---|
1 | office | 1 | /** |
2 | * @file PacketRecvConnector.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 | * A {@link PacketRecvInterface} layer which allows the input to be |
||
32 | * connected and disconnected on the fly. |
||
33 | */ |
||
34 | |||
35 | #ifndef BADVPN_FLOW_PACKETRECVCONNECTOR_H |
||
36 | #define BADVPN_FLOW_PACKETRECVCONNECTOR_H |
||
37 | |||
38 | #include <stdint.h> |
||
39 | |||
40 | #include <base/DebugObject.h> |
||
41 | #include <flow/PacketRecvInterface.h> |
||
42 | |||
43 | /** |
||
44 | * A {@link PacketRecvInterface} layer which allows the input to be |
||
45 | * connected and disconnected on the fly. |
||
46 | */ |
||
47 | typedef struct { |
||
48 | PacketRecvInterface output; |
||
49 | int output_mtu; |
||
50 | int out_have; |
||
51 | uint8_t *out; |
||
52 | PacketRecvInterface *input; |
||
53 | DebugObject d_obj; |
||
54 | } PacketRecvConnector; |
||
55 | |||
56 | /** |
||
57 | * Initializes the object. |
||
58 | * The object is initialized in not connected state. |
||
59 | * |
||
60 | * @param o the object |
||
61 | * @param mtu maximum output packet size. Must be >=0. |
||
62 | * @param pg pending group |
||
63 | */ |
||
64 | void PacketRecvConnector_Init (PacketRecvConnector *o, int mtu, BPendingGroup *pg); |
||
65 | |||
66 | /** |
||
67 | * Frees the object. |
||
68 | * |
||
69 | * @param o the object |
||
70 | */ |
||
71 | void PacketRecvConnector_Free (PacketRecvConnector *o); |
||
72 | |||
73 | /** |
||
74 | * Returns the output interface. |
||
75 | * The MTU of the interface will be as in {@link PacketRecvConnector_Init}. |
||
76 | * |
||
77 | * @param o the object |
||
78 | * @return output interface |
||
79 | */ |
||
80 | PacketRecvInterface * PacketRecvConnector_GetOutput (PacketRecvConnector *o); |
||
81 | |||
82 | /** |
||
83 | * Connects input. |
||
84 | * The object must be in not connected state. |
||
85 | * The object enters connected state. |
||
86 | * |
||
87 | * @param o the object |
||
88 | * @param output input to connect. Its MTU must be <= MTU specified in |
||
89 | * {@link PacketRecvConnector_Init}. |
||
90 | */ |
||
91 | void PacketRecvConnector_ConnectInput (PacketRecvConnector *o, PacketRecvInterface *input); |
||
92 | |||
93 | /** |
||
94 | * Disconnects input. |
||
95 | * The object must be in connected state. |
||
96 | * The object enters not connected state. |
||
97 | * |
||
98 | * @param o the object |
||
99 | */ |
||
100 | void PacketRecvConnector_DisconnectInput (PacketRecvConnector *o); |
||
101 | |||
102 | #endif |