1 /* 2 * Copyright (c) 2016, 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 responding to Energy Scan Requests. 32 */ 33 34 #ifndef ENERGY_SCAN_SERVER_HPP_ 35 #define ENERGY_SCAN_SERVER_HPP_ 36 37 #include "openthread-core-config.h" 38 39 #include "common/locator.hpp" 40 #include "common/non_copyable.hpp" 41 #include "common/notifier.hpp" 42 #include "common/timer.hpp" 43 #include "net/ip6_address.hpp" 44 #include "net/udp6.hpp" 45 #include "thread/thread_tlvs.hpp" 46 #include "thread/tmf.hpp" 47 48 namespace ot { 49 50 /** 51 * Implements handling Energy Scan Requests. 52 */ 53 class EnergyScanServer : public InstanceLocator, private NonCopyable 54 { 55 friend class ot::Notifier; 56 friend class Tmf::Agent; 57 58 public: 59 /** 60 * Initializes the object. 61 */ 62 explicit EnergyScanServer(Instance &aInstance); 63 64 private: 65 static constexpr uint32_t kScanDelay = 1000; // SCAN_DELAY (milliseconds) 66 static constexpr uint32_t kReportDelay = 500; // Delay before sending a report (milliseconds) 67 68 template <Uri kUri> void HandleTmf(Coap::Message &aMessage, const Ip6::MessageInfo &aMessageInfo); 69 70 static void HandleScanResult(Mac::EnergyScanResult *aResult, void *aContext); 71 void HandleScanResult(Mac::EnergyScanResult *aResult); 72 73 void HandleTimer(void); 74 75 void HandleNotifierEvents(Events aEvents); 76 77 void SendReport(void); 78 79 using ScanTimer = TimerMilliIn<EnergyScanServer, &EnergyScanServer::HandleTimer>; 80 81 Ip6::Address mCommissioner; 82 uint32_t mChannelMask; 83 uint32_t mChannelMaskCurrent; 84 uint16_t mPeriod; 85 uint16_t mScanDuration; 86 uint8_t mCount; 87 uint8_t mNumScanResults; 88 Coap::Message *mReportMessage; 89 ScanTimer mTimer; 90 }; 91 92 DeclareTmfHandler(EnergyScanServer, kUriEnergyScan); 93 94 /** 95 * @} 96 */ 97 98 } // namespace ot 99 100 #endif // ENERGY_SCAN_SERVER_HPP_ 101