1 /* 2 * Copyright (c) 2019, 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 the Announce Sender. 32 */ 33 34 #ifndef CONFIG_ANNOUNCE_SENDER_H_ 35 #define CONFIG_ANNOUNCE_SENDER_H_ 36 37 /** 38 * @addtogroup config-announce-sender 39 * 40 * @brief 41 * This module includes configuration variables for the Announce Sender. 42 * 43 * @{ 44 */ 45 46 /** 47 * @def OPENTHREAD_CONFIG_ANNOUNCE_SENDER_ENABLE 48 * 49 * Define as 1 to enable `AnnounceSender` which will periodically send MLE Announce message on all channels. 50 * 51 * The list of channels is determined from the Operational Dataset's ChannelMask. 52 */ 53 #ifndef OPENTHREAD_CONFIG_ANNOUNCE_SENDER_ENABLE 54 #define OPENTHREAD_CONFIG_ANNOUNCE_SENDER_ENABLE 1 55 #endif 56 57 /** 58 * @def OPENTHREAD_CONFIG_ANNOUNCE_SENDER_INTERVAL 59 * 60 * Specifies the time interval (in milliseconds) between `AnnounceSender` transmit cycles. 61 * 62 * In a cycle, the `AnnounceSender` sends MLE Announcement on all channels in Active Operational Dataset's ChannelMask. 63 * The transmissions on different channels happen uniformly over the given interval (i.e., if there are 16 channels, 64 * there will be 16 MLE Announcement messages each on one channel with `interval / 16` between two consecutive MLE 65 * Announcement transmissions). 66 * 67 * Applicable only if `AnnounceSender` feature is enabled (see `OPENTHREAD_CONFIG_ANNOUNCE_SENDER_ENABLE`). 68 */ 69 #ifndef OPENTHREAD_CONFIG_ANNOUNCE_SENDER_INTERVAL 70 #define OPENTHREAD_CONFIG_ANNOUNCE_SENDER_INTERVAL 688000 // 688 seconds = 11 min and 28 sec. 71 #endif 72 73 /** 74 * @def OPENTHREAD_CONFIG_ANNOUNCE_SENDER_REDUNDANCY_CONSTANT 75 * 76 * Specifies the number of MLE Announcement messages that the device must receive within a cycle interval to skip 77 * sending the Announcement itself. 78 * 79 * This is used as the trickle timer redundancy constant in `AnnounceSender`. 80 * 81 * Applicable only if `AnnounceSender` feature is enabled (see `OPENTHREAD_CONFIG_ANNOUNCE_SENDER_ENABLE`). 82 */ 83 #ifndef OPENTHREAD_CONFIG_ANNOUNCE_SENDER_REDUNDANCY_CONSTANT 84 #define OPENTHREAD_CONFIG_ANNOUNCE_SENDER_REDUNDANCY_CONSTANT 8 85 #endif 86 87 /** 88 * @def OPENTHREAD_CONFIG_ANNOUNCE_SENDER_JITTER_INTERVAL 89 * 90 * Specifies the jitter interval (in milliseconds) used by `AnnounceSender`. A random jitter interval is applied to 91 * the period between any two successive MLE Announcement transmissions (possibly) on different channels. 92 */ 93 #ifndef OPENTHREAD_CONFIG_ANNOUNCE_SENDER_JITTER_INTERVAL 94 #define OPENTHREAD_CONFIG_ANNOUNCE_SENDER_JITTER_INTERVAL 500 95 #endif 96 97 /** 98 * @} 99 */ 100 101 #endif // CONFIG_ANNOUNCE_SENDER_H_ 102
