Selectable.h
1 /*
2  * Copyright (C) 2008-2013 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_SELECTABLE_H
30 #define PT_SELECTABLE_H
31 
32 #include <Pt/System/Api.h>
33 #include <Pt/NonCopyable.h>
34 
35 namespace Pt {
36 
37 namespace System {
38 
39 class EventLoop;
40 class SelectableList;
41 
44 class PT_SYSTEM_API Selectable : protected NonCopyable
45 {
46  friend class SelectableList;
47 
48  public:
50  virtual ~Selectable();
51 
53  void setActive(EventLoop& parent);
54 
56  void detach();
57 
59  void cancel();
60 
62  bool run();
63 
65  EventLoop* parent() const
66  { return _parent; }
67 
69  Selectable* next()
70  { return _next; }
71 
72  protected:
75 
78  void post();
79 
81  virtual void onAttach(EventLoop& loop) = 0;
82 
84  virtual void onDetach(EventLoop& loop) = 0;
85 
87  virtual void onCancel() = 0;
88 
90  virtual bool onRun() = 0;
91 
92  private:
93  EventLoop* _parent;
94  Selectable* _prev;
95  Selectable* _next;
96 };
97 
98 } // namespace System
99 
100 } // namespace Pt
101 
102 #endif // PT_SELECTABLE_H
Core module.
Definition: pt-gfx-images.dox:14
EventLoop * parent() const
Returns the used event loop.
Definition: Selectable.h:65
virtual void onDetach(EventLoop &loop)=0
Detached from loop.
void detach()
Remove from event loop and cancels outstanding operations.
void cancel()
Cancels all operations.
virtual bool onRun()=0
Check if ready and run.
Selectable()
Default Constructor.
virtual void onCancel()=0
Blocks until operation has cancelled.
virtual void onAttach(EventLoop &loop)=0
Attached to loop.
Dispatches operations through an event loop.
Definition: Selectable.h:45
virtual ~Selectable()
Destructor.
Thread-safe event loop supporting I/O multiplexing and Timers.
Definition: EventLoop.h:74
bool run()
Run operation if it is ready.
Protects derived classes from being copied.
Definition: NonCopyable.h:54
void post()
Posts this selectable to its event loop from any thread.
void setActive(EventLoop &parent)
Sets the parent loop, so that operations can be run.