MainLoop.h
1 /*
2  * Copyright (C) 2006-2010 Marc Boris Duerner
3  *
4  * This library is free software; you can redistribute it and/or
5  * modify it under the terms of the GNU Lesser General Public
6  * License as published by the Free Software Foundation; either
7  * version 2.1 of the License, or (at your option) any later version.
8  *
9  * As a special exception, you may use this file as part of a free
10  * software library without restriction. Specifically, if other files
11  * instantiate templates or use macros or inline functions from this
12  * file, or you compile this file and link it with other files to
13  * produce an executable, this file does not by itself cause the
14  * resulting executable to be covered by the GNU General Public
15  * License. This exception does not however invalidate any other
16  * reasons why the executable file might be covered by the GNU Library
17  * General Public License.
18  *
19  * This library is distributed in the hope that it will be useful,
20  * but WITHOUT ANY WARRANTY; without even the implied warranty of
21  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
22  * Lesser General Public License for more details.
23  *
24  * You should have received a copy of the GNU Lesser General Public
25  * License along with this library; if not, write to the Free Software
26  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
27  */
28 
29 #ifndef PT_SYSTEM_MAINLOOP_H
30 #define PT_SYSTEM_MAINLOOP_H
31 
32 #include <Pt/System/Api.h>
33 #include <Pt/System/EventLoop.h>
34 
35 namespace Pt {
36 
37 namespace System {
38 
39 class MainLoopImpl;
40 
66 class PT_SYSTEM_API MainLoop : public EventLoop
67 {
68  public:
72 
76 
79  virtual ~MainLoop();
80 
82  Selector& selector();
83 
85  bool waitNext();
86 
87  MainLoopImpl* impl()
88  { return _impl; }
89 
90  protected:
91  virtual void onAttachSelectable(Selectable&);
92 
93  virtual void onDetachSelectable(Selectable&);
94 
95  virtual void onCancel(Selectable& s);
96 
97  virtual void onReady(Selectable& s);
98 
99  virtual void onRun();
100 
101  virtual void onExit();
102 
103  virtual void onCommitEvent(const Event& ev);
104 
105  virtual void onQueueEvent(const Event& ev);
106 
107  virtual void onWake();
108 
109  virtual void onProcessEvents();
110 
111  virtual void onAttachTimer(Timer& timer);
112 
113  virtual void onDetachTimer(Timer& timer);
114 
115  private:
116  MainLoopImpl* _impl;
117 };
118 
119 } // namespace System
120 
121 } // namespace Pt
122 
123 #endif // PT_SYSTEM_MAINLOOP_H
Core module.
Definition: Allocator.h:33
Base class for all event types.
Definition: Event.h:50
Notifies clients in constant intervals.
Definition: Timer.h:73
MainLoop()
Default Constructor.
virtual ~MainLoop()
Destructor.
virtual void onCommitEvent(const Event &ev)
Queues an event and triggers event processing.
virtual void onQueueEvent(const Event &ev)
Only queues an event.
MainLoop(Allocator &a)
Construct with allocator.
virtual void onWake()
Triggers event processing.
Dispatches operations through an event loop.
Definition: Selectable.h:45
Allocator interface.
Definition: Allocator.h:82
Thread-safe event loop supporting I/O multiplexing and Timers.
Definition: EventLoop.h:74
Thread-safe event loop supporting I/O multiplexing and Timers.
Definition: MainLoop.h:67