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 implements the Announce Begin Client.
32  */
33 
34 #include "announce_begin_client.hpp"
35 
36 #if OPENTHREAD_CONFIG_COMMISSIONER_ENABLE && OPENTHREAD_FTD
37 
38 #include "coap/coap_message.hpp"
39 #include "common/code_utils.hpp"
40 #include "common/debug.hpp"
41 #include "common/instance.hpp"
42 #include "common/locator_getters.hpp"
43 #include "common/logging.hpp"
44 #include "meshcop/meshcop.hpp"
45 #include "meshcop/meshcop_tlvs.hpp"
46 #include "thread/thread_netif.hpp"
47 #include "thread/uri_paths.hpp"
48 
49 namespace ot {
50 
AnnounceBeginClient(Instance & aInstance)51 AnnounceBeginClient::AnnounceBeginClient(Instance &aInstance)
52     : InstanceLocator(aInstance)
53 {
54 }
55 
SendRequest(uint32_t aChannelMask,uint8_t aCount,uint16_t aPeriod,const Ip6::Address & aAddress)56 Error AnnounceBeginClient::SendRequest(uint32_t            aChannelMask,
57                                        uint8_t             aCount,
58                                        uint16_t            aPeriod,
59                                        const Ip6::Address &aAddress)
60 {
61     Error                   error = kErrorNone;
62     MeshCoP::ChannelMaskTlv channelMask;
63     Ip6::MessageInfo        messageInfo;
64     Coap::Message *         message = nullptr;
65 
66     VerifyOrExit(Get<MeshCoP::Commissioner>().IsActive(), error = kErrorInvalidState);
67     VerifyOrExit((message = MeshCoP::NewMeshCoPMessage(Get<Tmf::Agent>())) != nullptr, error = kErrorNoBufs);
68 
69     SuccessOrExit(error = message->InitAsPost(aAddress, UriPath::kAnnounceBegin));
70     SuccessOrExit(error = message->SetPayloadMarker());
71 
72     SuccessOrExit(
73         error = Tlv::Append<MeshCoP::CommissionerSessionIdTlv>(*message, Get<MeshCoP::Commissioner>().GetSessionId()));
74 
75     channelMask.Init();
76     channelMask.SetChannelMask(aChannelMask);
77     SuccessOrExit(error = channelMask.AppendTo(*message));
78 
79     SuccessOrExit(error = Tlv::Append<MeshCoP::CountTlv>(*message, aCount));
80     SuccessOrExit(error = Tlv::Append<MeshCoP::PeriodTlv>(*message, aPeriod));
81 
82     messageInfo.SetSockAddr(Get<Mle::MleRouter>().GetMeshLocal16());
83     messageInfo.SetPeerAddr(aAddress);
84     messageInfo.SetPeerPort(Tmf::kUdpPort);
85 
86     SuccessOrExit(error = Get<Tmf::Agent>().SendMessage(*message, messageInfo));
87 
88     otLogInfoMeshCoP("sent announce begin query");
89 
90 exit:
91     FreeMessageOnError(message, error);
92     return error;
93 }
94 
95 } // namespace ot
96 
97 #endif // OPENTHREAD_CONFIG_COMMISSIONER_ENABLE && OPENTHREAD_FTD
98