xref: /aosp_15_r20/external/openthread/src/core/net/nd_agent.hpp (revision cfb92d1480a9e65faed56933e9c12405f45898b4)
1 /*
2  *  Copyright (c) 2021, 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 IPv6 Neighbor Discovery Agent.
32  */
33 
34 #ifndef NEIGHBOR_DISCOVERY_AGENT_HPP_
35 #define NEIGHBOR_DISCOVERY_AGENT_HPP_
36 
37 #include "openthread-core-config.h"
38 
39 #if OPENTHREAD_CONFIG_NEIGHBOR_DISCOVERY_AGENT_ENABLE
40 
41 #include "common/locator.hpp"
42 #include "common/non_copyable.hpp"
43 #include "net/netif.hpp"
44 
45 namespace ot {
46 namespace NeighborDiscovery {
47 
48 class Agent : public InstanceLocator, private NonCopyable
49 {
50 public:
51     /**
52      * Initializes the object.
53      *
54      * @param[in]  aInstance  A reference to the OpenThread instance.
55      *
56      */
Agent(Instance & aInstance)57     explicit Agent(Instance &aInstance)
58         : InstanceLocator(aInstance)
59     {
60         FreeAloc();
61     }
62 
63     /**
64      * Updates the Neighbor Discovery Agents using current Thread Network Data.
65      *
66      */
67     void UpdateService(void);
68 
69 private:
FreeAloc(void)70     void FreeAloc(void) { mAloc.mNext = &mAloc; }
IsAlocInUse(void) const71     bool IsAlocInUse(void) const { return mAloc.mNext != &mAloc; }
72 
73     Ip6::Netif::UnicastAddress mAloc;
74 };
75 
76 } // namespace NeighborDiscovery
77 } // namespace ot
78 
79 #endif // OPENTHREAD_CONFIG_NEIGHBOR_DISCOVERY_AGENT_ENABLE
80 
81 #endif // NEIGHBOR_DISCOVERY_AGENT_HPP_
82