1 /*
2  *  Copyright (c) 2020, 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 transmitting SVR_DATA.ntf messages.
32  */
33 
34 #ifndef NETWORK_DATA_NOTIFIER_HPP_
35 #define NETWORK_DATA_NOTIFIER_HPP_
36 
37 #include "openthread-core-config.h"
38 
39 #if OPENTHREAD_FTD || OPENTHREAD_CONFIG_BORDER_ROUTER_ENABLE || OPENTHREAD_CONFIG_TMF_NETDATA_SERVICE_ENABLE
40 
41 #include "coap/coap.hpp"
42 #include "common/message.hpp"
43 #include "common/non_copyable.hpp"
44 #include "common/notifier.hpp"
45 
46 namespace ot {
47 namespace NetworkData {
48 
49 /**
50  * This class implements the SVR_DATA.ntf transmission logic.
51  *
52  */
53 class Notifier : public InstanceLocator, private NonCopyable
54 {
55     friend class ot::Notifier;
56 
57 public:
58     /**
59      * Constructor.
60      *
61      * @param[in] aInstance  The OpenThread instance.
62      *
63      */
64     explicit Notifier(Instance &aInstance);
65 
66     /**
67      * Call this method to inform the notifier that new server data is available.
68      *
69      */
70     void HandleServerDataUpdated(void);
71 
72 private:
73     static constexpr uint32_t kDelayNoBufs                = 1000;   // in msec
74     static constexpr uint32_t kDelayRemoveStaleChildren   = 5000;   // in msec
75     static constexpr uint32_t kDelaySynchronizeServerData = 300000; // in msec
76 
77     void HandleNotifierEvents(Events aEvents);
78 
79     static void HandleTimer(Timer &aTimer);
80     void        HandleTimer(void);
81 
82     static void HandleCoapResponse(void *               aContext,
83                                    otMessage *          aMessage,
84                                    const otMessageInfo *aMessageInfo,
85                                    Error                aResult);
86     void        HandleCoapResponse(Error aResult);
87 
88     void SynchronizeServerData(void);
89 
90     TimerMilli mTimer;
91     uint32_t   mNextDelay;
92     bool       mWaitingForResponse;
93 };
94 
95 } // namespace NetworkData
96 } // namespace ot
97 
98 #endif // OPENTHREAD_FTD || OPENTHREAD_CONFIG_BORDER_ROUTER_ENABLE || OPENTHREAD_CONFIG_TMF_NETDATA_SERVICE_ENABLE
99 
100 #endif // NETWORK_DATA_NOTIFIER_HPP_
101