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_CLIENT_HPP_
35 #define PANID_QUERY_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 "common/callback.hpp"
44 #include "common/locator.hpp"
45 #include "net/ip6_address.hpp"
46 #include "net/udp6.hpp"
47 #include "thread/tmf.hpp"
48 
49 namespace ot {
50 
51 /**
52  * Implements handling PANID Query Requests.
53  */
54 class PanIdQueryClient : public InstanceLocator
55 {
56     friend class Tmf::Agent;
57 
58 public:
59     /**
60      * Initializes the object.
61      */
62     explicit PanIdQueryClient(Instance &aInstance);
63 
64     /**
65      * Sends a PAN ID Query message.
66      *
67      * @param[in]  aPanId         The PAN ID to query.
68      * @param[in]  aChannelMask   The channel mask value.
69      * @param[in]  aAddress       A pointer to the IPv6 destination.
70      * @param[in]  aCallback      A pointer to a function called on receiving an Energy Report message.
71      * @param[in]  aContext       A pointer to application-specific context.
72      *
73      * @retval kErrorNone    Successfully enqueued the PAN ID Query message.
74      * @retval kErrorNoBufs  Insufficient buffers to generate a PAN ID Query message.
75      */
76     Error SendQuery(uint16_t                            aPanId,
77                     uint32_t                            aChannelMask,
78                     const Ip6::Address                 &aAddress,
79                     otCommissionerPanIdConflictCallback aCallback,
80                     void                               *aContext);
81 
82 private:
83     template <Uri kUri> void HandleTmf(Coap::Message &aMessage, const Ip6::MessageInfo &aMessageInfo);
84 
85     Callback<otCommissionerPanIdConflictCallback> mCallback;
86 };
87 
88 DeclareTmfHandler(PanIdQueryClient, kUriPanIdConflict);
89 
90 /**
91  * @}
92  */
93 
94 } // namespace ot
95 
96 #endif // OPENTHREAD_CONFIG_COMMISSIONER_ENABLE && OPENTHREAD_FTD
97 
98 #endif // PANID_QUERY_CLIENT_HPP_
99