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_SERVER_HPP_
35 #define ANNOUNCE_BEGIN_SERVER_HPP_
36 
37 #include "openthread-core-config.h"
38 
39 #include "common/locator.hpp"
40 #include "common/timer.hpp"
41 #include "net/ip6_address.hpp"
42 #include "thread/announce_sender.hpp"
43 #include "thread/tmf.hpp"
44 
45 namespace ot {
46 
47 /**
48  * This class implements handling Announce Begin Requests.
49  *
50  */
51 class AnnounceBeginServer : public AnnounceSenderBase
52 {
53     friend class Tmf::Agent;
54 
55 public:
56     /**
57      * This constructor initializes the object.
58      *
59      */
60     explicit AnnounceBeginServer(Instance &aInstance);
61 
62     /**
63      * This method begins the MLE Announce transmission process.
64      *
65      * @param[in]  aChannelMask   The channels to use for transmission.
66      * @param[in]  aCount         The number of transmissions per channel.
67      * @param[in]  aPeriod        The time between transmissions (milliseconds).
68      *
69      */
70     void SendAnnounce(uint32_t aChannelMask, uint8_t aCount = kDefaultCount, uint16_t aPeriod = kDefaultPeriod);
71 
72 private:
73     static constexpr uint8_t  kDefaultCount  = 3;
74     static constexpr uint16_t kDefaultPeriod = 1000;
75     static constexpr uint16_t kDefaultJitter = 0;
76 
77     template <Uri kUri> void HandleTmf(Coap::Message &aMessage, const Ip6::MessageInfo &aMessageInfo);
78 
79     static void HandleTimer(Timer &aTimer);
80 };
81 
82 DeclareTmfHandler(AnnounceBeginServer, kUriAnnounceBegin);
83 
84 /**
85  * @}
86  */
87 
88 } // namespace ot
89 
90 #endif // ANNOUNCE_BEGIN_SERVER_HPP_
91