event.h File Reference

---

Detailed Description

This header file contains the necessary structures, #define's, and function declarations to make use of the event library.

Definition in file event.h.

#include <errno.h>
#include <stdlib.h>
#include <treeconf/treeconf.h>
#include <event/event_err.h>
#include <event/event_version.h>
#include <event/gcc-attrs.h>

Include dependency graph for event.h:

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

Go to the source code of this file.

Data Structures
struct	_ev_englist_s
	Event context engine list structure. More...
struct	_ev_ctx_s
	Event context structure. More...
struct	_event_s
	Event structure. More...
struct	_ev_genhdr_s
	Event generator header structure. More...
Defines
#define	EV_BEGIN_C_DECLS
	Begin declaration in C namespace.
#define	EV_END_C_DECLS
	End declaration in C namespace.
#define	EV_CTX_MAGIC
	Event context magic number.
#define	EV_CTX_SECURE
	Secure operation flag.
#define	EV_CTX_RUNNING
	Library running flag.
#define	ec_verify(ctx)
	Event context verification macro.
#define	ec_flags(ctx)
	Event context flags.
#define	ec_prog(ctx)
	Event Context application name.
#define	ec_conf(ctx)
	Event Context configuration.
#define	EVENT_MAGIC
	Event magic number.
#define	ev_verify(event)
	Event verification macro.
#define	ev_context(event)
	Event context.
#define	ev_type(event)
	Event type.
#define	ev_generator(event)
	Event generator.
#define	ev_paramtype(event)
	Event parameter type.
#define	ev_intparam(event)
	Event parameter: integer.
#define	ev_ptrparam(event)
	Event parameter: pointer.
#define	EV_GEN_ACTIVE
	Generator in use.
#define	EV_GEN_DELETED
	Generator deleted.
#define	_eg_hdr(gen)
	Generator header.
#define	eg_verify(gen, magic)
	Generator verification macro.
#define	eg_type(gen)
	Generator type.
#define	eg_flags(gen)
	Generator flags.
#define	eg_flags_set(gen, fl)
	Set generator flags.
#define	eg_flags_clr(gen, fl)
	Clear generator flags.
#define	eg_next(gen)
	Next generator.
#define	eg_prev(gen)
	Previous generator.
#define	eg_context(gen)
	Generator context.
#define	eg_ref(gen)
	Retrieve reference count.
#define	eg_ref_inc(ctx, gen)
	Increment reference count.
#define	eg_ref_dec(ctx, gen)
	Decrement reference count.
#define	eg_callback(gen)
	Generator callback.
#define	eg_callback_set(gen, call)
	Set generator callback.
#define	eg_calldata(gen)
	Generator callback data.
#define	eg_calldata_set(gen, data)
	Set generator callback data.
#define	EV_INIT_SECURE
	Secure operation flag.
Typedefs
typedef _ev_ctx_s	ev_ctx_t
	Event context.
typedef _ev_englist_s	_ev_englist_t
	Event context engine list.
typedef _ev_attr_s *	ev_attr_t
	Event context attributes.
typedef _event_s	event_t
	Event structure.
typedef _ev_genhdr_s	ev_genhdr_t
	Generator header.
typedef unsigned int	ev_err_t
	Event errors.
typedef unsigned long	ev_magic_t
	Event magic number.
typedef unsigned long	ev_flags_t
	Event flags.
typedef void(*	ev_call_t )(ev_ctx_t *ctx, event_t *event, void *data)
	Event callbacks.
typedef void(*	ev_log_t )(const char *file, int line, const char *func, const char *msg)
	Library logging.
typedef void(*	ev_freegen_t )(ev_ctx_t *ctx, void *gen)
	Generator release callback.
Enumerations
enum	ev_type_t {   ET_NONE, ET_READ, ET_WRITE, ET_ACCEPT,   ET_CONNECT, ET_EOF, ET_ERROR, ET_SIGNAL,   ET_EXPIRE, ET_RESERVED, ET_USER }
	Event types. More...
enum	ev_paramtype_t { EP_NONE, EP_INT, EP_PTR }
	Event parameter types. More...
enum	ev_gentype_t {   EGT_NONE, EGT_SOCKET, EGT_SIGNAL, EGT_TIMER,   EGT_RESERVED, EGT_USER }
	Generator types. More...
Functions
ev_err_t	event_init (ev_ctx_t *ctx, const ev_attr_t *attr, ev_flags_t flags, const char *prog, const char *envpath)
	Initialize events library.
ev_err_t	event_destroy (ev_ctx_t *ctx)
	Release memory used by events library context.
ev_err_t	event_attr_init (ev_attr_t *attr)
	Initialize a set of attributes for the events library.
ev_err_t	event_attr_confpath (ev_attr_t *attr, const char **path)
	Retrieve and/or set default configuration search path.
ev_err_t	event_attr_libpath (ev_attr_t *attr, const char **path)
	Retrieve and/or set default module search path.
ev_err_t	event_attr_modlist (ev_attr_t *attr, const char **list)
	Retrieve and/or set default module list.
ev_err_t	event_attr_confreg (ev_attr_t *attr, const char *name, const char *def, treeconf_nodown_t nodown, treeconf_change_t change, void *assoc)
	Register a treeconf variable for the application.
ev_err_t	event_attr_confvar (ev_attr_t *attr, const char *name, const char *value)
	Override a treeconf variable setting.
ev_err_t	event_attr_destroy (ev_attr_t *attr)
	Destroy an attribute set and release all allocated memory.
ev_err_t	event_gen_register (ev_ctx_t *ctx, unsigned int gentype, ev_magic_t genmagic, size_t gensize, ev_freegen_t genrel)
	Register a generator.
ev_err_t	event_gen_alloc (ev_ctx_t *ctx, unsigned int gentype, void *gen)
	Allocate a generator.
ev_err_t	event_gen_release (ev_ctx_t *ctx, ev_genhdr_t *gen)
	Release a generator.
ev_err_t	event_log_set (ev_log_t logger)
	Set a logging function.
ev_err_t	event_log_reset (void)
	Reset library logging.
ev_err_t	event_log_debug (int onoff)
	Turn library logging on or off.
ev_err_t	event_log_trace (int onoff)
	Turn library function tracing on or off.
ev_err_t	event_log_abort (int onoff)
	Turn library abort on or off.

---

Define Documentation

#define EV_BEGIN_C_DECLS

For internal use only. This macro is defined to extern "C" { when compiling with a C++ compiler. See EV_END_C_DECLS. Definition at line 165 of file event.h.

#define EV_END_C_DECLS

For internal use only. This macro is defined to } when compiling with a C++ compiler. See EV_BEGIN_C_DECLS. Definition at line 166 of file event.h.

---