From 73ce65a9122dd90fac253802fe20630572fdd4be Mon Sep 17 00:00:00 2001 From: root Date: Sat, 24 Nov 2007 09:48:37 +0000 Subject: document c++ api --- ev++.h | 33 ++++++++++++++++++-- ev.3 | 109 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++-- ev.c | 4 +-- ev.h | 2 +- ev.html | 101 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++--- ev.pod | 106 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++-- 6 files changed, 340 insertions(+), 15 deletions(-) diff --git a/ev++.h b/ev++.h index 82b65b9..0f51bd5 100644 --- a/ev++.h +++ b/ev++.h @@ -1,7 +1,7 @@ #ifndef EVPP_H__ #define EVPP_H__ -/* work in progress, don't use unless you know what you are doing */ +#include "ev.h" namespace ev { @@ -44,8 +44,6 @@ namespace ev { } }; - #include "ev.h" - enum { UNDEF = EV_UNDEF, NONE = EV_NONE, @@ -219,12 +217,15 @@ namespace ev { #endif EV_BEGIN_WATCHER (idle, idle) + void set () { } EV_END_WATCHER (idle, idle) EV_BEGIN_WATCHER (prepare, prepare) + void set () { } EV_END_WATCHER (prepare, prepare) EV_BEGIN_WATCHER (check, check) + void set () { } EV_END_WATCHER (check, check) EV_BEGIN_WATCHER (sig, signal) @@ -259,8 +260,34 @@ namespace ev { } EV_END_WATCHER (child, child) + #if EV_MULTIPLICITY + + EV_BEGIN_WATCHER (embed, embed) + void set (struct ev_loop *loop) + { + int active = is_active (); + if (active) stop (); + ev_embed_set (static_cast(this), loop); + if (active) start (); + } + + void start (struct ev_loop *embedded_loop) + { + set (embedded_loop); + start (); + } + + void sweep () + { + ev_embed_sweep (EV_A_ static_cast(this)); + } + EV_END_WATCHER (embed, embed) + + #endif + #undef EV_CONSTRUCT #undef EV_BEGIN_WATCHER + #undef EV_END_WATCHER } #endif diff --git a/ev.3 b/ev.3 index d9628a2..46ffd2c 100644 --- a/ev.3 +++ b/ev.3 @@ -997,8 +997,8 @@ Periodic watchers are also timers of a kind, but they are very versatile Unlike \f(CW\*(C`ev_timer\*(C'\fR's, they are not based on real time (or relative time) but on wallclock time (absolute time). You can tell a periodic watcher to trigger \*(L"at\*(R" some specific point in time. For example, if you tell a -periodic watcher to trigger in 10 seconds (by specifiying e.g. c) and then reset your system clock to the last year, then it will +periodic watcher to trigger in 10 seconds (by specifiying e.g. \f(CW\*(C`ev_now () ++ 10.\*(C'\fR) and then reset your system clock to the last year, then it will take a year to trigger the event (unlike an \f(CW\*(C`ev_timer\*(C'\fR, which would trigger roughly 10 seconds later and of course not if you reset your system time again). @@ -1434,7 +1434,110 @@ emulate the internals of libevent, so here are some usage hints: .PD .SH "\*(C+ SUPPORT" .IX Header " SUPPORT" -\&\s-1TBD\s0. +Libev comes with some simplistic wrapper classes for \*(C+ that mainly allow +you to use some convinience methods to start/stop watchers and also change +the callback model to a model using method callbacks on objects. +.PP +To use it, +.PP +.Vb 1 +\& #include +.Ve +.PP +(it is not installed by default). This automatically includes \fIev.h\fR +and puts all of its definitions (many of them macros) into the global +namespace. All \*(C+ specific things are put into the \f(CW\*(C`ev\*(C'\fR namespace. +.PP +It should support all the same embedding options as \fIev.h\fR, most notably +\&\f(CW\*(C`EV_MULTIPLICITY\*(C'\fR. +.PP +Here is a list of things available in the \f(CW\*(C`ev\*(C'\fR namespace: +.ie n .IP """ev::READ""\fR, \f(CW""ev::WRITE"" etc." 4 +.el .IP "\f(CWev::READ\fR, \f(CWev::WRITE\fR etc." 4 +.IX Item "ev::READ, ev::WRITE etc." +These are just enum values with the same values as the \f(CW\*(C`EV_READ\*(C'\fR etc. +macros from \fIev.h\fR. +.ie n .IP """ev::tstamp""\fR, \f(CW""ev::now""" 4 +.el .IP "\f(CWev::tstamp\fR, \f(CWev::now\fR" 4 +.IX Item "ev::tstamp, ev::now" +Aliases to the same types/functions as with the \f(CW\*(C`ev_\*(C'\fR prefix. +.ie n .IP """ev::io""\fR, \f(CW""ev::timer""\fR, \f(CW""ev::periodic""\fR, \f(CW""ev::idle""\fR, \f(CW""ev::sig"" etc." 4 +.el .IP "\f(CWev::io\fR, \f(CWev::timer\fR, \f(CWev::periodic\fR, \f(CWev::idle\fR, \f(CWev::sig\fR etc." 4 +.IX Item "ev::io, ev::timer, ev::periodic, ev::idle, ev::sig etc." +For each \f(CW\*(C`ev_TYPE\*(C'\fR watcher in \fIev.h\fR there is a corresponding class of +the same name in the \f(CW\*(C`ev\*(C'\fR namespace, with the exception of \f(CW\*(C`ev_signal\*(C'\fR +which is called \f(CW\*(C`ev::sig\*(C'\fR to avoid clashes with the \f(CW\*(C`signal\*(C'\fR macro +defines by many implementations. +.Sp +All of those classes have these methods: +.RS 4 +.IP "ev::TYPE::TYPE (object *, object::method *)" 4 +.IX Item "ev::TYPE::TYPE (object *, object::method *)" +.PD 0 +.IP "ev::TYPE::TYPE (object *, object::method *, struct ev_loop *)" 4 +.IX Item "ev::TYPE::TYPE (object *, object::method *, struct ev_loop *)" +.IP "ev::TYPE::~TYPE" 4 +.IX Item "ev::TYPE::~TYPE" +.PD +The constructor takes a pointer to an object and a method pointer to +the event handler callback to call in this class. The constructor calls +\&\f(CW\*(C`ev_init\*(C'\fR for you, which means you have to call the \f(CW\*(C`set\*(C'\fR method +before starting it. If you do not specify a loop then the constructor +automatically associates the default loop with this watcher. +.Sp +The destructor automatically stops the watcher if it is active. +.IP "w\->set (struct ev_loop *)" 4 +.IX Item "w->set (struct ev_loop *)" +Associates a different \f(CW\*(C`struct ev_loop\*(C'\fR with this watcher. You can only +do this when the watcher is inactive (and not pending either). +.IP "w\->set ([args])" 4 +.IX Item "w->set ([args])" +Basically the same as \f(CW\*(C`ev_TYPE_set\*(C'\fR, with the same args. Must be +called at least once. Unlike the C counterpart, an active watcher gets +automatically stopped and restarted. +.IP "w\->start ()" 4 +.IX Item "w->start ()" +Starts the watcher. Note that there is no \f(CW\*(C`loop\*(C'\fR argument as the +constructor already takes the loop. +.IP "w\->stop ()" 4 +.IX Item "w->stop ()" +Stops the watcher if it is active. Again, no \f(CW\*(C`loop\*(C'\fR argument. +.ie n .IP "w\->again () ""ev::timer""\fR, \f(CW""ev::periodic"" only" 4 +.el .IP "w\->again () \f(CWev::timer\fR, \f(CWev::periodic\fR only" 4 +.IX Item "w->again () ev::timer, ev::periodic only" +For \f(CW\*(C`ev::timer\*(C'\fR and \f(CW\*(C`ev::periodic\*(C'\fR, this invokes the corresponding +\&\f(CW\*(C`ev_TYPE_again\*(C'\fR function. +.ie n .IP "w\->sweep () ""ev::embed"" only" 4 +.el .IP "w\->sweep () \f(CWev::embed\fR only" 4 +.IX Item "w->sweep () ev::embed only" +Invokes \f(CW\*(C`ev_embed_sweep\*(C'\fR. +.RE +.RS 4 +.RE +.PP +Example: Define a class with an \s-1IO\s0 and idle watcher, start one of them in +the constructor. +.PP +.Vb 4 +\& class myclass +\& { +\& ev_io io; void io_cb (ev::io &w, int revents); +\& ev_idle idle void idle_cb (ev::idle &w, int revents); +.Ve +.PP +.Vb 2 +\& myclass (); +\& } +.Ve +.PP +.Vb 6 +\& myclass::myclass (int fd) +\& : io (this, &myclass::io_cb), +\& idle (this, &myclass::idle_cb) +\& { +\& io.start (fd, ev::READ); +\& } +.Ve .SH "AUTHOR" .IX Header "AUTHOR" Marc Lehmann . diff --git a/ev.c b/ev.c index 9c5d42b..1e008e5 100644 --- a/ev.c +++ b/ev.c @@ -1674,7 +1674,7 @@ ev_child_stop (EV_P_ ev_child *w) #if EV_MULTIPLICITY void -ev_embed_loop (EV_P_ ev_embed *w) +ev_embed_sweep (EV_P_ ev_embed *w) { ev_loop (w->loop, EVLOOP_NONBLOCK); } @@ -1687,7 +1687,7 @@ embed_cb (EV_P_ ev_io *io, int revents) if (ev_cb (w)) ev_feed_event (EV_A_ (W)w, EV_EMBED); else - ev_embed_loop (loop, w); + ev_embed_sweep (loop, w); } void diff --git a/ev.h b/ev.h index 00b3baa..0e56875 100644 --- a/ev.h +++ b/ev.h @@ -437,7 +437,7 @@ void ev_child_stop (EV_P_ ev_child *w); /* only supported when loop to be embedded is in fact embeddable */ void ev_embed_start (EV_P_ ev_embed *w); void ev_embed_stop (EV_P_ ev_embed *w); -void ev_embed_loop (EV_P_ ev_embed *w); +void ev_embed_sweep (EV_P_ ev_embed *w); # endif #endif diff --git a/ev.html b/ev.html index b6e3e6e..8c61bc2 100644 --- a/ev.html +++ b/ev.html @@ -6,7 +6,7 @@ - + @@ -879,8 +879,8 @@ inactivity.

