BadVPN – Blame information for rev 1

Subversion Repositories:
Rev:
Rev Author Line No. Line
1 office 1 /**
2 * @file SCOutmsgEncoder.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_SCOUTMSGENCODER_H
31 #define BADVPN_SCOUTMSGENCODER_H
32  
33 #include <protocol/scproto.h>
34 #include <base/DebugObject.h>
35 #include <flow/PacketRecvInterface.h>
36  
37 #define SCOUTMSG_OVERHEAD (sizeof(struct sc_header) + sizeof(struct sc_client_outmsg))
38  
39 /**
40 * A {@link PacketRecvInterface} layer which encodes SCProto outgoing messages.
41 */
42 typedef struct {
43 peerid_t peer_id;
44 PacketRecvInterface *input;
45 PacketRecvInterface output;
46 uint8_t *output_packet;
47 DebugObject d_obj;
48 } SCOutmsgEncoder;
49  
50 /**
51 * Initializes the object.
52 *
53 * @param o the object
54 * @param peer_id destination peer for messages
55 * @param input input interface. Its MTU muse be <= (INT_MAX - SCOUTMSG_OVERHEAD).
56 * @param pg pending group we live in
57 */
58 void SCOutmsgEncoder_Init (SCOutmsgEncoder *o, peerid_t peer_id, PacketRecvInterface *input, BPendingGroup *pg);
59  
60 /**
61 * Frees the object.
62 *
63 * @param o the object
64 */
65 void SCOutmsgEncoder_Free (SCOutmsgEncoder *o);
66  
67 /**
68 * Returns the output interface.
69 * The MTU of the interface will be (SCOUTMSG_OVERHEAD + input MTU).
70 *
71 * @param o the object
72 * @return output interface
73 */
74 PacketRecvInterface * SCOutmsgEncoder_GetOutput (SCOutmsgEncoder *o);
75  
76 #endif