BadVPN – Blame information for rev 1

Subversion Repositories:
Rev:
Rev Author Line No. Line
1 office 1 /**
2 * @file DataProtoKeepaliveSource.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 PacketRecvInterface} source which provides DataProto keepalive packets.
32 */
33  
34 #ifndef BADVPN_DATAPROTOKEEPALIVESOURCE_H
35 #define BADVPN_DATAPROTOKEEPALIVESOURCE_H
36  
37 #include <base/DebugObject.h>
38 #include <flow/PacketRecvInterface.h>
39  
40 /**
41 * A {@link PacketRecvInterface} source which provides DataProto keepalive packets.
42 * These packets have no payload, no destination peers and flags zero.
43 */
44 typedef struct {
45 DebugObject d_obj;
46 PacketRecvInterface output;
47 } DataProtoKeepaliveSource;
48  
49 /**
50 * Initializes the object.
51 *
52 * @param o the object
53 * @param pg pending group
54 */
55 void DataProtoKeepaliveSource_Init (DataProtoKeepaliveSource *o, BPendingGroup *pg);
56  
57 /**
58 * Frees the object.
59 *
60 * @param o the object
61 */
62 void DataProtoKeepaliveSource_Free (DataProtoKeepaliveSource *o);
63  
64 /**
65 * Returns the output interface.
66 * The MTU of the output interface will be sizeof(struct dataproto_header).
67 *
68 * @param o the object
69 * @return output interface
70 */
71 PacketRecvInterface * DataProtoKeepaliveSource_GetOutput (DataProtoKeepaliveSource *o);
72  
73 #endif