Unlike ev_timer's, they are not based on real time (or relative time) but on wallclock time (absolute time). You can tell a periodic watcher to trigger "at" some specific point in time. For example, if you tell a -periodic watcher to trigger in 10 seconds (by specifiying e.g. c<ev_now () -+ 10.>) and then reset your system clock to the last year, then it will +periodic watcher to trigger in 10 seconds (by specifiying e.g. ev_now () ++ 10.) and then reset your system clock to the last year, then it will take a year to trigger the event (unlike an ev_timer, which would trigger roughly 10 seconds later and of course not if you reset your system time again).

@@ -1308,7 +1308,100 @@ to use the libev header file and library.

C++ SUPPORT

Top

-

TBD.

+

Libev comes with some simplistic wrapper classes for C++ that mainly allow +you to use some convinience methods to start/stop watchers and also change +the callback model to a model using method callbacks on objects.

+

To use it,

+
  #include <ev++.h>
+
+
+

(it is not installed by default). This automatically includes ev.h +and puts all of its definitions (many of them macros) into the global +namespace. All C++ specific things are put into the ev namespace.

+

It should support all the same embedding options as ev.h, most notably +EV_MULTIPLICITY.

+

Here is a list of things available in the ev namespace:

+
+
ev::READ, ev::WRITE etc.
+
+

