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 the mainloop events and manager.
32  */
33 
34 #ifndef OT_POSIX_PLATFORM_MAINLOOP_HPP_
35 #define OT_POSIX_PLATFORM_MAINLOOP_HPP_
36 
37 #include <openthread/openthread-system.h>
38 
39 namespace ot {
40 namespace Posix {
41 namespace Mainloop {
42 
43 /**
44  * Is the base for all mainloop event sources.
45  *
46  */
47 class Source
48 {
49     friend class Manager;
50 
51 public:
52     /**
53      * Registers events in the mainloop.
54      *
55      * @param[in,out]   aContext    A reference to the mainloop context.
56      *
57      */
58     virtual void Update(otSysMainloopContext &aContext) = 0;
59 
60     /**
61      * Processes the mainloop events.
62      *
63      * @param[in]   aContext    A reference to the mainloop context.
64      *
65      */
66     virtual void Process(const otSysMainloopContext &aContext) = 0;
67 
68     /**
69      * Marks destructor virtual method.
70      *
71      */
72     virtual ~Source() = default;
73 
74 private:
75     Source *mNext = nullptr;
76 };
77 
78 /**
79  * Manages mainloop.
80  *
81  */
82 class Manager
83 {
84 public:
85     /**
86      * Updates event polls in the mainloop context.
87      *
88      * @param[in,out]   aContext    A reference to the mainloop context.
89      *
90      */
91     void Update(otSysMainloopContext &aContext);
92 
93     /**
94      * Processes events in the mainloop context.
95      *
96      * @param[in]   aContext    A reference to the mainloop context.
97      *
98      */
99     void Process(const otSysMainloopContext &aContext);
100 
101     /**
102      * Adds a new event source into the mainloop.
103      *
104      * @param[in]   aSource     A reference to the event source.
105      *
106      */
107     void Add(Source &aSource);
108 
109     /**
110      * Removes an event source from the mainloop.
111      *
112      * @param[in]   aSource     A reference to the event source.
113      *
114      */
115     void Remove(Source &aSource);
116 
117     /**
118      * Returns the Mainloop singleton.
119      *
120      * @returns A reference to the Mainloop singleton.
121      *
122      */
123     static Manager &Get(void);
124 
125 private:
126     Source *mSources = nullptr;
127 };
128 
129 } // namespace Mainloop
130 } // namespace Posix
131 } // namespace ot
132 #endif // OT_POSIX_PLATFORM_MAINLOOP_HPP_
133