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