These are just enum values with the same values as the EV_READ etc. +macros from ev.h.

+
+
ev::tstamp, ev::now
+
+

Aliases to the same types/functions as with the ev_ prefix.

+
+
ev::io, ev::timer, ev::periodic, ev::idle, ev::sig etc.
+
+

For each ev_TYPE watcher in ev.h there is a corresponding class of +the same name in the ev namespace, with the exception of ev_signal +which is called ev::sig to avoid clashes with the signal macro +defines by many implementations.

+

All of those classes have these methods:

+

+

+
ev::TYPE::TYPE (object *, object::method *)
+
ev::TYPE::TYPE (object *, object::method *, struct ev_loop *)
+
ev::TYPE::~TYPE
+
+

The constructor takes a pointer to an object and a method pointer to +the event handler callback to call in this class. The constructor calls +ev_init for you, which means you have to call the set method +before starting it. If you do not specify a loop then the constructor +automatically associates the default loop with this watcher.

+

The destructor automatically stops the watcher if it is active.

+
+
w->set (struct ev_loop *)
+
+

Associates a different struct ev_loop with this watcher. You can only +do this when the watcher is inactive (and not pending either).

+
+
w->set ([args])
+
+

Basically the same as ev_TYPE_set, with the same args. Must be +called at least once. Unlike the C counterpart, an active watcher gets +automatically stopped and restarted.

