1 /* 2 * Copyright (c) 2024, 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 d-bus object of Thread service when 32 * the co-processor is an NCP. 33 */ 34 35 #ifndef OTBR_DBUS_THREAD_OBJECT_NCP_HPP_ 36 #define OTBR_DBUS_THREAD_OBJECT_NCP_HPP_ 37 38 #include "openthread-br/config.h" 39 40 #include <string> 41 42 #include <openthread/link.h> 43 44 #include "dbus/server/dbus_object.hpp" 45 #include "mdns/mdns.hpp" 46 #include "ncp/ncp_host.hpp" 47 48 namespace otbr { 49 namespace DBus { 50 51 /** 52 * @addtogroup border-router-dbus-server 53 * 54 * @brief 55 * This module includes the <a href="dbus-api.html">dbus server api</a>. 56 * 57 * @{ 58 */ 59 60 class DBusThreadObjectNcp : public DBusObject 61 { 62 public: 63 /** 64 * This constructor of dbus thread object. 65 * 66 * @param[in] aConnection The dbus connection. 67 * @param[in] aInterfaceName The dbus interface name. 68 * @param[in] aHost The Thread controller. 69 */ 70 DBusThreadObjectNcp(DBusConnection &aConnection, const std::string &aInterfaceName, otbr::Ncp::NcpHost &aHost); 71 72 /** 73 * This method initializes the dbus thread object. 74 * 75 * @retval OTBR_ERROR_NONE The initialization succeeded. 76 * @retval OTBR_ERROR_DBUS The initialization failed due to dbus connection. 77 */ 78 otbrError Init(void) override; 79 80 private: 81 void AsyncGetDeviceRoleHandler(DBusRequest &aRequest); 82 void ReplyAsyncGetProperty(DBusRequest &aRequest, const std::string &aContent); 83 84 void JoinHandler(DBusRequest &aRequest); 85 void LeaveHandler(DBusRequest &aRequest); 86 void ScheduleMigrationHandler(DBusRequest &aRequest); 87 88 otbr::Ncp::NcpHost &mHost; 89 }; 90 91 /** 92 * @} 93 */ 94 95 } // namespace DBus 96 } // namespace otbr 97 98 #endif // OTBR_DBUS_THREAD_OBJECT_NCP_HPP_ 99