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 PANID Query Requests. 32 */ 33 34 #ifndef ENERGY_SCAN_CLIENT_HPP_ 35 #define ENERGY_SCAN_CLIENT_HPP_ 36 37 #include "openthread-core-config.h" 38 39 #if OPENTHREAD_CONFIG_COMMISSIONER_ENABLE && OPENTHREAD_FTD 40 41 #include <openthread/commissioner.h> 42 43 #include "coap/coap.hpp" 44 #include "common/callback.hpp" 45 #include "common/locator.hpp" 46 #include "net/ip6_address.hpp" 47 #include "net/udp6.hpp" 48 #include "thread/tmf.hpp" 49 50 namespace ot { 51 52 /** 53 * Implements handling PANID Query Requests. 54 * 55 */ 56 class EnergyScanClient : public InstanceLocator 57 { 58 friend class Tmf::Agent; 59 60 public: 61 /** 62 * Initializes the object. 63 * 64 */ 65 explicit EnergyScanClient(Instance &aInstance); 66 67 /** 68 * Sends an Energy Scan Query message. 69 * 70 * @param[in] aChannelMask The channel mask value. 71 * @param[in] aCount The number of energy measurements per channel. 72 * @param[in] aPeriod The time between energy measurements (milliseconds). 73 * @param[in] aScanDuration The scan duration for each energy measurement (milliseconds). 74 * @param[in] aAddress A pointer to the IPv6 destination. 75 * @param[in] aCallback A pointer to a function called on receiving an Energy Report message. 76 * @param[in] aContext A pointer to application-specific context. 77 * 78 * @retval kErrorNone Successfully enqueued the Energy Scan Query message. 79 * @retval kErrorNoBufs Insufficient buffers to generate an Energy Scan Query message. 80 * 81 */ 82 Error SendQuery(uint32_t aChannelMask, 83 uint8_t aCount, 84 uint16_t aPeriod, 85 uint16_t aScanDuration, 86 const Ip6::Address &aAddress, 87 otCommissionerEnergyReportCallback aCallback, 88 void *aContext); 89 90 private: 91 template <Uri kUri> void HandleTmf(Coap::Message &aMessage, const Ip6::MessageInfo &aMessageInfo); 92 93 Callback<otCommissionerEnergyReportCallback> mCallback; 94 }; 95 96 DeclareTmfHandler(EnergyScanClient, kUriEnergyReport); 97 98 /** 99 * @} 100 */ 101 102 } // namespace ot 103 104 #endif // OPENTHREAD_CONFIG_COMMISSIONER_ENABLE && OPENTHREAD_FTD 105 106 #endif // ENERGY_SCAN_CLIENT_HPP_ 107
