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 Announce Requests.
32  */
33 
34 #ifndef ANNOUNCE_BEGIN_CLIENT_HPP_
35 #define ANNOUNCE_BEGIN_CLIENT_HPP_
36 
37 #include "openthread-core-config.h"
38 
39 #if OPENTHREAD_CONFIG_COMMISSIONER_ENABLE && OPENTHREAD_FTD
40 
41 #include "coap/coap.hpp"
42 #include "common/locator.hpp"
43 #include "net/ip6_address.hpp"
44 #include "net/udp6.hpp"
45 
46 namespace ot {
47 
48 /**
49  * This class implements handling Announce Begin Requests.
50  *
51  */
52 class AnnounceBeginClient : public InstanceLocator
53 {
54 public:
55     /**
56      * This constructor initializes the object.
57      *
58      */
59     explicit AnnounceBeginClient(Instance &aInstance);
60 
61     /**
62      * This method sends a Announce Begin message.
63      *
64      * @param[in]  aChannelMask   The channel mask value.
65      * @param[in]  aCount         The number of Announce messages sent per channel.
66      * @param[in]  aPeriod        The time between two successive MLE Announce transmissions (in milliseconds).
67      * @param[in]  aAddress       The destination address.
68      *
69      * @retval kErrorNone    Successfully enqueued the Announce Begin message.
70      * @retval kErrorNoBufs  Insufficient buffers to generate a Announce Begin message.
71      *
72      */
73     Error SendRequest(uint32_t aChannelMask, uint8_t aCount, uint16_t aPeriod, const Ip6::Address &aAddress);
74 };
75 
76 /**
77  * @}
78  */
79 
80 } // namespace ot
81 
82 #endif // OPENTHREAD_CONFIG_COMMISSIONER_ENABLE && OPENTHREAD_FTD
83 
84 #endif // ANNOUNCE_BEGIN_CLIENT_HPP_
85