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/locator_getters.hpp"
42 #include "common/log.hpp"
43 #include "instance/instance.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
51 RegisterLogModule("MeshCoP");
52
AnnounceBeginClient(Instance & aInstance)53 AnnounceBeginClient::AnnounceBeginClient(Instance &aInstance)
54 : InstanceLocator(aInstance)
55 {
56 }
57
SendRequest(uint32_t aChannelMask,uint8_t aCount,uint16_t aPeriod,const Ip6::Address & aAddress)58 Error AnnounceBeginClient::SendRequest(uint32_t aChannelMask,
59 uint8_t aCount,
60 uint16_t aPeriod,
61 const Ip6::Address &aAddress)
62 {
63 Error error = kErrorNone;
64 Tmf::MessageInfo messageInfo(GetInstance());
65 Coap::Message *message = nullptr;
66
67 VerifyOrExit(Get<MeshCoP::Commissioner>().IsActive(), error = kErrorInvalidState);
68 VerifyOrExit((message = Get<Tmf::Agent>().NewPriorityMessage()) != nullptr, error = kErrorNoBufs);
69
70 SuccessOrExit(error = message->InitAsPost(aAddress, kUriAnnounceBegin));
71 SuccessOrExit(error = message->SetPayloadMarker());
72
73 SuccessOrExit(
74 error = Tlv::Append<MeshCoP::CommissionerSessionIdTlv>(*message, Get<MeshCoP::Commissioner>().GetSessionId()));
75
76 SuccessOrExit(error = MeshCoP::ChannelMaskTlv::AppendTo(*message, aChannelMask));
77
78 SuccessOrExit(error = Tlv::Append<MeshCoP::CountTlv>(*message, aCount));
79 SuccessOrExit(error = Tlv::Append<MeshCoP::PeriodTlv>(*message, aPeriod));
80
81 messageInfo.SetSockAddrToRlocPeerAddrTo(aAddress);
82
83 SuccessOrExit(error = Get<Tmf::Agent>().SendMessage(*message, messageInfo));
84
85 LogInfo("Sent %s", UriToString<kUriAnnounceBegin>());
86
87 exit:
88 FreeMessageOnError(message, error);
89 return error;
90 }
91
92 } // namespace ot
93
94 #endif // OPENTHREAD_CONFIG_COMMISSIONER_ENABLE && OPENTHREAD_FTD
95
