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 the Thread network interface.
32  */
33 
34 #ifndef THREAD_NETIF_HPP_
35 #define THREAD_NETIF_HPP_
36 
37 #include "openthread-core-config.h"
38 
39 #include "net/ip6_address.hpp"
40 #include "net/netif.hpp"
41 
42 namespace ot {
43 
44 /**
45  * @addtogroup core-netif
46  *
47  * @brief
48  *   This module includes definitions for the Thread network interface.
49  *
50  * @{
51  */
52 
53 class ThreadNetif : public Ip6::Netif
54 {
55 public:
56     /**
57      * Initializes the Thread network interface.
58      *
59      * @param[in]  aInstance  A reference to the OpenThread instance.
60      *
61      */
62     explicit ThreadNetif(Instance &aInstance);
63 
64     /**
65      * Enables the Thread network interface.
66      *
67      */
68     void Up(void);
69 
70     /**
71      * Disables the Thread network interface.
72      *
73      */
74     void Down(void);
75 
76     /**
77      * Indicates whether or not the Thread network interface is enabled.
78      *
79      * @retval TRUE   If the Thread network interface is enabled.
80      * @retval FALSE  If the Thread network interface is not enabled.
81      *
82      */
IsUp(void) const83     bool IsUp(void) const { return mIsUp; }
84 
85 private:
86     bool mIsUp;
87 };
88 
89 /**
90  * @}
91  */
92 
93 } // namespace ot
94 
95 #endif // THREAD_NETIF_HPP_
96