1 /* 2 * Copyright (c) 2020, 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 definitions for transmitting SVR_DATA.ntf messages. 32 */ 33 34 #ifndef NETWORK_DATA_NOTIFIER_HPP_ 35 #define NETWORK_DATA_NOTIFIER_HPP_ 36 37 #include "openthread-core-config.h" 38 39 #if OPENTHREAD_FTD || OPENTHREAD_CONFIG_BORDER_ROUTER_ENABLE || OPENTHREAD_CONFIG_TMF_NETDATA_SERVICE_ENABLE 40 41 #include "coap/coap.hpp" 42 #include "common/message.hpp" 43 #include "common/non_copyable.hpp" 44 #include "common/notifier.hpp" 45 #include "common/tasklet.hpp" 46 #include "common/time_ticker.hpp" 47 48 namespace ot { 49 namespace NetworkData { 50 51 /** 52 * This class implements the SVR_DATA.ntf transmission logic. 53 * 54 */ 55 class Notifier : public InstanceLocator, private NonCopyable 56 { 57 friend class ot::Notifier; 58 friend class ot::TimeTicker; 59 60 public: 61 /** 62 * Constructor. 63 * 64 * @param[in] aInstance The OpenThread instance. 65 * 66 */ 67 explicit Notifier(Instance &aInstance); 68 69 /** 70 * Call this method to inform the notifier that new server data is available. 71 * 72 * This method posts a tasklet to sync new server data with leader so if there are multiple changes within the same 73 * flow of execution (multiple calls to this method) they are all synchronized together and included in the same 74 * message to the leader. 75 * 76 */ 77 void HandleServerDataUpdated(void); 78 79 #if OPENTHREAD_FTD && OPENTHREAD_CONFIG_BORDER_ROUTER_ENABLE && OPENTHREAD_CONFIG_BORDER_ROUTER_REQUEST_ROUTER_ROLE 80 /** 81 * This method indicates whether the device as border router is eligible for router role upgrade request using the 82 * status reason `kBorderRouterRequest`. 83 * 84 * This method checks whether device is providing IP connectivity and that there are fewer than two border routers 85 * in network data acting as router. Device is considered to provide external IP connectivity if at least one of 86 * the below conditions hold: 87 * 88 * - It has added at least one external route entry. 89 * - It has added at least one prefix entry with default-route and on-mesh flags set. 90 * - It has added at least one domain prefix (domain and on-mesh flags set). 91 * 92 * This method does not check the current role of device. 93 * 94 * @retval TRUE Device is eligible to request router role upgrade as a border router. 95 * @retval FALSE Device is not eligible to request router role upgrade as a border router. 96 * 97 */ 98 bool IsEligibleForRouterRoleUpgradeAsBorderRouter(void) const; 99 #endif 100 101 private: 102 static constexpr uint32_t kDelayNoBufs = 1000; // in msec 103 static constexpr uint32_t kDelayRemoveStaleChildren = 5000; // in msec 104 static constexpr uint32_t kDelaySynchronizeServerData = 300000; // in msec 105 static constexpr uint8_t kRouterRoleUpgradeMaxTimeout = 10; // in sec 106 107 void HandleNotifierEvents(Events aEvents); 108 109 static void HandleTimer(Timer &aTimer); 110 void HandleTimer(void); 111 112 static void HandleCoapResponse(void * aContext, 113 otMessage * aMessage, 114 const otMessageInfo *aMessageInfo, 115 Error aResult); 116 void HandleCoapResponse(Error aResult); 117 118 static void HandleSynchronizeDataTask(Tasklet &aTasklet); 119 120 void SynchronizeServerData(void); 121 #if OPENTHREAD_FTD && OPENTHREAD_CONFIG_BORDER_ROUTER_ENABLE && OPENTHREAD_CONFIG_BORDER_ROUTER_REQUEST_ROUTER_ROLE 122 void ScheduleRouterRoleUpgradeIfEligible(void); 123 void HandleTimeTick(void); 124 #endif 125 126 TimerMilli mTimer; 127 Tasklet mSynchronizeDataTask; 128 uint32_t mNextDelay; 129 bool mWaitingForResponse : 1; 130 131 #if OPENTHREAD_FTD && OPENTHREAD_CONFIG_BORDER_ROUTER_ENABLE && OPENTHREAD_CONFIG_BORDER_ROUTER_REQUEST_ROUTER_ROLE 132 bool mDidRequestRouterRoleUpgrade : 1; 133 uint8_t mRouterRoleUpgradeTimeout; 134 #endif 135 }; 136 137 } // namespace NetworkData 138 } // namespace ot 139 140 #endif // OPENTHREAD_FTD || OPENTHREAD_CONFIG_BORDER_ROUTER_ENABLE || OPENTHREAD_CONFIG_TMF_NETDATA_SERVICE_ENABLE 141 142 #endif // NETWORK_DATA_NOTIFIER_HPP_ 143