* main difference to libevent is you always have to instance a
* eventxx::dispatcher to get an event loop. There is no implicit global event
* loop. This adds just an extra line of code for single threaded applications
- * and makes things much more simple, so I hope nobody complains about it ;).
+ * and makes things much more simpler, so I hope nobody complains about it ;).
* See eventxx::dispatcher documentation for more details.
*
* You can use use the same plain functions callbacks @libevent use or the other
* kind of function objects (see @ref events section for details on event
* types).
*
- * @eventxx uses @ref exceptions to report errors. All functions has exception
+ * @eventxx uses @ref exceptions to report errors. All functions have exception
* specifications, so it's easy to find out what to expect. See @ref exceptions
* section for more detail.
*
*
* Maybe you shouldn't know this implementation details to keep the abstraction,
* but this is a basic design goal of this wrapper so there is not much chance
- * that this changes in the future (but use this knowledge with care, you are
- * warned ;).
+ * that this changes in the future (but use this knowledge with care, you have
+ * been warned ;).
*
*
* @section Example
* eventxx::dispatcher& d;
* int i;
* handler(eventxx::dispatcher& d): d(d), i(0) {}
- * void operator() (int signum, short event)
+ * void operator() (int signum, eventxx::type event)
* {
* if (i < 5) std::cout << "keep going...\n";
* else
* }
* @endcode
*
- * You can see some more examples on the test directory of the distribution or
- * on the examples related page.
+ * You can see more examples on the test directory of the distribution or on the
+ * examples related page.
*
*
* @section Status
*
- * This library was not widely used yet, it lack some testing. Because templates
- * are not even compiled when they are not used, don't be surprised if you catch
- * a piece of code that don't even compiled yet because the lack of testing. The
- * library has no support for buffered events yet either. It doesn't support the
- * http stuff, and probably never will because that has nothing to do with event
- * handling.
+ * 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() it's unusable, unless you
+ * 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
+ * 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 it because is just a simple wrapper around
- * @libevent. So, please try it out, and if you have any problems,
+ * 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 ;).
*
* @author Leandro Lucarella <llucax+eventxx@gmail.com>
*
- * @version 0.1
+ * @version 0.4
*
* @par License
* This program is under the BOLA license (see
* callbacks.
*/
+/** @example wrapped-functor-way.cpp
+ *
+ * This is a simple example illustrating the usage with an arbitrary member
+ * function as an event handler callbacks.
+ */
+
/** @example mixed-way.cpp
*
* This is a simple example illustrating the usage with a mix of C-like callbacks
};
-/// C function used as callback in the C API.
-typedef void (*ccallback_type)(int, short, void*);
-
-
/**
* Time used for timeout values.
*
* function objects (see eventxx::event, eventxx::timer and eventxx::signal
* templates). The former are just typedef'ed specialization of the later.
*
+ * A member function wrapper functor (eventxx::mem_cb) is also included,
+ * so you can use any member function (method) as an event handler.
+ *
+ * Please note that C-like function callback take a short as the type of event,
+ * while functors (or member functions) use eventxx::type.
+ *
* All events derive from a plain class (not template) eventxx::basic_event, one
* of the main utilities of it (besides containing common code ;) is to be used
* in STL containers.
*/
//@{
+
+/// C function used as callback in the C API.
+typedef void (*ccallback_type)(int, short, void*);
+
+
/**
* Type of events.
*
PERSIST = EV_PERSIST ///< Not really an event, is an event modifier.
};
+type operator| (const type& t1, const type& t2)
+{
+ int r = static_cast< int >(t1) | static_cast< int >(t2);
+ return *reinterpret_cast< type* >(&r);
+}
+
+
/**
* Basic event from which all events derive.
*
* @param ev Type of events to monitor (see eventxx::type).
* @param handler Callback functor.
*/
- event(int fd, short ev, F& handler) throw()
+ event(int fd, type ev, F& handler) throw()
{
- event_set(this, fd, ev, &wrapper,
+ event_set(this, fd, static_cast< short >(ev), &wrapper,
reinterpret_cast< void* >(&handler));
}
* @param handler C-style callback function.
* @param arg Arbitrary pointer to pass to the handler as argument.
*/
- event(int fd, short ev, ccallback_type handler, void* arg = 0) throw()
+ event(int fd, type ev, ccallback_type handler, void* arg = 0) throw()
{
- event_set(this, fd, ev, handler, arg);
+ event_set(this, fd, static_cast< short >(ev), handler, arg);
}
protected:
/// Shortcut to C-style signal handler.
typedef eventxx::signal< ccallback_type > csignal;
+/**
+ * Helper functor to use an arbitrary member function as an event handler.
+ *
+ * With this wrapper, you can use any object method, which accepts the right
+ * parameters (int, short) and returns void, as an event handler. This way you
+ * don't have to overload the operator() which can be confusing depending on the
+ * context.
+ *
+ * You can see an usage example in the Examples Section.
+ */
+template < typename O, typename M >
+struct mem_cb
+{
+
+ /**
+ * Member function callback constructor.
+ *
+ * It expects to receive a class as the first parameter (O), and a
+ * member function (of that class O) as the second parameter.
+ *
+ * When this instance is called with fd and ev as function arguments,
+ * object.method(fd, ev) will be called.
+ *
+ * @param object Object to be used.
+ * @param method Method to be called.
+ */
+ mem_cb(O& object, M method) throw():
+ _object(object), _method(method) {}
+
+ void operator() (int fd, type ev) { (_object.*_method)(fd, ev); }
+ protected:
+ O& _object;
+ M _method;
+
+}; // struct mem_cb
//@}
&& internal::event_priority_set(&e, priority))
throw invalid_priority();
// XXX HACK libevent don't use const
- internal::event_add(&e, const_cast< time* >(&to));
+ internal::event_add(&e, const_cast< time* >(&to));
}
/**
template < typename F >
void add_once(int fd, type ev, F& handler)
{
- internal::event_once(fd, ev, &dispatcher::wrapper< F >,
- reinterpret_cast< void* >(&handler), 0);
+ internal::event_once(fd, static_cast< short>(ev),
+ &dispatcher::wrapper< F >,
+ reinterpret_cast< void* >(&handler), 0);
}
/**
*/
void add_once(int fd, type ev, ccallback_type handler, void* arg)
{
- internal::event_once(fd, ev, handler, arg, 0);
+ internal::event_once(fd, static_cast< short >(ev), handler,
+ arg, 0);
}
/**
template < typename F >
void add_once(int fd, type ev, F& handler, const time& to)
{
- internal::event_once(fd, ev, &dispatcher::wrapper< F >,
- reinterpret_cast< void* >(&handler),
- // XXX HACK libevent don't use const
- const_cast< time* >(&to));
+ internal::event_once(fd, static_cast< short >(ev),
+ &dispatcher::wrapper< F >,
+ reinterpret_cast< void* >(&handler),
+ // XXX HACK libevent don't use const
+ const_cast< time* >(&to));
}
/**
void add_once(int fd, type ev, ccallback_type handler, void* arg,
const time& to)
{
- internal::event_once(fd, ev, handler, arg,
+ internal::event_once(fd, static_cast< short >(ev), handler, arg,
// XXX HACK libevent don't use const
const_cast< time* >(&to));
}
* @param flags If eventxx::ONCE is specified, then just one event is
* processed, if eventxx::NONBLOCK is specified, then this
* function returns even if there are no pending events.
+ *
+ * @return 0 if eventxx::NONBLOCK or eventxx::ONCE is set, 1 if there
+ * are no more events registered and EINTR if you use the
+ * @libevent's @c event_gotsig and return -1 in your
+ * @c event_sigcb callback.
*/
- int dispatch(int flags = 0) // TODO throw(exception)
+ int dispatch(int flags = 0) throw()
{
return internal::event_base_loop(_event_base, flags);
}
*
* @param to If a timeout is given, the loop exits after the specified
* time is elapsed.
+ *
+ * @return Not very well specified by @libevent :-/ that's why it
+ * doesn't throw an exception either.
*/
- int exit(const time& to = time())
+ int exit(const time& to = time()) throw() // TODO throw(exception)
{
// XXX HACK libevent don't use const
return internal::event_base_loopexit(_event_base,
protected:
internal::event_base* _event_base;
template < typename F >
- static void wrapper(int fd, type ev, void* h)
+ static void wrapper(int fd, short ev, void* h)
{
F& handler = *reinterpret_cast< F* >(h);
handler(fd, *reinterpret_cast< type* >(&ev));
}; // struct dispatcher
-
-} // namespace event
+} // namespace eventxx
#endif // _EVENTXX_HPP_
projects / software / eventxx.git / blobdiff