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 d-bus agent. 32 */ 33 34 #ifndef OTBR_DBUS_AGENT_HPP_ 35 #define OTBR_DBUS_AGENT_HPP_ 36 37 #include "openthread-br/config.h" 38 39 #include <functional> 40 #include <set> 41 #include <string> 42 #include <sys/select.h> 43 44 #include "common/code_utils.hpp" 45 #include "common/mainloop.hpp" 46 #include "dbus/common/dbus_message_helper.hpp" 47 #include "dbus/common/dbus_resources.hpp" 48 #include "dbus/server/dbus_object.hpp" 49 #include "dbus/server/dbus_thread_object.hpp" 50 51 #include "ncp/ncp_openthread.hpp" 52 53 namespace otbr { 54 namespace DBus { 55 56 class DBusAgent : public MainloopProcessor, private NonCopyable 57 { 58 public: 59 /** 60 * The constructor of dbus agent. 61 * 62 * @param[in] aNcp A reference to the NCP controller. 63 * 64 */ 65 DBusAgent(otbr::Ncp::ControllerOpenThread &aNcp, Mdns::Publisher &aPublisher); 66 67 /** 68 * This method initializes the dbus agent. 69 * 70 */ 71 void Init(void); 72 73 void Update(MainloopContext &aMainloop) override; 74 void Process(const MainloopContext &aMainloop) override; 75 76 private: 77 using Clock = std::chrono::steady_clock; 78 constexpr static std::chrono::seconds kDBusWaitAllowance = std::chrono::seconds(30); 79 80 using UniqueDBusConnection = std::unique_ptr<DBusConnection, std::function<void(DBusConnection *)>>; 81 82 static dbus_bool_t AddDBusWatch(struct DBusWatch *aWatch, void *aContext); 83 static void RemoveDBusWatch(struct DBusWatch *aWatch, void *aContext); 84 UniqueDBusConnection PrepareDBusConnection(void); 85 86 static const struct timeval kPollTimeout; 87 88 std::string mInterfaceName; 89 std::unique_ptr<DBusThreadObject> mThreadObject; 90 UniqueDBusConnection mConnection; 91 otbr::Ncp::ControllerOpenThread &mNcp; 92 Mdns::Publisher &mPublisher; 93 94 /** 95 * This map is used to track DBusWatch-es. 96 * 97 */ 98 std::set<DBusWatch *> mWatches; 99 }; 100 101 } // namespace DBus 102 } // namespace otbr 103 104 #endif // OTBR_DBUS_AGENT_HPP_ 105