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 * This constructor 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 * This method enables the Thread network interface. 66 * 67 */ 68 void Up(void); 69 70 /** 71 * This method disables the Thread network interface. 72 * 73 */ 74 void Down(void); 75 76 /** 77 * This method 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 /** 86 * This method submits a message to the network interface. 87 * 88 * @param[in] aMessage A reference to the message. 89 * 90 * @retval kErrorNone Successfully submitted the message to the interface. 91 * 92 */ 93 Error SendMessage(Message &aMessage); 94 95 /** 96 * This method performs a route lookup. 97 * 98 * @param[in] aSource A reference to the IPv6 source address. 99 * @param[in] aDestination A reference to the IPv6 destination address. 100 * @param[out] aPrefixMatch A pointer where the number of prefix match bits for the chosen route is stored. 101 * 102 * @retval kErrorNone Successfully found a route. 103 * @retval kErrorNoRoute Could not find a valid route. 104 * 105 */ 106 Error RouteLookup(const Ip6::Address &aSource, const Ip6::Address &aDestination, uint8_t *aPrefixMatch); 107 108 /** 109 * This method indicates whether @p aAddress matches an on-mesh prefix. 110 * 111 * @param[in] aAddress The IPv6 address. 112 * 113 * @retval TRUE If @p aAddress matches an on-mesh prefix. 114 * @retval FALSE If @p aAddress does not match an on-mesh prefix. 115 * 116 */ 117 bool IsOnMesh(const Ip6::Address &aAddress) const; 118 119 private: 120 bool mIsUp; 121 }; 122 123 /** 124 * @} 125 */ 126 127 } // namespace ot 128 129 #endif // THREAD_NETIF_HPP_ 130