engines_int.h File Reference

---

Detailed Description

For internal use only.

This file contains the structures, #define's, and function declarations used internally by the parts of the library that need to interface to the event engines.

Definition in file engines_int.h.

#include "event_int.h"
#include "engines.h"

Include dependency graph for engines_int.h:

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

Go to the source code of this file.

Defines
#define	eng_init(ctx, eng, flags)
	Initialize event engine.
#define	eng_poll(ctx, eng, timeo)
	Poll engine events.
#define	eng_fini(ctx, eng)
	Finalize event engine.
#define	eng_sock_add(ctx, eng, sock)
	Add a socket to an event engine.
#define	eng_sock_rem(ctx, eng, sock)
	Remove a socket from an event engine.
#define	eng_sock_ev(ctx, eng, sock, evs)
	Change event interest set on a socket.
#define	eng_sig_add(ctx, eng, sig)
	Add a signal to an event engine.
#define	eng_sig_rem(ctx, eng, sig)
	Remove a signal from an event engine.
#define	eng_tim_add(ctx, eng, tim)
	Add a timer to an event engine.
#define	eng_tim_rem(ctx, eng, tim)
	Remove a timer from an event engine.
#define	englink_clr(ptr)
	Clear an _ev_englink_t.

---

Define Documentation

#define eng_fini (  ctx, eng   )

For internal use only. This macro simply calls the engine finalize method. Warning: This macro evaluates the eng parameter twice. Parameters: [in]  ctx  A pointer to an ev_ctx_t. [in]  eng  A pointer to the ev_engine_t. The engine may not be used after this call. Definition at line 88 of file engines_int.h. Referenced by event_destroy().

#define eng_init (  ctx, eng, flags   )

For internal use only. This macro simply calls the engine init method with the given flag set. Warning: This macro evaluates the eng parameter twice. Parameters: [in]  ctx  A pointer to an ev_ctx_t. [in]  eng  A pointer to the ev_engine_t. [in,out]  flags  A pointer to an ev_flags_t containing desired engine flags. This is a value-result parameter that the engine is expected to modify. Returns: A non-zero error code, or 0 on success. Definition at line 53 of file engines_int.h. Referenced by engine_load().

#define eng_poll (  ctx, eng, timeo   )

For internal use only. This macro simply calls the engine poll method with the given timeout. Warning: This macro evaluates the eng parameter twice. Parameters: [in]  ctx  A pointer to an ev_ctx_t. [in]  eng  A pointer to the ev_engine_t. [in,out]  timeo  A pointer to a struct timeval which will contain the current timeout value. This is a value-result parameter that the engine may modify. Returns: A non-zero error code, or 0 on success. Definition at line 73 of file engines_int.h.

#define eng_sig_add (  ctx, eng, sig   )

For internal use only. This macro calls the engine's signal add method, which is used to register a signal with the engine. Warning: This macro evaluates the eng parameter twice. Parameters: [in]  ctx  A pointer to an ev_ctx_t. [in]  eng  A pointer to the ev_engine_t. [in]  sig  A pointer to an ev_sig_t specifying the signal being registered. Returns: A non-zero error code, or 0 on success. Definition at line 164 of file engines_int.h. Referenced by signal_create().

#define eng_sig_rem (  ctx, eng, sig   )

For internal use only. This macro calls the engine's signal remove method, which is used to unregister a signal from the engine. Warning: This macro evaluates the eng parameter twice. Parameters: [in]  ctx  A pointer to an ev_ctx_t. [in]  eng  A pointer to the ev_engine_t. [in]  sig  A pointer to an ev_sig_t specifying the signal being registered. Returns: A non-zero error code, or 0 on success. Definition at line 183 of file engines_int.h. Referenced by signal_create(), and signal_destroy().

#define eng_sock_add (  ctx, eng, sock   )

For internal use only. This macro calls the engine's socket add method, which is used to register a socket with the engine. Warning: This macro evaluates the eng parameter twice. Parameters: [in]  ctx  A pointer to an ev_ctx_t. [in]  eng  A pointer to the ev_engine_t. [in]  sock  A pointer to an ev_sock_t specifying the socket being registered. Returns: A non-zero error code, or 0 on success. Definition at line 105 of file engines_int.h.

#define eng_sock_ev (  ctx, eng, sock, evs   )

For internal use only. This macro calls the engine's socket event control method, which is used to specify the events of interest for the socket. Warning: This macro evaluates the eng parameter twice. Parameters: [in]  ctx  A pointer to an ev_ctx_t. [in]  eng  A pointer to the ev_engine_t. [in]  sock  A pointer to an ev_sock_t which is having its event set changed. [in]  evs  An ev_flags_t specifying the events of interest. Returns: A non-zero error code, or 0 on success. Definition at line 145 of file engines_int.h.

#define eng_sock_rem (  ctx, eng, sock   )

For internal use only. This macro calls the engine's socket remove method, which is used to unregister a socket from the engine. Warning: This macro evaluates the eng parameter twice. Parameters: [in]  ctx  A pointer to an ev_ctx_t. [in]  eng  A pointer to the ev_engine_t. [in]  sock  A pointer to an ev_sock_t specifying the socket being unregistered. Returns: A non-zero error code, or 0 on success. Definition at line 124 of file engines_int.h.

#define eng_tim_add (  ctx, eng, tim   )

For internal use only. This macro calls the engine's timer add method, which is used to register a timer with the engine. Warning: This macro evaluates the eng parameter twice. Parameters: [in]  ctx  A pointer to an ev_ctx_t. [in]  eng  A pointer to the ev_engine_t. [in]  tim  A pointer to an ev_tim_t specifying the timer being registered. Returns: A non-zero error code, or 0 on success. Definition at line 202 of file engines_int.h. Referenced by timer_create(), and timer_resched().

#define eng_tim_rem (  ctx, eng, tim   )

For internal use only. This macro calls the engine's timer remove method, which is used to unregister a timer from the engine. Warning: This macro evaluates the eng parameter twice. Parameters: [in]  ctx  A pointer to an ev_ctx_t. [in]  eng  A pointer to the ev_engine_t. [in]  tim  A pointer to an ev_tim_t specifying the timer being registered. Returns: A non-zero error code, or 0 on success. Definition at line 222 of file engines_int.h. Referenced by timer_create(), timer_destroy(), and timer_resched().

#define englink_clr (  ptr   )

For internal use only. This helper macro simply zeros an _ev_englink_t structure. Parameters: [in]  ptr  A pointer to an _ev_englink_t to be cleared. Definition at line 235 of file engines_int.h. Referenced by engine_register(), and event_init().

---