1 /* 2 * Copyright (c) 2021, 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 mainloop manager. 32 */ 33 34 #ifndef OTBR_COMMON_MAINLOOP_MANAGER_HPP_ 35 #define OTBR_COMMON_MAINLOOP_MANAGER_HPP_ 36 37 #include <openthread-br/config.h> 38 39 #include <openthread/openthread-system.h> 40 41 #include <list> 42 43 #include "common/code_utils.hpp" 44 #include "common/mainloop.hpp" 45 #include "ncp/ncp_openthread.hpp" 46 47 namespace otbr { 48 49 /** 50 * This class implements the mainloop manager. 51 * 52 */ 53 class MainloopManager : private NonCopyable 54 { 55 public: 56 /** 57 * The constructor to initialize the mainloop manager. 58 * 59 */ 60 MainloopManager() = default; 61 62 /** 63 * This method returns the singleton instance of the mainloop manager. 64 * 65 */ GetInstance(void)66 static MainloopManager &GetInstance(void) 67 { 68 static MainloopManager sMainloopManager; 69 return sMainloopManager; 70 } 71 72 /** 73 * This method adds a mainloop processors to the mainloop managger. 74 * 75 * @param[in] aMainloopProcessor A pointer to the mainloop processor. 76 * 77 */ 78 void AddMainloopProcessor(MainloopProcessor *aMainloopProcessor); 79 80 /** 81 * This method removes a mainloop processors from the mainloop managger. 82 * 83 * @param[in] aMainloopProcessor A pointer to the mainloop processor. 84 * 85 */ 86 void RemoveMainloopProcessor(MainloopProcessor *aMainloopProcessor); 87 88 /** 89 * This method updates the mainloop context of all mainloop processors. 90 * 91 * @param[in,out] aMainloop A reference to the mainloop to be updated. 92 * 93 */ 94 void Update(MainloopContext &aMainloop); 95 96 /** 97 * This method processes mainloop events of all mainloop processors. 98 * 99 * @param[in] aMainloop A reference to the mainloop context. 100 * 101 */ 102 void Process(const MainloopContext &aMainloop); 103 104 private: 105 std::list<MainloopProcessor *> mMainloopProcessorList; 106 }; 107 } // namespace otbr 108 #endif // OTBR_COMMON_MAINLOOP_MANAGER_HPP_ 109