BadVPN – Blame information for rev 1

Subversion Repositories:
Rev:
Rev Author Line No. Line
1 office 1 /**
2 * @file PacketStreamSender.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 forwards packets obtained with {@link PacketPassInterface}
32 * as a stream with {@link StreamPassInterface} (i.e. it concatenates them).
33 */
34  
35 #ifndef BADVPN_FLOW_PACKETSTREAMSENDER_H
36 #define BADVPN_FLOW_PACKETSTREAMSENDER_H
37  
38 #include <stdint.h>
39  
40 #include <base/DebugObject.h>
41 #include <flow/PacketPassInterface.h>
42 #include <flow/StreamPassInterface.h>
43  
44 /**
45 * Object which forwards packets obtained with {@link PacketPassInterface}
46 * as a stream with {@link StreamPassInterface} (i.e. it concatenates them).
47 */
48 typedef struct {
49 DebugObject d_obj;
50 PacketPassInterface input;
51 StreamPassInterface *output;
52 int in_len;
53 uint8_t *in;
54 int in_used;
55 } PacketStreamSender;
56  
57 /**
58 * Initializes the object.
59 *
60 * @param s the object
61 * @param output output interface
62 * @param mtu input MTU. Must be >=0.
63 * @param pg pending group
64 */
65 void PacketStreamSender_Init (PacketStreamSender *s, StreamPassInterface *output, int mtu, BPendingGroup *pg);
66  
67 /**
68 * Frees the object.
69 *
70 * @param s the object
71 */
72 void PacketStreamSender_Free (PacketStreamSender *s);
73  
74 /**
75 * Returns the input interface.
76 * Its MTU will be as in {@link PacketStreamSender_Init}.
77 *
78 * @param s the object
79 * @return input interface
80 */
81 PacketPassInterface * PacketStreamSender_GetInput (PacketStreamSender *s);
82  
83 #endif