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 
43 namespace ot {
44 namespace BackboneRouter {
45 
46 constexpr uint16_t kBackboneUdpPort = 61631; ///< Backbone TMF UDP Port
47 
48 /**
49  * This class implements functionality of the Backbone TMF agent.
50  *
51  */
52 class BackboneTmfAgent : public Coap::Coap
53 {
54 public:
55     /**
56      * This constructor initializes the object.
57      *
58      * @param[in] aInstance      A reference to the OpenThread instance.
59      *
60      */
BackboneTmfAgent(Instance & aInstance)61     explicit BackboneTmfAgent(Instance &aInstance)
62         : Coap::Coap(aInstance)
63     {
64         SetInterceptor(&Filter, this);
65     }
66 
67     /**
68      * This method starts the Backbone TMF agent.
69      *
70      * @retval kErrorNone    Successfully started the CoAP service.
71      * @retval kErrorFailed  Failed to start the Backbone TMF agent.
72      *
73      */
74     Error Start(void);
75 
76     /**
77      * This method returns whether @p aMessageInfo meets Backbone Thread Management Framework Addressing Rules.
78      *
79      * @retval true   Thread Management Framework Addressing Rules are met.
80      * @retval false  Thread Management Framework Addressing Rules are not met.
81      *
82      */
83     bool IsBackboneTmfMessage(const Ip6::MessageInfo &aMessageInfo) const;
84 
85     /**
86      * This method subscribes the Backbone TMF socket to a given IPv6 multicast group on the Backbone network.
87      *
88      * @param[in] aAddress  The IPv6 multicast group address.
89      *
90      */
91     void SubscribeMulticast(const Ip6::Address &aAddress);
92 
93     /**
94      * This method unsubscribes the Backbone TMF socket from a given IPv6 multicast group on the Backbone network.
95      *
96      * @param[in] aAddress  The IPv6 multicast group address.
97      *
98      */
99     void UnsubscribeMulticast(const Ip6::Address &aAddress);
100 
101 private:
102     static Error Filter(const ot::Coap::Message &aMessage, const Ip6::MessageInfo &aMessageInfo, void *aContext);
103 };
104 
105 } // namespace BackboneRouter
106 } // namespace ot
107 
108 #endif //  OPENTHREAD_FTD && OPENTHREAD_CONFIG_BACKBONE_ROUTER_ENABLE
109 
110 #endif //  OT_CORE_THREAD_BACKBONE_TMF_HPP_
111