+
+
w->start ()
+
+

Starts the watcher. Note that there is no loop argument as the +constructor already takes the loop.

+
+
w->stop ()
+
+

Stops the watcher if it is active. Again, no loop argument.

+
+
w->again () ev::timer, ev::periodic only
+
+

For ev::timer and ev::periodic, this invokes the corresponding +ev_TYPE_again function.

+
+
w->sweep () ev::embed only
+
+

Invokes ev_embed_sweep.

+
+
+

+
+
+

Example: Define a class with an IO and idle watcher, start one of them in +the constructor.

+
  class myclass
+  {
+    ev_io   io;   void io_cb   (ev::io   &w, int revents);
+    ev_idle idle  void idle_cb (ev::idle &w, int revents);
+
+    myclass ();
+  }
+
+  myclass::myclass (int fd)
+  : io   (this, &myclass::io_cb),
+    idle (this, &myclass::idle_cb)
+  {
+    io.start (fd, ev::READ);
+  }
+
+

AUTHOR

Top

diff --git a/ev.pod b/ev.pod index 0bb2074..5440be5 100644 --- a/ev.pod +++ b/ev.pod @@ -858,7 +858,7 @@ Periodic watchers are also timers of a kind, but they are very versatile Unlike C's, they are not based on real time (or relative time) but on wallclock time (absolute time). You can tell a periodic watcher to trigger "at" some specific point in time. For example, if you tell a -periodic watcher to trigger in 10 seconds (by specifiying e.g. c) and then reset your system clock to the last year, then it will take a year to trigger the event (unlike an C, which would trigger roughly 10 seconds later and of course not if you reset your system time @@ -1312,7 +1312,109 @@ to use the libev header file and library. =head1 C++ SUPPORT -TBD. +Libev comes with some simplistic wrapper classes for C++ that mainly allow +you to use some convinience methods to start/stop watchers and also change +the callback model to a model using method callbacks on objects. + +To use it, + + #include + +(it is not installed by default). This automatically includes F +and puts all of its definitions (many of them macros) into the global +namespace. All C++ specific things are put into the C namespace. + +It should support all the same embedding options as F, most notably +C. + +Here is a list of things available in the C namespace: + +=over 4 + +=item C, C etc. + +These are just enum values with the same values as the C etc. +macros from F. + +=item C, C + +Aliases to the same types/functions as with the C prefix. + +=item C, C, C, C, C etc. + +For each C watcher in F there is a corresponding class of +the same name in the C namespace, with the exception of C +which is called C to avoid clashes with the C macro +defines by many implementations. + +All of those classes have these methods: + +=over 4 + +=item ev::TYPE::TYPE (object *, object::method *) + +=item ev::TYPE::TYPE (object *, object::method *, struct ev_loop *) + +=item ev::TYPE::~TYPE + +The constructor takes a pointer to an object and a method pointer to +the event handler callback to call in this class. The constructor calls +C for you, which means you have to call the C method +before starting it. If you do not specify a loop then the constructor +automatically associates the default loop with this watcher. + +The destructor automatically stops the watcher if it is active. + +=item w->set (struct ev_loop *) + +Associates a different C with this watcher. You can only +do this when the watcher is inactive (and not pending either). + +=item w->set ([args]) + +Basically the same as C, with the same args. Must be +called at least once. Unlike the C counterpart, an active watcher gets +automatically stopped and restarted. + +=item w->start () + +Starts the watcher. Note that there is no C argument as the +constructor already takes the loop. + +=item w->stop () + +Stops the watcher if it is active. Again, no C argument. + +=item w->again () C, C only + +For C and C, this invokes the corresponding +C function. + +=item w->sweep () C only + +Invokes C. + +=back + +=back + +Example: Define a class with an IO and idle watcher, start one of them in +the constructor. + + class myclass + { + ev_io io; void io_cb (ev::io &w, int revents); + ev_idle idle void idle_cb (ev::idle &w, int revents); + + myclass (); + } + + myclass::myclass (int fd) + : io (this, &myclass::io_cb), + idle (this, &myclass::idle_cb) + { + io.start (fd, ev::READ); + } =head1 AUTHOR -- cgit v1.2.3