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 
35 #ifndef CONFIG_PING_SENDER_H_
36 #define CONFIG_PING_SENDER_H_
37 
38 /**
39  * @def OPENTHREAD_CONFIG_PING_SENDER_ENABLE
40  *
41  * Define to 1 to enable ping sender module.
42  *
43  * Ping sender module implements sending ICMPv6 Echo Request messages and processing ICMPv6 Echo Reply messages.
44  *
45  */
46 #ifndef OPENTHREAD_CONFIG_PING_SENDER_ENABLE
47 #define OPENTHREAD_CONFIG_PING_SENDER_ENABLE 0
48 #endif
49 
50 /**
51  * @def OPENTHREAD_CONFIG_PING_SENDER_DEFAULT_INTERVAL
52  *
53  * Specifies the default ping interval (time between sending echo requests) in milliseconds.
54  *
55  */
56 #ifndef OPENTHREAD_CONFIG_PING_SENDER_DEFAULT_INTERVAL
57 #define OPENTHREAD_CONFIG_PING_SENDER_DEFAULT_INTERVAL 1000
58 #endif
59 
60 /**
61  * @def OPENTHREAD_CONFIG_PING_SENDER_DEFAULT_DEADLINE
62  *
63  * Specifies the default ping timeout in milliseconds. The timeout is the max acceptable time gap between each ping
64  * request and its reply.
65  *
66  */
67 #ifndef OPENTHREAD_CONFIG_PING_SENDER_DEFAULT_TIMEOUT
68 #define OPENTHREAD_CONFIG_PING_SENDER_DEFAULT_TIMEOUT 3000
69 #endif
70 
71 /**
72  * @def OPENTHREAD_CONFIG_PING_SENDER_DEFAULT_SIZE
73  *
74  * Specifies the default ping data size in bytes. The data size specifies the Echo Request data payload which excludes
75  * the IPv6 and ICMPv6 headers.
76  *
77  */
78 #ifndef OPENTHREAD_CONFIG_PING_SENDER_DEFAULT_SIZE
79 #define OPENTHREAD_CONFIG_PING_SENDER_DEFAULT_SIZE 8
80 #endif
81 
82 /**
83  * @def OPENTHREAD_CONFIG_PING_SENDER_DEFAULT_COUNT
84  *
85  * Specifies the default ping count (number of ping messages to send).
86  *
87  */
88 #ifndef OPENTHREAD_CONFIG_PING_SENDER_DEFAULT_COUNT
89 #define OPENTHREAD_CONFIG_PING_SENDER_DEFAULT_COUNT 1
90 #endif
91 
92 #endif // CONFIG_PING_SENDER_H_
93