gvpe/src/iom.h

/*
    iom.h -- generic I/O multiplexor
    Copyright (C) 2003, 2004 Marc Lehmann <pcg@goof.com>
 
    This program is free software; you can redistribute it and/or modify
    it under the terms of the GNU General Public License as published by
    the Free Software Foundation; either version 2 of the License, or
    (at your option) any later version.
 
    This program is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    GNU General Public License for more details.
 
    You should have received a copy of the GNU General Public License
    along with this program; if not, write to the Free Software
    Foundation, Inc. 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
*/

#ifndef IOM_H__
#define IOM_H__

// required:
// - a vector template like simplevec or stl's vector
// - defines for all watcher types required in your app
// edit iom_conf.h as appropriate.
#include "iom_conf.h"

#include "callback.h"

#ifndef IOM_IO
# define IOM_IO 0
#endif
#ifndef IOM_TIME
# define IOM_TIME 0
#endif
#ifndef IOM_CHECK
# define IOM_CHECK 0
#endif
#ifndef IOM_IDLE
# define IOM_IDLE 0
#endif
#ifndef IOM_SIG
# define IOM_SIG 0
#endif
#ifndef IOM_ACCURACY
# define IOM_ACCURACY 0.001 // start timers at most this much earlier (can be 0)
#endif

typedef double tstamp;
extern tstamp NOW;

struct watcher;
#if IOM_IO
struct io_watcher;
#endif
#if IOM_TIME
struct time_watcher;
#endif
#if IOM_CHECK
struct check_watcher;
#endif
#if IOM_IDLE
struct idle_watcher;
#endif
#if IOM_SIG
struct sig_watcher;
#endif

template<class watcher>
struct io_manager_vec : vector<watcher *> {
  void erase_unordered (unsigned int pos)
  {
    watcher *w = (*this)[this->size () - 1];
    this->pop_back ();

    if (this->size ())
      if (((*this)[pos] = w)) // '=' is correct!
        w->active = pos + 1;
  }
};

// only used as a namespace, and for initialisation purposes
class io_manager {
  template<class watcher>
  static void reg (watcher &w, io_manager_vec<watcher> &queue);

  template<class watcher>
  static void unreg (watcher &w, io_manager_vec<watcher> &queue);

public:
  // register a watcher
#if IOM_IO
  static void reg (io_watcher    &w); static void unreg (io_watcher    &w);
#endif
#if IOM_TIME
  static void reg (time_watcher  &w); static void unreg (time_watcher  &w);
#endif
#if IOM_CHECK
  static void reg (check_watcher &w); static void unreg (check_watcher &w);
#endif
#if IOM_IDLE
  static void reg (idle_watcher  &w); static void unreg (idle_watcher  &w);
#endif
#if IOM_SIG
  static void reg (sig_watcher   &w); static void unreg (sig_watcher   &w);
#endif
  
  static void loop ();
};

struct watcher {
  int active; /* 0 == inactive, else index into respective vector */

  watcher () : active (0) { }
};

#if IOM_IO
enum { EVENT_READ = 1, EVENT_WRITE = 2 };

struct io_watcher : watcher, callback2<void, io_watcher &, short> {
  int fd;
  short events;

  void set (int fd_, short events_) { fd = fd_; events = events_; }

  void set (short events_) { set (fd, events_); }
  void start () { io_manager::reg (*this); }
  void start (int fd_, short events_) { set (fd_, events_); io_manager::reg (*this); }
  void stop () { io_manager::unreg (*this); }

  template<class O1, class O2>
  io_watcher (O1 *object, void (O2::*method) (io_watcher &, short))
  : callback2<void, io_watcher &, short> (object,method)
  { }
  ~io_watcher () { stop (); }
};
#endif

#if IOM_TIME
struct time_watcher : watcher, callback1<void, time_watcher &> {
  tstamp at;

  void trigger ();

  void set (tstamp when) { at = when; }
  void operator () () { trigger (); }
  void start () { io_manager::reg (*this); }
  void start (tstamp when) { set (when); io_manager::reg (*this); }
  void stop () { io_manager::unreg (*this); }

  template<class O1, class O2>
  time_watcher (O1 *object, void (O2::*method) (time_watcher &))
  : callback1<void, time_watcher &> (object,method), at (0)
  { }
  ~time_watcher () { stop (); }
};
#endif

#if IOM_CHECK
// run before checking for new events
struct check_watcher : watcher, callback1<void, check_watcher &> {
  void start () { io_manager::reg (*this); }
  void stop () { io_manager::unreg (*this); }

  template<class O1, class O2>
  check_watcher (O1 *object, void (O2::*method) (check_watcher &))
  : callback1<void, check_watcher &> (object,method)
  { }
  ~check_watcher () { stop (); }
};
#endif

