BadVPN – Blame information for rev 1

Subversion Repositories:
Rev:
Rev Author Line No. Line
1 office 1 /**
2 * @file SinglePacketSource.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  
30 #ifndef BADVPN_SINGLEPACKETSOURCE_H
31 #define BADVPN_SINGLEPACKETSOURCE_H
32  
33 #include <base/DebugObject.h>
34 #include <flow/PacketRecvInterface.h>
35  
36 /**
37 * An object which provides a single packet through {@link PacketRecvInterface}.
38 */
39 typedef struct {
40 uint8_t *packet;
41 int packet_len;
42 int sent;
43 PacketRecvInterface output;
44 DebugObject d_obj;
45 } SinglePacketSource;
46  
47 /**
48 * Initializes the object.
49 *
50 * @param o the object
51 * @param packet packet to provide to the output. Must stay available until the packet is provided.
52 * @param packet_len length of packet. Must be >=0.
53 * @param pg pending group we live in
54 */
55 void SinglePacketSource_Init (SinglePacketSource *o, uint8_t *packet, int packet_len, BPendingGroup *pg);
56  
57 /**
58 * Frees the object.
59 *
60 * @param o the object
61 */
62 void SinglePacketSource_Free (SinglePacketSource *o);
63  
64 /**
65 * Returns the output interface.
66 * The MTU of the interface will be packet_len.
67 *
68 * @param o the object
69 * @return output interface
70 */
71 PacketRecvInterface * SinglePacketSource_GetOutput (SinglePacketSource *o);
72  
73 #endif