1 /* 2 * Copyright (c) 2019, 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 processor. 32 */ 33 34 #ifndef OTBR_COMMON_OTBR_MAINLOOP_HPP_ 35 #define OTBR_COMMON_OTBR_MAINLOOP_HPP_ 36 37 #include <openthread-br/config.h> 38 39 #include <openthread/openthread-system.h> 40 41 namespace otbr { 42 43 /** 44 * This type defines the context data for running a mainloop. 45 * 46 */ 47 using MainloopContext = otSysMainloopContext; 48 49 /** 50 * This abstract class defines the interface of a mainloop processor 51 * which adds fds to the mainloop context and handles fds events. 52 * 53 */ 54 class MainloopProcessor 55 { 56 public: 57 MainloopProcessor(void); 58 59 virtual ~MainloopProcessor(void); 60 61 /** 62 * This method updates the mainloop context. 63 * 64 * @param[in,out] aMainloop A reference to the mainloop to be updated. 65 * 66 */ 67 virtual void Update(MainloopContext &aMainloop) = 0; 68 69 /** 70 * This method processes mainloop events. 71 * 72 * @param[in] aMainloop A reference to the mainloop context. 73 * 74 */ 75 virtual void Process(const MainloopContext &aMainloop) = 0; 76 }; 77 78 } // namespace otbr 79 80 #endif // OTBR_COMMON_OTBR_MAINLOOP_HPP_ 81