#if IOM_IDLE
// run after checking for any i/o, but before waiting
struct idle_watcher : watcher, callback1<void, idle_watcher &> {
  void start () { io_manager::reg (*this); }
  void stop () { io_manager::unreg (*this); }

  template<class O1, class O2>
  idle_watcher (O1 *object, void (O2::*method) (idle_watcher &))
    : callback1<void, idle_watcher &> (object,method)
    { }
  ~idle_watcher () { stop (); }
};
#endif

#if IOM_SIG
struct sig_watcher : watcher, callback1<void, sig_watcher &> {
  int signum;

  void start (int signum);
  void stop () { io_manager::unreg (*this); }

  template<class O1, class O2>
  sig_watcher (O1 *object, void (O2::*method) (sig_watcher &))
  : callback1<void, sig_watcher &> (object,method), signum (-1)
  { }
  ~sig_watcher () { stop (); }
};
#endif

#endif

Revision:	1.22
Committed:	Thu Nov 11 17:41:55 2004 UTC (21 years, 11 months ago) by pcg
Content type:	text/plain
Branch:	MAIN
Changes since 1.21:	+4 -5 lines
Log Message:	* empty log message *
#	User	Rev	Content
1	pcg	1.1	/*
2	pcg	1.14	iom.h -- generic I/O multiplexor
3	pcg	1.15	Copyright (C) 2003, 2004 Marc Lehmann <pcg@goof.com>
4	pcg	1.1
5			This program is free software; you can redistribute it and/or modify
6			it under the terms of the GNU General Public License as published by
7			the Free Software Foundation; either version 2 of the License, or
8			(at your option) any later version.
9
10			This program is distributed in the hope that it will be useful,
11			but WITHOUT ANY WARRANTY; without even the implied warranty of
12			MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13			GNU General Public License for more details.
14
15			You should have received a copy of the GNU General Public License
16			along with this program; if not, write to the Free Software
17			Foundation, Inc. 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
18			*/
19
20	pcg	1.15	#ifndef IOM_H__
21			#define IOM_H__
22	pcg	1.1
23	pcg	1.15	// required:
24			// - a vector template like simplevec or stl's vector
25			// - defines for all watcher types required in your app
26			// edit iom_conf.h as appropriate.
27			#include "iom_conf.h"
28	pcg	1.1
29	pcg	1.15	#include "callback.h"
30	pcg	1.1
31	pcg	1.15	#ifndef IOM_IO
32			# define IOM_IO 0
33			#endif
34			#ifndef IOM_TIME
35			# define IOM_TIME 0
36			#endif
37			#ifndef IOM_CHECK
38			# define IOM_CHECK 0
39			#endif
40			#ifndef IOM_IDLE
41			# define IOM_IDLE 0
42			#endif
43	pcg	1.19	#ifndef IOM_SIG
44			# define IOM_SIG 0
45			#endif
46	pcg	1.22	#ifndef IOM_ACCURACY
47			# define IOM_ACCURACY 0.001 // start timers at most this much earlier (can be 0)
48			#endif
49	pcg	1.1
50	pcg	1.2	typedef double tstamp;
51			extern tstamp NOW;
52	pcg	1.1
53	pcg	1.15	struct watcher;
54			#if IOM_IO
55	pcg	1.1	struct io_watcher;
56	pcg	1.15	#endif
57			#if IOM_TIME
58	pcg	1.1	struct time_watcher;
59	pcg	1.15	#endif
60			#if IOM_CHECK
61			struct check_watcher;
62			#endif
63			#if IOM_IDLE
64			struct idle_watcher;
65			#endif
66	pcg	1.19	#if IOM_SIG
67			struct sig_watcher;
68			#endif
69	pcg	1.15
70			template<class watcher>
71	pcg	1.18	struct io_manager_vec : vector<watcher *> {
72	pcg	1.15	void erase_unordered (unsigned int pos)
73			{
74	pcg	1.20	watcher w = (this)[this->size () - 1];
75			this->pop_back ();
76	pcg	1.15
77	pcg	1.20	if (this->size ())
78	pcg	1.22	if (((*this)[pos] = w)) // '=' is correct!
79	pcg	1.15	w->active = pos + 1;
80			}
81			};
82	pcg	1.1
83	pcg	1.21	// only used as a namespace, and for initialisation purposes
84	pcg	1.1	class io_manager {
85	pcg	1.15	template<class watcher>
86	pcg	1.21	static void reg (watcher &w, io_manager_vec<watcher> &queue);
87	pcg	1.1
88	pcg	1.15	template<class watcher>
89	pcg	1.21	static void unreg (watcher &w, io_manager_vec<watcher> &queue);
90	pcg	1.6
91	pcg	1.15	public:
92	pcg	1.1	// register a watcher
93	pcg	1.15	#if IOM_IO
94	pcg	1.21	static void reg (io_watcher &w); static void unreg (io_watcher &w);
95	pcg	1.15	#endif
96			#if IOM_TIME
97	pcg	1.21	static void reg (time_watcher &w); static void unreg (time_watcher &w);
98	pcg	1.15	#endif
99			#if IOM_CHECK
100	pcg	1.21	static void reg (check_watcher &w); static void unreg (check_watcher &w);
101	pcg	1.15	#endif
102			#if IOM_IDLE
103	pcg	1.21	static void reg (idle_watcher &w); static void unreg (idle_watcher &w);
104	pcg	1.15	#endif
105	pcg	1.19	#if IOM_SIG
106	pcg	1.21	static void reg (sig_watcher &w); static void unreg (sig_watcher &w);
107	pcg	1.19	#endif
108	pcg	1.1
109	pcg	1.21	static void loop ();
110	pcg	1.1	};
111
112	pcg	1.15	struct watcher {
113			int active; /* 0 == inactive, else index into respective vector */
114
115	pcg	1.19	watcher () : active (0) { }
116	pcg	1.15	};
117
118			#if IOM_IO
119			enum { EVENT_READ = 1, EVENT_WRITE = 2 };
120
121			struct io_watcher : watcher, callback2<void, io_watcher &, short> {
122	pcg	1.12	int fd;
123			short events;
124	pcg	1.10
125	pcg	1.15	void set (int fd_, short events_) { fd = fd_; events = events_; }
126
127			void set (short events_) { set (fd, events_); }
128	pcg	1.21	void start () { io_manager::reg (*this); }
129			void start (int fd_, short events_) { set (fd_, events_); io_manager::reg (*this); }
130			void stop () { io_manager::unreg (*this); }
131	pcg	1.15
132	pcg	1.1	template<class O1, class O2>
133	pcg	1.19	io_watcher (O1 object, void (O2::method) (io_watcher &, short))
134			: callback2<void, io_watcher &, short> (object,method)
135	pcg	1.15	{ }
136			~io_watcher () { stop (); }
137			};
138			#endif
139
140			#if IOM_TIME
141			struct time_watcher : watcher, callback1<void, time_watcher &> {
142			tstamp at;
143	pcg	1.2
144	pcg	1.15	void trigger ();
145	pcg	1.11
146	pcg	1.15	void set (tstamp when) { at = when; }
147	pcg	1.19	void operator () () { trigger (); }
148	pcg	1.21	void start () { io_manager::reg (*this); }
149			void start (tstamp when) { set (when); io_manager::reg (*this); }
150			void stop () { io_manager::unreg (*this); }
151	pcg	1.6
152	pcg	1.15	template<class O1, class O2>
153	pcg	1.19	time_watcher (O1 object, void (O2::method) (time_watcher &))
154			: callback1<void, time_watcher &> (object,method), at (0)
155	pcg	1.15	{ }
156			~time_watcher () { stop (); }
157			};
158			#endif
159	pcg	1.11
160	pcg	1.15	#if IOM_CHECK
161			// run before checking for new events
162			struct check_watcher : watcher, callback1<void, check_watcher &> {
163	pcg	1.21	void start () { io_manager::reg (*this); }
164			void stop () { io_manager::unreg (*this); }
165	pcg	1.1
166	pcg	1.15	template<class O1, class O2>
167	pcg	1.19	check_watcher (O1 object, void (O2::method) (check_watcher &))
168			: callback1<void, check_watcher &> (object,method)
169	pcg	1.15	{ }
170			~check_watcher () { stop (); }
171	pcg	1.1	};
172	pcg	1.15	#endif
173	pcg	1.1
174	pcg	1.15	#if IOM_IDLE
175			// run after checking for any i/o, but before waiting
176			struct idle_watcher : watcher, callback1<void, idle_watcher &> {
177	pcg	1.21	void start () { io_manager::reg (*this); }
178			void stop () { io_manager::unreg (*this); }
179	pcg	1.2
180			template<class O1, class O2>
181	pcg	1.19	idle_watcher (O1 object, void (O2::method) (idle_watcher &))
182			: callback1<void, idle_watcher &> (object,method)
183	pcg	1.2	{ }
184	pcg	1.15	~idle_watcher () { stop (); }
185	pcg	1.19	};
186			#endif
187
188			#if IOM_SIG
189			struct sig_watcher : watcher, callback1<void, sig_watcher &> {
190			int signum;
191
192			void start (int signum);
193	pcg	1.21	void stop () { io_manager::unreg (*this); }
194	pcg	1.19
195			template<class O1, class O2>
196			sig_watcher (O1 object, void (O2::method) (sig_watcher &))
197			: callback1<void, sig_watcher &> (object,method), signum (-1)
198			{ }
199			~sig_watcher () { stop (); }
200	pcg	1.1	};
201	pcg	1.15	#endif
202	pcg	1.1
203			#endif
204