IONotifier.h
1 /*
2  * Copyright (C) 2006-2018 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_IONotifier_h
30 #define Pt_System_IONotifier_h
31 
32 #include <Pt/System/Api.h>
33 #include <Pt/System/IOError.h>
34 #include <Pt/System/Selectable.h>
35 #include <Pt/Types.h>
36 #include <Pt/Signal.h>
37 
38 namespace Pt {
39 
40 namespace System {
41 
59 class PT_SYSTEM_API IONotifier : public Selectable
60 {
61  public:
62  enum WaitFlags
63  {
64  Read = 1,
65  Write = 2,
66  Except = 4
67  };
68 
69  public:
73 
76  explicit IONotifier(void* handle);
77 
80  explicit IONotifier(int fd);
81 
85 
88  void reset();
89 
92  void setFd(int fd);
93 
96  void setHandle(void* handle);
97 
100  void beginWait(int flags);
101 
104  int endWait();
105 
109  { return _eventReady; }
110 
113  EventLoop* loop() const
114  { return _loop; }
115 
116  protected:
117  virtual void onAttach(EventLoop& loop);
118 
119  virtual void onDetach(EventLoop& loop);
120 
121  virtual void onCancel();
122 
123  virtual bool onRun();
124 
125  private:
126  class IONotifierImpl* _impl;
127  EventLoop* _loop;
128  bool _isWaiting;
129  Pt::Signal<> _eventReady;
130 };
131 
132 } // namespace System
133 
134 } // namespace Pt
135 
136 #endif // Pt_System_IODevice_h
Core module.
Definition: Allocator.h:33
virtual void onDetach(EventLoop &loop)
Detached from loop.
virtual void onAttach(EventLoop &loop)
Attached to loop.
virtual void onCancel()
Blocks until operation has cancelled.
Multicast Signal to call multiple slots.
Definition: Signal.h:190
void reset()
Clears the handle or file descriptor.
WaitFlags
Definition: IONotifier.h:63
IONotifier(int fd)
Construct with a file descriptor.
void setHandle(void *handle)
Sets the native handle to monitor.
int endWait()
Ends monitoring and returns the ready flags.
void setFd(int fd)
Sets the file descriptor to monitor.
Operation that runs through an event loop.
Definition: Selectable.h:60
virtual bool onRun()
Check if ready and run.
Monitors a native handle or file descriptor.
Definition: IONotifier.h:60
EventLoop * loop() const
Returns the used event loop.
Definition: IONotifier.h:113
Event loop of a thread or process.
Definition: EventLoop.h:83
IONotifier()
Default constructor.
void beginWait(int flags)
Begins monitoring for flags.
IONotifier(void *handle)
Construct with a native handle.
~IONotifier()
Destructor.
Pt::Signal & eventReady()
Notifies when the handle or descriptor is ready.
Definition: IONotifier.h:108