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 Backbone TMF functionality. 32 */ 33 34 #ifndef OT_CORE_THREAD_BACKBONE_TMF_HPP_ 35 #define OT_CORE_THREAD_BACKBONE_TMF_HPP_ 36 37 #include "openthread-core-config.h" 38 39 #if OPENTHREAD_FTD && OPENTHREAD_CONFIG_BACKBONE_ROUTER_ENABLE 40 41 #include "coap/coap.hpp" 42 #include "thread/tmf.hpp" 43 44 namespace ot { 45 namespace BackboneRouter { 46 47 constexpr uint16_t kBackboneUdpPort = 61631; ///< Backbone TMF UDP Port 48 49 /** 50 * Implements functionality of the Backbone TMF agent. 51 * 52 */ 53 class BackboneTmfAgent : public Coap::Coap 54 { 55 public: 56 /** 57 * Initializes the object. 58 * 59 * @param[in] aInstance A reference to the OpenThread instance. 60 * 61 */ 62 explicit BackboneTmfAgent(Instance &aInstance); 63 64 /** 65 * Starts the Backbone TMF agent. 66 * 67 * @retval kErrorNone Successfully started the CoAP service. 68 * @retval kErrorFailed Failed to start the Backbone TMF agent. 69 * 70 */ 71 Error Start(void); 72 73 /** 74 * Returns whether @p aMessageInfo meets Backbone Thread Management Framework Addressing Rules. 75 * 76 * @retval true Thread Management Framework Addressing Rules are met. 77 * @retval false Thread Management Framework Addressing Rules are not met. 78 * 79 */ 80 bool IsBackboneTmfMessage(const Ip6::MessageInfo &aMessageInfo) const; 81 82 /** 83 * Subscribes the Backbone TMF socket to a given IPv6 multicast group on the Backbone network. 84 * 85 * @param[in] aAddress The IPv6 multicast group address. 86 * 87 */ 88 void SubscribeMulticast(const Ip6::Address &aAddress); 89 90 /** 91 * Unsubscribes the Backbone TMF socket from a given IPv6 multicast group on the Backbone network. 92 * 93 * @param[in] aAddress The IPv6 multicast group address. 94 * 95 */ 96 void UnsubscribeMulticast(const Ip6::Address &aAddress); 97 98 private: 99 static bool HandleResource(CoapBase &aCoapBase, 100 const char *aUriPath, 101 ot::Coap::Message &aMessage, 102 const Ip6::MessageInfo &aMessageInfo); 103 bool HandleResource(const char *aUriPath, ot::Coap::Message &aMessage, const Ip6::MessageInfo &aMessageInfo); 104 void LogError(const char *aText, const Ip6::Address &aAddress, Error aError) const; 105 static Error Filter(const ot::Coap::Message &aMessage, const Ip6::MessageInfo &aMessageInfo, void *aContext); 106 }; 107 108 } // namespace BackboneRouter 109 } // namespace ot 110 111 #endif // OPENTHREAD_FTD && OPENTHREAD_CONFIG_BACKBONE_ROUTER_ENABLE 112 113 #endif // OT_CORE_THREAD_BACKBONE_TMF_HPP_ 114