tagged 0.6

[software/eventxx.git] / eventxx

diff --git a/eventxx b/eventxx
index 7dd8c48e676cea39dd25a223d31db93a20dfa835..6bf3f9bd7dc6ae2f4d72e7854db1a96593687d54 100644 (file)
--- a/eventxx
+++ b/eventxx
@@ -130,35 +130,33 @@
  *
  * @section Status
  *
- * This library has not been widely used yet, so it lacks proper testing.
- * Because templates are not even compiled when they are not used, don't be
- * surprised if you catch a piece of code that doesn't compile. The library
- * has no support for buffered events yet. It doesn't support the HTTP stuff,
- * and probably never will because that has nothing to do with event handling.
- *
- * If you notice that when using @eventxx your program leaks some memory, don't
- * blame me, blame @libevent :) @libevent has a known bug on @c event_base_free()
- * that makes it assert always, so @c event_base_free() is unusable, unless you
- * patch your libevent (for example, using this <a
- * href="http://monkeymail.org/archives/libevent-users/2006-April/000141.html">patch</a>
- * written by Mark D. Anderson, and who knows why it's not still applied). If
- * you do so, you can compile your programs with @c -DEVENT_BASE_FREE_FIX so
- * @c event_base_free() gets called in the eventxx::dispatcher @link
- * eventxx::dispatcher::~dispatcher() destructor @endlink.
- *
- * That said, I think it's still pretty usable anyways. If something is broken
- * it would be really easy to fix because @eventxx is just a simple wrapper
- * around @libevent. So, please try it out, and if you have any problems,
- * <a href="mailto:llucax+eventxx@gmail.com">drop me an
+ * This library has not been widely used yet, but it's used in some serious
+ * projects, so I think it's moderately stable now. The library has no support
+ * for buffered events yet, but patches are welcome. It doesn't support the
+ * HTTP stuff, and probably never will because that has nothing to do with
+ * event handling.
+ *
+ * @libevent had a memory leak before version 1.3b (before 1.2 it didn't even
+ * had a way free that memory, from version 1.2 to 1.3a, if you tried to free the
+ * memory the program abort() because a failed assertion). Because of that,
+ * there is a way to disable the @link eventxx::dispatcher::~dispatcher()
+ * destructor @endlink (which calls the inexistent/broken @c event_base_free()
+ * function). So if you use a @libevent version previous to 1.3b, you have to
+ * compile your programs defining the EVENTXX_NO_EVENT_BASE_FREE macro.
+ *
+ * If something is broken it would be really easy to fix because @eventxx is
+ * just a simple wrapper around @libevent. So, please try it out, and if you
+ * have any problems, <a href="mailto:llucax+eventxx@gmail.com">drop me an
  * e-mail</a> and and I'll fix it ASAP (or provide a patch and you will be my
  * best friend ;).
  *
- * Patches to support buffered events are welcome too.
- *
+ * If you use this library, please drop me an e-mail with your thoughts, or
+ * simply saying "I use it", so I can keep track of how many people really use
+ * it.
  *
  * @author Leandro Lucarella <llucax+eventxx@gmail.com>
  *
- * @version 0.4
+ * @version 0.6
  *
  * @par License
  * This program is under the BOLA license (see
@@ -791,15 +789,9 @@ struct dispatcher
                internal::event_base_priority_init(_event_base, npriorities);
        }
 
-#ifdef EVENT_BASE_FREE_FIX
+#ifndef EVENTXX_NO_EVENT_BASE_FREE
        /// Free dispatcher resources, see @ref Status section for details.
        ~dispatcher() throw() { event_base_free(_event_base); }
-#else
-#warning "The dispatcher class *will* leak memory because of a libevent bug, " \
-    "see http://www.mail-archive.com/libevent-users@monkey.org/msg00110.html " \
-    "for more info an a patch. If you already have this patch, please " \
-    "-DEVENT_BASE_FREE_FIX to your compiler to make this message disappear " \
-    "and really free the dispatcher memory using event_base_free()."
 #endif
 
        /**