gvpe/src/iom.h

/*
    iom.h -- generic I/O multiplexer
    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

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->empty ())
      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:
#if IOM_TIME
  // fetch time only
  static tstamp now ();

  // set NOW
  static void set_now ();
#endif

  // 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.26
Committed:	Wed Dec 15 02:59:55 2004 UTC (19 years, 5 months ago) by pcg
Content type:	text/plain
Branch:	MAIN
CVS Tags:	rel-1_7
Changes since 1.25:	+8 -0 lines
Log Message:	* empty log message *
#	User	Rev	Content
1	pcg	1.1	/*
2	pcg	1.24	iom.h -- generic I/O multiplexer
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.1
47	pcg	1.2	typedef double tstamp;
48			extern tstamp NOW;
49	pcg	1.1
50	pcg	1.15	struct watcher;
51			#if IOM_IO
52	pcg	1.1	struct io_watcher;
53	pcg	1.15	#endif
54			#if IOM_TIME
55	pcg	1.1	struct time_watcher;
56	pcg	1.15	#endif
57			#if IOM_CHECK
58			struct check_watcher;
59			#endif
60			#if IOM_IDLE
61			struct idle_watcher;
62			#endif
63	pcg	1.19	#if IOM_SIG
64			struct sig_watcher;
65			#endif
66	pcg	1.15
67			template<class watcher>
68	pcg	1.18	struct io_manager_vec : vector<watcher *> {
69	pcg	1.15	void erase_unordered (unsigned int pos)
70			{
71	pcg	1.20	watcher w = (this)[this->size () - 1];
72			this->pop_back ();
73	pcg	1.15
74	pcg	1.23	if (!this->empty ())
75	pcg	1.22	if (((*this)[pos] = w)) // '=' is correct!
76	pcg	1.15	w->active = pos + 1;
77			}
78			};
79	pcg	1.1
80	pcg	1.21	// only used as a namespace, and for initialisation purposes
81	pcg	1.1	class io_manager {
82	pcg	1.15	template<class watcher>
83	pcg	1.21	static void reg (watcher &w, io_manager_vec<watcher> &queue);
84	pcg	1.1
85	pcg	1.15	template<class watcher>
86	pcg	1.21	static void unreg (watcher &w, io_manager_vec<watcher> &queue);
87	pcg	1.6
88	pcg	1.15	public:
89	pcg	1.26	#if IOM_TIME
90			// fetch time only
91			static tstamp now ();
92
93			// set NOW
94			static void set_now ();
95			#endif
96
97	pcg	1.1	// register a watcher
98	pcg	1.15	#if IOM_IO
99	pcg	1.21	static void reg (io_watcher &w); static void unreg (io_watcher &w);
100	pcg	1.15	#endif
101			#if IOM_TIME
102	pcg	1.21	static void reg (time_watcher &w); static void unreg (time_watcher &w);
103	pcg	1.15	#endif
104			#if IOM_CHECK
105	pcg	1.21	static void reg (check_watcher &w); static void unreg (check_watcher &w);
106	pcg	1.15	#endif
107			#if IOM_IDLE
108	pcg	1.21	static void reg (idle_watcher &w); static void unreg (idle_watcher &w);
109	pcg	1.15	#endif
110	pcg	1.19	#if IOM_SIG
111	pcg	1.21	static void reg (sig_watcher &w); static void unreg (sig_watcher &w);
112	pcg	1.19	#endif
113	pcg	1.1
114	pcg	1.21	static void loop ();
115	pcg	1.1	};
116
117	pcg	1.15	struct watcher {
118			int active; /* 0 == inactive, else index into respective vector */
119
120	pcg	1.19	watcher () : active (0) { }
121	pcg	1.15	};
122
123			#if IOM_IO
124			enum { EVENT_READ = 1, EVENT_WRITE = 2 };
125
126			struct io_watcher : watcher, callback2<void, io_watcher &, short> {
127	pcg	1.12	int fd;
128			short events;
129	pcg	1.10
130	pcg	1.15	void set (int fd_, short events_) { fd = fd_; events = events_; }
131
132			void set (short events_) { set (fd, events_); }
133	pcg	1.21	void start () { io_manager::reg (*this); }
134			void start (int fd_, short events_) { set (fd_, events_); io_manager::reg (*this); }
135			void stop () { io_manager::unreg (*this); }
136	pcg	1.15
137	pcg	1.1	template<class O1, class O2>
138	pcg	1.19	io_watcher (O1 object, void (O2::method) (io_watcher &, short))
139			: callback2<void, io_watcher &, short> (object,method)
140	pcg	1.15	{ }
141			~io_watcher () { stop (); }
142			};
143			#endif
144
145			#if IOM_TIME
146			struct time_watcher : watcher, callback1<void, time_watcher &> {
147			tstamp at;
148	pcg	1.2
149	pcg	1.15	void trigger ();
150	pcg	1.11
151	pcg	1.15	void set (tstamp when) { at = when; }
152	pcg	1.19	void operator () () { trigger (); }
153	pcg	1.21	void start () { io_manager::reg (*this); }
154			void start (tstamp when) { set (when); io_manager::reg (*this); }
155			void stop () { io_manager::unreg (*this); }
156	pcg	1.6
157	pcg	1.15	template<class O1, class O2>
158	pcg	1.19	time_watcher (O1 object, void (O2::method) (time_watcher &))
159			: callback1<void, time_watcher &> (object,method), at (0)
160	pcg	1.15	{ }
161			~time_watcher () { stop (); }
162			};
163			#endif
164	pcg	1.11
165	pcg	1.15	#if IOM_CHECK
166			// run before checking for new events
167			struct check_watcher : watcher, callback1<void, check_watcher &> {
168	pcg	1.21	void start () { io_manager::reg (*this); }
169			void stop () { io_manager::unreg (*this); }
170	pcg	1.1
171	pcg	1.15	template<class O1, class O2>
172	pcg	1.19	check_watcher (O1 object, void (O2::method) (check_watcher &))
173			: callback1<void, check_watcher &> (object,method)
174	pcg	1.15	{ }
175			~check_watcher () { stop (); }
176	pcg	1.1	};
177	pcg	1.15	#endif
178	pcg	1.1
179	pcg	1.15	#if IOM_IDLE
180			// run after checking for any i/o, but before waiting
181			struct idle_watcher : watcher, callback1<void, idle_watcher &> {
182	pcg	1.21	void start () { io_manager::reg (*this); }
183			void stop () { io_manager::unreg (*this); }
184	pcg	1.2
185			template<class O1, class O2>
186	pcg	1.19	idle_watcher (O1 object, void (O2::method) (idle_watcher &))
187			: callback1<void, idle_watcher &> (object,method)
188	pcg	1.2	{ }
189	pcg	1.15	~idle_watcher () { stop (); }
190	pcg	1.19	};
191			#endif
192
193			#if IOM_SIG
194			struct sig_watcher : watcher, callback1<void, sig_watcher &> {
195			int signum;
196
197			void start (int signum);
198	pcg	1.21	void stop () { io_manager::unreg (*this); }
199	pcg	1.19
200			template<class O1, class O2>
201			sig_watcher (O1 object, void (O2::method) (sig_watcher &))
202			: callback1<void, sig_watcher &> (object,method), signum (-1)
203			{ }
204			~sig_watcher () { stop (); }
205	pcg	1.1	};
206	pcg	1.15	#endif
207	pcg	1.1
208			#endif
209