BadVPN – Blame information for rev 1
?pathlinks?
Rev | Author | Line No. | Line |
---|---|---|---|
1 | office | 1 | /** |
2 | * @file packetproto.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 | * Definitions for PacketProto, a protocol that allows sending of packets |
||
32 | * over a reliable stream connection. |
||
33 | * |
||
34 | * All multi-byte integers in structs are little-endian, unless stated otherwise. |
||
35 | * |
||
36 | * Packets are encoded into a stream by representing each packet with: |
||
37 | * - a 16-bit little-endian unsigned integer representing the length |
||
38 | * of the payload |
||
39 | * - that many bytes of payload |
||
40 | */ |
||
41 | |||
42 | #ifndef BADVPN_PROTOCOL_PACKETPROTO_H |
||
43 | #define BADVPN_PROTOCOL_PACKETPROTO_H |
||
44 | |||
45 | #include <stdint.h> |
||
46 | #include <limits.h> |
||
47 | |||
48 | #include <misc/packed.h> |
||
49 | |||
50 | /** |
||
51 | * PacketProto packet header. |
||
52 | * Wraps a single uint16_t in a packed struct for easy access. |
||
53 | */ |
||
54 | B_START_PACKED |
||
55 | struct packetproto_header |
||
56 | { |
||
57 | /** |
||
58 | * Length of the packet payload that follows. |
||
59 | */ |
||
60 | uint16_t len; |
||
61 | } B_PACKED; |
||
62 | B_END_PACKED |
||
63 | |||
64 | #define PACKETPROTO_ENCLEN(_len) (sizeof(struct packetproto_header) + (_len)) |
||
65 | |||
66 | #define PACKETPROTO_MAXPAYLOAD UINT16_MAX |
||
67 | |||
68 | #endif |