BadVPN – Blame information for rev 1

Subversion Repositories:
Rev:
Rev Author Line No. Line
1 office 1 /**
2 * @file PacketProtoEncoder.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 encodes packets according to PacketProto.
32 */
33  
34 #ifndef BADVPN_FLOW_PACKETPROTOENCODER_H
35 #define BADVPN_FLOW_PACKETPROTOENCODER_H
36  
37 #include <stdint.h>
38  
39 #include <base/DebugObject.h>
40 #include <flow/PacketRecvInterface.h>
41  
42 /**
43 * Object which encodes packets according to PacketProto.
44 *
45 * Input is with {@link PacketRecvInterface}.
46 * Output is with {@link PacketRecvInterface}.
47 */
48 typedef struct {
49 PacketRecvInterface *input;
50 PacketRecvInterface output;
51 uint8_t *output_packet;
52 DebugObject d_obj;
53 } PacketProtoEncoder;
54  
55 /**
56 * Initializes the object.
57 *
58 * @param enc the object
59 * @param input input interface. Its MTU must be <=PACKETPROTO_MAXPAYLOAD.
60 * @param pg pending group
61 */
62 void PacketProtoEncoder_Init (PacketProtoEncoder *enc, PacketRecvInterface *input, BPendingGroup *pg);
63  
64 /**
65 * Frees the object.
66 *
67 * @param enc the object
68 */
69 void PacketProtoEncoder_Free (PacketProtoEncoder *enc);
70  
71 /**
72 * Returns the output interface.
73 * The MTU of the output interface is PACKETPROTO_ENCLEN(MTU of input interface).
74 *
75 * @param enc the object
76 * @return output interface
77 */
78 PacketRecvInterface * PacketProtoEncoder_GetOutput (PacketProtoEncoder *enc);
79  
80 #endif