BadVPN – Blame information for rev 1
?pathlinks?
| Rev | Author | Line No. | Line |
|---|---|---|---|
| 1 | office | 1 | /** |
| 2 | * @file PacketProtoDecoder.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 decodes a stream according to PacketProto. |
||
| 32 | */ |
||
| 33 | |||
| 34 | #ifndef BADVPN_FLOW_PACKETPROTODECODER_H |
||
| 35 | #define BADVPN_FLOW_PACKETPROTODECODER_H |
||
| 36 | |||
| 37 | #include <stdint.h> |
||
| 38 | |||
| 39 | #include <protocol/packetproto.h> |
||
| 40 | #include <misc/debug.h> |
||
| 41 | #include <base/DebugObject.h> |
||
| 42 | #include <flow/StreamRecvInterface.h> |
||
| 43 | #include <flow/PacketPassInterface.h> |
||
| 44 | |||
| 45 | /** |
||
| 46 | * Handler called when a protocol error occurs. |
||
| 47 | * When an error occurs, the decoder is reset to the initial state. |
||
| 48 | * |
||
| 49 | * @param user as in {@link PacketProtoDecoder_Init} |
||
| 50 | */ |
||
| 51 | typedef void (*PacketProtoDecoder_handler_error) (void *user); |
||
| 52 | |||
| 53 | typedef struct { |
||
| 54 | StreamRecvInterface *input; |
||
| 55 | PacketPassInterface *output; |
||
| 56 | void *user; |
||
| 57 | PacketProtoDecoder_handler_error handler_error; |
||
| 58 | int output_mtu; |
||
| 59 | int buf_size; |
||
| 60 | int buf_start; |
||
| 61 | int buf_used; |
||
| 62 | uint8_t *buf; |
||
| 63 | DebugObject d_obj; |
||
| 64 | } PacketProtoDecoder; |
||
| 65 | |||
| 66 | /** |
||
| 67 | * Initializes the object. |
||
| 68 | * |
||
| 69 | * @param enc the object |
||
| 70 | * @param input input interface. The decoder will accept packets with payload size up to its MTU |
||
| 71 | * (but the payload can never be more than PACKETPROTO_MAXPAYLOAD). |
||
| 72 | * @param output output interface |
||
| 73 | * @param pg pending group |
||
| 74 | * @param user argument to handlers |
||
| 75 | * @param handler_error error handler |
||
| 76 | * @return 1 on success, 0 on failure |
||
| 77 | */ |
||
| 78 | int PacketProtoDecoder_Init (PacketProtoDecoder *enc, StreamRecvInterface *input, PacketPassInterface *output, BPendingGroup *pg, void *user, PacketProtoDecoder_handler_error handler_error) WARN_UNUSED; |
||
| 79 | |||
| 80 | /** |
||
| 81 | * Frees the object. |
||
| 82 | * |
||
| 83 | * @param enc the object |
||
| 84 | */ |
||
| 85 | void PacketProtoDecoder_Free (PacketProtoDecoder *enc); |
||
| 86 | |||
| 87 | /** |
||
| 88 | * Clears the internal buffer. |
||
| 89 | * The next data received from the input will be treated as a new |
||
| 90 | * PacketProto stream. |
||
| 91 | * |
||
| 92 | * @param enc the object |
||
| 93 | */ |
||
| 94 | void PacketProtoDecoder_Reset (PacketProtoDecoder *enc); |
||
| 95 | |||
| 96 | #endif |