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 PANID_QUERY_SERVER_HPP_
35 #define PANID_QUERY_SERVER_HPP_
36 
37 #include "openthread-core-config.h"
38 
39 #include "common/locator.hpp"
40 #include "common/non_copyable.hpp"
41 #include "common/timer.hpp"
42 #include "mac/mac.hpp"
43 #include "net/ip6_address.hpp"
44 #include "net/udp6.hpp"
45 #include "thread/tmf.hpp"
46 
47 namespace ot {
48 
49 /**
50  * Implements handling PANID Query Requests.
51  *
52  */
53 class PanIdQueryServer : public InstanceLocator, private NonCopyable
54 {
55     friend class Tmf::Agent;
56 
57 public:
58     /**
59      * Initializes the object.
60      *
61      */
62     explicit PanIdQueryServer(Instance &aInstance);
63 
64 private:
65     static constexpr uint32_t kScanDelay = 1000; ///< SCAN_DELAY (in msec)
66 
67     template <Uri kUri> void HandleTmf(Coap::Message &aMessage, const Ip6::MessageInfo &aMessageInfo);
68 
69     static void HandleScanResult(Mac::ActiveScanResult *aScanResult, void *aContext);
70     void        HandleScanResult(Mac::ActiveScanResult *aScanResult);
71 
72     void HandleTimer(void);
73 
74     static void HandleUdpReceive(void *aContext, otMessage *aMessage, const otMessageInfo *aMessageInfo);
75 
76     void SendConflict(void);
77 
78     using DelayTimer = TimerMilliIn<PanIdQueryServer, &PanIdQueryServer::HandleTimer>;
79 
80     Ip6::Address mCommissioner;
81     uint32_t     mChannelMask;
82     uint16_t     mPanId;
83 
84     DelayTimer mTimer;
85 };
86 
87 DeclareTmfHandler(PanIdQueryServer, kUriPanIdQuery);
88 
89 /**
90  * @}
91  */
92 
93 } // namespace ot
94 
95 #endif // PANID_QUERY_SERVER_HPP_
96