engines.h File Reference

---

Detailed Description

This header file contains the necessary structures, #define's, and function declarations to implement an event engine.

Definition in file engines.h.

#include <event/event.h>
#include <event/sock.h>
#include <event/sig.h>
#include <event/tim.h>

Include dependency graph for engines.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Data Structures
struct	_ev_englink_s
	Engine link helper structure. More...
struct	_ev_sockets_s
	Engine sockets helper structure. More...
struct	_ev_signals_s
	Engine signals helper structure. More...
struct	_ev_timers_s
	Engine timers helper structure. More...
struct	_ev_engine_s
	Event engine structure. More...
Defines
#define	ENGINE_MODULE
	Engine module name.
#define	_ev__p(l, r)
	Paste arguments.
#define	_ev_paste(l, r)
	Paste arguments with macro expansion.
#define	EV_ENGINE_MAGIC
	Event engine magic number.
#define	EV_ENGINE_INIT(name, desc, flags, init, poll, fini, so_add, so_rem,so_ev, si_add, si_rem, ti_add, ti_rem)
	Event engine initialization.
#define	EV_ENGINE_SOCKET
	Socket engine flag.
#define	EV_ENGINE_SIGNAL
	Signal engine flag.
#define	EV_ENGINE_TIMER
	Timer engine flag.
#define	EV_ENGINE_COMPMASK
	Engine components mask.
#define	EV_ENGINE_REGISTERED
	Engine registered flag.
#define	EV_ENGINE_RUNNING
	Engine running flag.
#define	eng_verify(eng)
	Event engine verification macro.
#define	eng_name(eng)
	Event engine name.
#define	eng_desc(eng)
	Event engine description.
#define	eng_flags(eng)
	Event engine flags.
#define	eng_runfl(eng)
	Event running engine flags.
#define	eng_runfl_set(eng, fl)
	Set event engine run flag.
#define	eng_runfl_clr(eng, fl)
	Clear event engine run flag.
#define	eng_data(eng)
	Engine-specific data.
#define	eng_data_set(eng, data)
	Set engine-specific data.
#define	eng_sockdata(eng)
	Socket-specific data.
#define	eng_sockdata_set(eng, data)
	Set socket-specific data.
#define	eng_sigdata(eng)
	Signal-specific data.
#define	eng_sigdata_set(eng, data)
	Set signal-specific data.
#define	eng_timdata(eng)
	Timer-specific data.
#define	eng_timdata_set(eng, data)
	Set timer-specific data.
#define	so_eevents_set(sock, flags)
	Set engine socket event flags.
#define	so_eevents_clr(sock, flags)
	Clear engine socket event flags.
Typedefs
typedef _ev_engine_s	ev_engine_t
	Event engine.
typedef _ev_englink_s	_ev_englink_t
	Engine link helper.
typedef _ev_sockets_s	_ev_sockets_t
	Engine sockets helper.
typedef _ev_signals_s	_ev_signals_t
	Engine signals helper.
typedef _ev_timers_s	_ev_timers_t
	Engine timers helper.
typedef ev_engine_t *(*	ev_modinit_t )(ev_ctx_t *ctx)
	Initialize engine module.
typedef ev_err_t(*	ev_init_t )(ev_ctx_t *ctx, ev_engine_t *engine, ev_flags_t *eng_flags)
	Initialize event engine.
typedef ev_err_t(*	ev_poll_t )(ev_ctx_t *ctx, ev_engine_t *engine, struct timeval *timeout)
	Poll engine events.
typedef void(*	ev_fini_t )(ev_ctx_t *ctx, ev_engine_t *engine)
	Finalize event engine.
typedef ev_err_t(*	ev_sockadd_t )(ev_ctx_t *ctx, ev_engine_t *engine, ev_sock_t *sock)
	Add a socket to an event engine.
typedef ev_err_t(*	ev_sockrem_t )(ev_ctx_t *ctx, ev_engine_t *engine, ev_sock_t *sock)
	Remove a socket from an event engine.
typedef ev_err_t(*	ev_sockev_t )(ev_ctx_t *ctx, ev_engine_t *engine, ev_sock_t *sock, ev_flags_t evs)
	Change event interest set on a socket.
typedef ev_err_t(*	ev_sigadd_t )(ev_ctx_t *ctx, ev_engine_t *engine, ev_sig_t *sig)
	Add a signal to an event engine.
typedef ev_err_t(*	ev_sigrem_t )(ev_ctx_t *ctx, ev_engine_t *engine, ev_sig_t *sig)
	Remove a signal from an event engine.
typedef ev_err_t(*	ev_timadd_t )(ev_ctx_t *ctx, ev_engine_t *engine, ev_tim_t *tim)
	Add a timer to an event engine.
typedef ev_err_t(*	ev_timrem_t )(ev_ctx_t *ctx, ev_engine_t *engine, ev_tim_t *tim)
	Remove a timer from an event engine.
Functions
ev_engine_t *	engine_mod_init (ev_ctx_t *ctx)
	Engine module initialization function.
ev_err_t	engine_register (ev_ctx_t *ctx, ev_engine_t *engine)
	Register an engine.
ev_err_t	engine_activate (ev_ctx_t *ctx, ev_engine_t *engine, ev_flags_t comps)
	Activate an engine.
ev_err_t	event_attr_engine (ev_attr_t *attr, ev_engine_t *engine)
	Register an application-specific engine.
Variables
ev_engine_t *	engine_module
	Engine module descriptor.

---