BadVPN – Blame information for rev 1

Subversion Repositories:
Rev:
Rev Author Line No. Line
1 office 1 /**
2 * @file PacketRecvBlocker.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 * {@link PacketRecvInterface} layer which blocks all output recv calls and only
32 * passes a single blocked call on to input when the user wants so.
33 */
34  
35 #ifndef BADVPN_FLOW_PACKETRECVBLOCKER_H
36 #define BADVPN_FLOW_PACKETRECVBLOCKER_H
37  
38 #include <stdint.h>
39  
40 #include <base/DebugObject.h>
41 #include <flow/PacketRecvInterface.h>
42  
43 /**
44 * {@link PacketRecvInterface} layer which blocks all output recv calls and only
45 * passes a single blocked call on to input when the user wants so.
46 */
47 typedef struct {
48 PacketRecvInterface output;
49 int out_have;
50 uint8_t *out;
51 int out_input_blocking;
52 PacketRecvInterface *input;
53 DebugObject d_obj;
54 } PacketRecvBlocker;
55  
56 /**
57 * Initializes the object.
58 *
59 * @param o the object
60 * @param input input interface
61 */
62 void PacketRecvBlocker_Init (PacketRecvBlocker *o, PacketRecvInterface *input, BPendingGroup *pg);
63  
64 /**
65 * Frees the object.
66 *
67 * @param o the object
68 */
69 void PacketRecvBlocker_Free (PacketRecvBlocker *o);
70  
71 /**
72 * Returns the output interface.
73 * The MTU of the output interface will be the same as of the input interface.
74 *
75 * @param o the object
76 * @return output interface
77 */
78 PacketRecvInterface * PacketRecvBlocker_GetOutput (PacketRecvBlocker *o);
79  
80 /**
81 * Passes a blocked output recv call to input if there is one and it has not
82 * been passed yet. Otherwise it does nothing.
83 * Must not be called from input Recv calls.
84 * This function may invoke I/O.
85 *
86 * @param o the object
87 */
88 void PacketRecvBlocker_AllowBlockedPacket (PacketRecvBlocker *o);
89  
90 #endif