BadVPN – Blame information for rev 1

Subversion Repositories:
Rev:
Rev Author Line No. Line
1 office 1 /**
2 * @file PacketPassNotifier.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 PacketPassInterface} layer which calles a handler function before
32 * passing a packet from input to output.
33 */
34  
35 #ifndef BADVPN_FLOW_PACKETPASSNOTIFIER_H
36 #define BADVPN_FLOW_PACKETPASSNOTIFIER_H
37  
38 #include <stdint.h>
39  
40 #include <base/DebugObject.h>
41 #include <flow/PacketPassInterface.h>
42  
43 /**
44 * Handler function called when input calls Send, but before the call is passed on to output.
45 *
46 * @param user value specified in {@link PacketPassNotifier_SetHandler}
47 * @param data packet provided by input
48 * @param data_len size of the packet
49 */
50 typedef void (*PacketPassNotifier_handler_notify) (void *user, uint8_t *data, int data_len);
51  
52 /**
53 * A {@link PacketPassInterface} layer which calles a handler function before
54 * passing a packet from input to output.
55 */
56 typedef struct {
57 PacketPassInterface input;
58 PacketPassInterface *output;
59 PacketPassNotifier_handler_notify handler;
60 void *handler_user;
61 DebugObject d_obj;
62 } PacketPassNotifier;
63  
64 /**
65 * Initializes the object.
66 *
67 * @param o the object
68 * @param output output interface
69 * @param pg pending group
70 */
71 void PacketPassNotifier_Init (PacketPassNotifier *o, PacketPassInterface *output, BPendingGroup *pg);
72  
73 /**
74 * Frees the object.
75 *
76 * @param o the object
77 */
78 void PacketPassNotifier_Free (PacketPassNotifier *o);
79  
80 /**
81 * Returns the input interface.
82 * The MTU of the interface will be the same as of the output interface.
83 * The interface supports cancel functionality if the output interface supports it.
84 *
85 * @param o the object
86 * @return input interface
87 */
88 PacketPassInterface * PacketPassNotifier_GetInput (PacketPassNotifier *o);
89  
90 /**
91 * Configures a handler function to call before passing input packets to output.
92 *
93 * @param o the object
94 * @param handler handler function, or NULL to disable.
95 * @param user value to pass to handler function. Ignored if handler is NULL.
96 */
97 void PacketPassNotifier_SetHandler (PacketPassNotifier *o, PacketPassNotifier_handler_notify handler, void *user);
98  
99 #endif