BadVPN – Blame information for rev 1
?pathlinks?
| Rev | Author | Line No. | Line |
|---|---|---|---|
| 1 | office | 1 | /** |
| 2 | * @file SinglePacketSender.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 PacketPassInterface} source which sends a single packet. |
||
| 32 | */ |
||
| 33 | |||
| 34 | #ifndef BADVPN_FLOW_SINGLEPACKETSENDER_H |
||
| 35 | #define BADVPN_FLOW_SINGLEPACKETSENDER_H |
||
| 36 | |||
| 37 | #include <stdint.h> |
||
| 38 | |||
| 39 | #include <misc/debugerror.h> |
||
| 40 | #include <base/DebugObject.h> |
||
| 41 | #include <flow/PacketPassInterface.h> |
||
| 42 | |||
| 43 | /** |
||
| 44 | * Handler function called after the packet is sent. |
||
| 45 | * The object must be freed from within this handler. |
||
| 46 | * |
||
| 47 | * @param user as in {@link SinglePacketSender_Init}. |
||
| 48 | */ |
||
| 49 | typedef void (*SinglePacketSender_handler) (void *user); |
||
| 50 | |||
| 51 | /** |
||
| 52 | * A {@link PacketPassInterface} source which sends a single packet. |
||
| 53 | */ |
||
| 54 | typedef struct { |
||
| 55 | PacketPassInterface *output; |
||
| 56 | SinglePacketSender_handler handler; |
||
| 57 | void *user; |
||
| 58 | DebugObject d_obj; |
||
| 59 | DebugError d_err; |
||
| 60 | } SinglePacketSender; |
||
| 61 | |||
| 62 | /** |
||
| 63 | * Initializes the object. |
||
| 64 | * |
||
| 65 | * @param o the object |
||
| 66 | * @param packet packet to be sent. Must be available as long as the object exists. |
||
| 67 | * @param packet_len length of the packet. Must be >=0 and <=(MTU of output). |
||
| 68 | * @param output output interface |
||
| 69 | * @param handler handler to call when the packet is sent |
||
| 70 | * @param user value to pass to handler |
||
| 71 | * @param pg pending group |
||
| 72 | */ |
||
| 73 | void SinglePacketSender_Init (SinglePacketSender *o, uint8_t *packet, int packet_len, PacketPassInterface *output, SinglePacketSender_handler handler, void *user, BPendingGroup *pg); |
||
| 74 | |||
| 75 | /** |
||
| 76 | * Frees the object. |
||
| 77 | * |
||
| 78 | * @param o the object |
||
| 79 | */ |
||
| 80 | void SinglePacketSender_Free (SinglePacketSender *o); |
||
| 81 | |||
| 82 | #endif |