BadVPN – Blame information for rev 1
?pathlinks?
| Rev | Author | Line No. | Line |
|---|---|---|---|
| 1 | office | 1 | /** |
| 2 | * @file KeepaliveIO.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} layer for sending keep-alive packets. |
||
| 32 | */ |
||
| 33 | |||
| 34 | #ifndef BADVPN_KEEPALIVEIO |
||
| 35 | #define BADVPN_KEEPALIVEIO |
||
| 36 | |||
| 37 | #include <misc/debug.h> |
||
| 38 | #include <base/DebugObject.h> |
||
| 39 | #include <system/BReactor.h> |
||
| 40 | #include <flow/PacketPassInterface.h> |
||
| 41 | #include <flow/PacketRecvInterface.h> |
||
| 42 | #include <flow/PacketPassPriorityQueue.h> |
||
| 43 | #include <flow/SinglePacketBuffer.h> |
||
| 44 | #include <flow/PacketRecvBlocker.h> |
||
| 45 | #include <flowextra/PacketPassInactivityMonitor.h> |
||
| 46 | |||
| 47 | /** |
||
| 48 | * A {@link PacketPassInterface} layer for sending keep-alive packets. |
||
| 49 | */ |
||
| 50 | typedef struct { |
||
| 51 | BReactor *reactor; |
||
| 52 | PacketPassInactivityMonitor kasender; |
||
| 53 | PacketPassPriorityQueue queue; |
||
| 54 | PacketPassPriorityQueueFlow user_qflow; |
||
| 55 | PacketPassPriorityQueueFlow ka_qflow; |
||
| 56 | SinglePacketBuffer ka_buffer; |
||
| 57 | PacketRecvBlocker ka_blocker; |
||
| 58 | DebugObject d_obj; |
||
| 59 | } KeepaliveIO; |
||
| 60 | |||
| 61 | /** |
||
| 62 | * Initializes the object. |
||
| 63 | * |
||
| 64 | * @param o the object |
||
| 65 | * @param reactor reactor we live in |
||
| 66 | * @param output output interface |
||
| 67 | * @param keepalive_input keepalive input interface. Its MTU must be <= MTU of output. |
||
| 68 | * @param keepalive_interval_ms keepalive interval in milliseconds. Must be >0. |
||
| 69 | * @return 1 on success, 0 on failure |
||
| 70 | */ |
||
| 71 | int KeepaliveIO_Init (KeepaliveIO *o, BReactor *reactor, PacketPassInterface *output, PacketRecvInterface *keepalive_input, btime_t keepalive_interval_ms) WARN_UNUSED; |
||
| 72 | |||
| 73 | /** |
||
| 74 | * Frees the object. |
||
| 75 | * |
||
| 76 | * @param o the object |
||
| 77 | */ |
||
| 78 | void KeepaliveIO_Free (KeepaliveIO *o); |
||
| 79 | |||
| 80 | /** |
||
| 81 | * Returns the input interface. |
||
| 82 | * |
||
| 83 | * @param o the object |
||
| 84 | * @return input interface |
||
| 85 | */ |
||
| 86 | PacketPassInterface * KeepaliveIO_GetInput (KeepaliveIO *o); |
||
| 87 | |||
| 88 | #endif |