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 Network Data Publisher. 32 */ 33 34 #ifndef CONFIG_NETDATA_PUBLISHER_H_ 35 #define CONFIG_NETDATA_PUBLISHER_H_ 36 37 /** 38 * @addtogroup config-netdata-publisher 39 * 40 * @brief 41 * This module includes configuration variables for Network Data Publisher. 42 * 43 * @{ 44 */ 45 46 #include "config/border_router.h" 47 #include "config/border_routing.h" 48 #include "config/srp_server.h" 49 50 /** 51 * @def OPENTHREAD_CONFIG_NETDATA_PUBLISHER_ENABLE 52 * 53 * Define to 1 to enable Network Data Publisher. 54 * 55 * Network Data Publisher provides mechanisms to limit the number of similar Service and/or Prefix (on-mesh prefix 56 * or external route) entries in the Thread Network Data by monitoring the Network Data and managing if or when to add 57 * or remove entries. 58 */ 59 #ifndef OPENTHREAD_CONFIG_NETDATA_PUBLISHER_ENABLE 60 #define OPENTHREAD_CONFIG_NETDATA_PUBLISHER_ENABLE \ 61 (OPENTHREAD_CONFIG_SRP_SERVER_ENABLE || OPENTHREAD_CONFIG_BORDER_ROUTING_ENABLE) 62 #endif 63 64 /** 65 * @def OPENTHREAD_CONFIG_NETDATA_PUBLISHER_MAX_DELAY_TO_ADD 66 * 67 * Specifies the maximum value (in milliseconds) of the random delay used before adding an entry in the Thread Network 68 * Data. 69 */ 70 #ifndef OPENTHREAD_CONFIG_NETDATA_PUBLISHER_MAX_DELAY_TO_ADD 71 #define OPENTHREAD_CONFIG_NETDATA_PUBLISHER_MAX_DELAY_TO_ADD 3500 72 #endif 73 74 /** 75 * @def OPENTHREAD_CONFIG_NETDATA_PUBLISHER_MAX_DELAY_TO_REMOVE 76 * 77 * Specifies the maximum value (in milliseconds) of the random wait time used before removing an entry from the Thread 78 * Network Data. 79 */ 80 #ifndef OPENTHREAD_CONFIG_NETDATA_PUBLISHER_MAX_DELAY_TO_REMOVE 81 #define OPENTHREAD_CONFIG_NETDATA_PUBLISHER_MAX_DELAY_TO_REMOVE 15000 82 #endif 83 84 /** 85 * @def OPENTHREAD_CONFIG_NETDATA_PUBLISHER_EXTRA_DELAY_TIME_TO_REMOVE_PREFERRED 86 * 87 * Specifies the extra wait time (in milliseconds) used when removing a preferred entry. 88 * 89 * When removing entries, certain entries are preferred over others. How the preference is determined depends on the 90 * entry type (e.g., (for DNS/SRP service entries associated with smaller RLOC16 or smaller IPv6 address are preferred). 91 * If the `Publisher` determines that its own entry is a preferred one, it adds the above extra wait time in addition 92 * to the random wait selected based on `OPENTHREAD_CONFIG_NETDATA_PUBLISHER_MAX_DELAY_TO_REMOVE` before removing 93 * its entry. This gives higher chance for a non-preferred entry from another device to be removed before removing a 94 * preferred entry which helps towards quicker convergence of the process to the desired number of entries. 95 * 96 * It is recommended that `OPENTHREAD_CONFIG_NETDATA_PUBLISHER_EXTRA_DELAY_TIME_TO_REMOVE_PREFERRED` to be set to a 97 * value larger than `OPENTHREAD_CONFIG_NETDATA_PUBLISHER_MAX_DELAY_TO_REMOVE` to ensure that non-preferred entries 98 * are removed first. 99 */ 100 #ifndef OPENTHREAD_CONFIG_NETDATA_PUBLISHER_EXTRA_DELAY_TIME_TO_REMOVE_PREFERRED 101 #define OPENTHREAD_CONFIG_NETDATA_PUBLISHER_EXTRA_DELAY_TIME_TO_REMOVE_PREFERRED 16000 102 #endif 103 104 /** 105 * @def OPENTHREAD_CONFIG_NETDATA_PUBLISHER_DESIRED_NUM_ANYCAST_DNS_SRP_SERVICE_ENTRIES 106 * 107 * Specifies the desired number of "DNS/SRP Service Anycast Address" entries in the Thread Network Data. 108 * 109 * Publisher attempts to limit the number of such entries to this value. 110 */ 111 #ifndef OPENTHREAD_CONFIG_NETDATA_PUBLISHER_DESIRED_NUM_ANYCAST_DNS_SRP_SERVICE_ENTRIES 112 #define OPENTHREAD_CONFIG_NETDATA_PUBLISHER_DESIRED_NUM_ANYCAST_DNS_SRP_SERVICE_ENTRIES 8 113 #endif 114 115 /** 116 * @def OPENTHREAD_CONFIG_NETDATA_PUBLISHER_DESIRED_NUM_UNICAST_DNS_SRP_SERVICE_ENTRIES 117 * 118 * Specifies the desired number of "DNS/SRP Service Anycast Address" entries in the Thread Network Data. 119 * 120 * Publisher attempts to limit the number of such entries to this value. 121 */ 122 #ifndef OPENTHREAD_CONFIG_NETDATA_PUBLISHER_DESIRED_NUM_UNICAST_DNS_SRP_SERVICE_ENTRIES 123 #define OPENTHREAD_CONFIG_NETDATA_PUBLISHER_DESIRED_NUM_UNICAST_DNS_SRP_SERVICE_ENTRIES 2 124 #endif 125 126 /** 127 * @def OPENTHREAD_CONFIG_NETDATA_PUBLISHER_DESIRED_NUM_ON_MESH_PREFIX_ENTRIES 128 * 129 * Specifies the desired number of matching On-mesh Prefix entries in the Thread Network Data. 130 * 131 * Publisher attempts to limit the number of matching entries to this value. 132 */ 133 #ifndef OPENTHREAD_CONFIG_NETDATA_PUBLISHER_DESIRED_NUM_ON_MESH_PREFIX_ENTRIES 134 #define OPENTHREAD_CONFIG_NETDATA_PUBLISHER_DESIRED_NUM_ON_MESH_PREFIX_ENTRIES 3 135 #endif 136 137 /** 138 * @def OPENTHREAD_CONFIG_NETDATA_PUBLISHER_DESIRED_NUM_EXTERNAL_ROUTE_ENTRIES 139 * 140 * Specifies the desired number of matching External Route entries in the Thread Network Data. 141 * 142 * Publisher attempts to limit the number of matching entries to this value. 143 */ 144 #ifndef OPENTHREAD_CONFIG_NETDATA_PUBLISHER_DESIRED_NUM_EXTERNAL_ROUTE_ENTRIES 145 #define OPENTHREAD_CONFIG_NETDATA_PUBLISHER_DESIRED_NUM_EXTERNAL_ROUTE_ENTRIES 10 146 #endif 147 148 /** 149 * @def OPENTHREAD_CONFIG_NETDATA_PUBLISHER_MAX_PREFIX_ENTRIES 150 * 151 * Specifies maximum number of prefix (on-mesh prefix or external route) entries reserved by Publisher for use by 152 * user (through OT public APIs). 153 */ 154 #ifndef OPENTHREAD_CONFIG_NETDATA_PUBLISHER_MAX_PREFIX_ENTRIES 155 #define OPENTHREAD_CONFIG_NETDATA_PUBLISHER_MAX_PREFIX_ENTRIES 3 156 #endif 157 158 /** 159 * @} 160 */ 161 162 #endif // CONFIG_NETDATA_PUBLISHER_H_ 163
