1 /* 2 * Copyright (c) 2021, The OpenThread Authors. 3 * All rights reserved. 4 * 5 * Redistribution and use in source and binary forms, with or without 6 * modification, are permitted provided that the following conditions are met: 7 * 1. Redistributions of source code must retain the above copyright 8 * notice, this list of conditions and the following disclaimer. 9 * 2. Redistributions in binary form must reproduce the above copyright 10 * notice, this list of conditions and the following disclaimer in the 11 * documentation and/or other materials provided with the distribution. 12 * 3. Neither the name of the copyright holder nor the 13 * names of its contributors may be used to endorse or promote products 14 * derived from this software without specific prior written permission. 15 * 16 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" 17 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 18 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 19 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE 20 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR 21 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF 22 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS 23 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN 24 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 25 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 26 * POSSIBILITY OF SUCH DAMAGE. 27 */ 28 29 /** 30 * @file 31 * This file includes compile-time configurations for ping sender module. 32 */ 33 34 #ifndef CONFIG_PING_SENDER_H_ 35 #define CONFIG_PING_SENDER_H_ 36 37 /** 38 * @addtogroup config-ping-sender 39 * 40 * @brief 41 * This module includes configuration variables for Ping Sender. 42 * 43 * @{ 44 */ 45 46 /** 47 * @def OPENTHREAD_CONFIG_PING_SENDER_ENABLE 48 * 49 * Define to 1 to enable ping sender module. 50 * 51 * Ping sender module implements sending ICMPv6 Echo Request messages and processing ICMPv6 Echo Reply messages. 52 */ 53 #ifndef OPENTHREAD_CONFIG_PING_SENDER_ENABLE 54 #define OPENTHREAD_CONFIG_PING_SENDER_ENABLE 0 55 #endif 56 57 /** 58 * @def OPENTHREAD_CONFIG_PING_SENDER_DEFAULT_INTERVAL 59 * 60 * Specifies the default ping interval (time between sending echo requests) in milliseconds. 61 */ 62 #ifndef OPENTHREAD_CONFIG_PING_SENDER_DEFAULT_INTERVAL 63 #define OPENTHREAD_CONFIG_PING_SENDER_DEFAULT_INTERVAL 1000 64 #endif 65 66 /** 67 * @def OPENTHREAD_CONFIG_PING_SENDER_DEFAULT_DEADLINE 68 * 69 * Specifies the default ping timeout in milliseconds. The timeout is the max acceptable time gap between each ping 70 * request and its reply. 71 */ 72 #ifndef OPENTHREAD_CONFIG_PING_SENDER_DEFAULT_TIMEOUT 73 #define OPENTHREAD_CONFIG_PING_SENDER_DEFAULT_TIMEOUT 3000 74 #endif 75 76 /** 77 * @def OPENTHREAD_CONFIG_PING_SENDER_DEFAULT_SIZE 78 * 79 * Specifies the default ping data size in bytes. The data size specifies the Echo Request data payload which excludes 80 * the IPv6 and ICMPv6 headers. 81 */ 82 #ifndef OPENTHREAD_CONFIG_PING_SENDER_DEFAULT_SIZE 83 #define OPENTHREAD_CONFIG_PING_SENDER_DEFAULT_SIZE 8 84 #endif 85 86 /** 87 * @def OPENTHREAD_CONFIG_PING_SENDER_DEFAULT_COUNT 88 * 89 * Specifies the default ping count (number of ping messages to send). 90 */ 91 #ifndef OPENTHREAD_CONFIG_PING_SENDER_DEFAULT_COUNT 92 #define OPENTHREAD_CONFIG_PING_SENDER_DEFAULT_COUNT 1 93 #endif 94 95 /** 96 * @} 97 */ 98 99 #endif // CONFIG_PING_SENDER_H_ 100
