| /* |
| * Copyright (c) 2017, The OpenThread Authors. |
| * All rights reserved. |
| * |
| * Redistribution and use in source and binary forms, with or without |
| * modification, are permitted provided that the following conditions are met: |
| * 1. Redistributions of source code must retain the above copyright |
| * notice, this list of conditions and the following disclaimer. |
| * 2. Redistributions in binary form must reproduce the above copyright |
| * notice, this list of conditions and the following disclaimer in the |
| * documentation and/or other materials provided with the distribution. |
| * 3. Neither the name of the copyright holder nor the |
| * names of its contributors may be used to endorse or promote products |
| * derived from this software without specific prior written permission. |
| * |
| * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" |
| * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE |
| * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE |
| * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE |
| * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR |
| * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF |
| * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS |
| * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN |
| * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) |
| * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE |
| * POSSIBILITY OF SUCH DAMAGE. |
| */ |
| |
| /** |
| * @file |
| * This file includes definition for Thread border agent. |
| */ |
| |
| #ifndef OTBR_AGENT_BORDER_AGENT_HPP_ |
| #define OTBR_AGENT_BORDER_AGENT_HPP_ |
| |
| #include <vector> |
| |
| #include <stdint.h> |
| |
| #include "agent/instance_params.hpp" |
| #include "common/mainloop.hpp" |
| #include "mdns/mdns.hpp" |
| #include "ncp/ncp_openthread.hpp" |
| #include "sdp_proxy/advertising_proxy.hpp" |
| #include "sdp_proxy/discovery_proxy.hpp" |
| |
| #if OTBR_ENABLE_BACKBONE_ROUTER |
| #include "backbone_router/backbone_agent.hpp" |
| #endif |
| |
| #ifndef OTBR_VENDOR_NAME |
| #define OTBR_VENDOR_NAME "OpenThread" |
| #endif |
| |
| #ifndef OTBR_PRODUCT_NAME |
| #define OTBR_PRODUCT_NAME "BorderRouter" |
| #endif |
| |
| #ifndef OTBR_MESHCOP_SERVICE_INSTANCE_NAME |
| #define OTBR_MESHCOP_SERVICE_INSTANCE_NAME OTBR_VENDOR_NAME "_" OTBR_PRODUCT_NAME |
| #endif |
| |
| namespace otbr { |
| |
| /** |
| * @addtogroup border-router-border-agent |
| * |
| * @brief |
| * This module includes definition for Thread border agent |
| * |
| * @{ |
| */ |
| |
| /** |
| * This class implements Thread border agent functionality. |
| * |
| */ |
| class BorderAgent |
| { |
| public: |
| /** |
| * The constructor to initialize the Thread border agent. |
| * |
| * @param[in] aNcp A reference to the NCP controller. |
| * |
| */ |
| BorderAgent(otbr::Ncp::ControllerOpenThread &aNcp); |
| |
| ~BorderAgent(void); |
| |
| /** |
| * This method initialize border agent service. |
| * |
| */ |
| void Init(void); |
| |
| private: |
| enum : uint8_t |
| { |
| kConnectionModeDisabled = 0, |
| kConnectionModePskc = 1, |
| kConnectionModePskd = 2, |
| kConnectionModeVendor = 3, |
| kConnectionModeX509 = 4, |
| }; |
| |
| enum : uint8_t |
| { |
| kThreadIfStatusNotInitialized = 0, |
| kThreadIfStatusInitialized = 1, |
| kThreadIfStatusActive = 2, |
| }; |
| |
| enum : uint8_t |
| { |
| kAvailabilityInfrequent = 0, |
| kAvailabilityHigh = 1, |
| }; |
| |
| struct StateBitmap |
| { |
| uint32_t mConnectionMode : 3; |
| uint32_t mThreadIfStatus : 2; |
| uint32_t mAvailability : 2; |
| uint32_t mBbrIsActive : 1; |
| uint32_t mBbrIsPrimary : 1; |
| |
| StateBitmap(void) |
| : mConnectionMode(0) |
| , mThreadIfStatus(0) |
| , mAvailability(0) |
| , mBbrIsActive(0) |
| , mBbrIsPrimary(0) |
| { |
| } |
| |
| uint32_t ToUint32(void) const; |
| }; |
| |
| otbrError Start(void); |
| void Stop(void); |
| static void HandleMdnsState(void *aContext, Mdns::Publisher::State aState); |
| void HandleMdnsState(Mdns::Publisher::State aState); |
| void PublishMeshCopService(void); |
| void UnpublishMeshCopService(void); |
| void UpdateMeshCopService(void); |
| #if OTBR_ENABLE_DBUS_SERVER |
| void HandleUpdateVendorMeshCoPTxtEntries(std::map<std::string, std::vector<uint8_t>> aUpdate); |
| #endif |
| |
| void HandleThreadStateChanged(otChangedFlags aFlags); |
| |
| bool IsThreadStarted(void) const; |
| bool IsPskcInitialized(void) const; |
| |
| otbr::Ncp::ControllerOpenThread &mNcp; |
| Mdns::Publisher * mPublisher; |
| std::string mNetworkName; |
| |
| #if OTBR_ENABLE_DBUS_SERVER |
| std::map<std::string, std::vector<uint8_t>> mMeshCopTxtUpdate; |
| #endif |
| |
| #if OTBR_ENABLE_SRP_ADVERTISING_PROXY |
| AdvertisingProxy mAdvertisingProxy; |
| #endif |
| #if OTBR_ENABLE_DNSSD_DISCOVERY_PROXY |
| Dnssd::DiscoveryProxy mDiscoveryProxy; |
| #endif |
| #if OTBR_ENABLE_BACKBONE_ROUTER |
| BackboneRouter::BackboneAgent mBackboneAgent; |
| #endif |
| }; |
| |
| /** |
| * @} |
| */ |
| |
| } // namespace otbr |
| |
| #endif // OTBR_AGENT_BORDER_AGENT_HPP_ |