Defines | Typedefs | Enumerations | Functions
eloop.h File Reference

Go to the source code of this file.

Defines

#define ELOOP_ALL_CTX   (void *) -1

Typedefs

typedef void(* eloop_event_handler )(void *eloop_data, void *user_ctx)
typedef void(* eloop_signal_handler )(int sig, void *signal_ctx)
typedef void(* eloop_sock_handler )(int sock, void *eloop_ctx, void *sock_ctx)
typedef void(* eloop_timeout_handler )(void *eloop_data, void *user_ctx)

Enumerations

enum  eloop_event_type { EVENT_TYPE_READ = 0, EVENT_TYPE_WRITE, EVENT_TYPE_EXCEPTION }

Functions

int eloop_cancel_timeout (eloop_timeout_handler handler, void *eloop_data, void *user_data)
void eloop_destroy (void)
int eloop_init (void)
int eloop_is_timeout_registered (eloop_timeout_handler handler, void *eloop_data, void *user_data)
int eloop_register_event (void *event, size_t event_size, eloop_event_handler handler, void *eloop_data, void *user_data)
int eloop_register_read_sock (int sock, eloop_sock_handler handler, void *eloop_data, void *user_data)
int eloop_register_signal (int sig, eloop_signal_handler handler, void *user_data)
int eloop_register_signal_reconfig (eloop_signal_handler handler, void *user_data)
int eloop_register_signal_terminate (eloop_signal_handler handler, void *user_data)
int eloop_register_sock (int sock, eloop_event_type type, eloop_sock_handler handler, void *eloop_data, void *user_data)
int eloop_register_timeout (unsigned int secs, unsigned int usecs, eloop_timeout_handler handler, void *eloop_data, void *user_data)
void eloop_run (void)
void eloop_terminate (void)
int eloop_terminated (void)
void eloop_unregister_event (void *event, size_t event_size)
void eloop_unregister_read_sock (int sock)
void eloop_unregister_sock (int sock, eloop_event_type type)
void eloop_wait_for_read_sock (int sock)

Define Documentation

#define ELOOP_ALL_CTX   (void *) -1

ELOOP_ALL_CTX - eloop_cancel_timeout() magic number to match all timeouts

Definition at line 29 of file eloop.h.


Typedef Documentation

typedef void(* eloop_event_handler)(void *eloop_data, void *user_ctx)

eloop_event_handler - eloop generic event callback type : Registered callback context data (eloop_data) : Registered callback context data (user_data)

Definition at line 56 of file eloop.h.

typedef void(* eloop_signal_handler)(int sig, void *signal_ctx)

eloop_signal_handler - eloop signal event callback type : Signal number : Registered callback context data (user_data from eloop_register_signal(), eloop_register_signal_terminate(), or eloop_register_signal_reconfig() call)

Definition at line 72 of file eloop.h.

typedef void(* eloop_sock_handler)(int sock, void *eloop_ctx, void *sock_ctx)

eloop_sock_handler - eloop socket event callback type : File descriptor number for the socket : Registered callback context data (eloop_data) : Registered callback context data (user_data)

Definition at line 49 of file eloop.h.

typedef void(* eloop_timeout_handler)(void *eloop_data, void *user_ctx)

eloop_timeout_handler - eloop timeout event callback type : Registered callback context data (eloop_data) : Registered callback context data (user_data)

Definition at line 63 of file eloop.h.


Enumeration Type Documentation

eloop_event_type - eloop socket event type for eloop_register_sock() : Socket has data available for reading : Socket has room for new data to be written : An exception has been reported

Enumerator:
EVENT_TYPE_READ 
EVENT_TYPE_WRITE 
EVENT_TYPE_EXCEPTION 

Definition at line 37 of file eloop.h.


Function Documentation

int eloop_cancel_timeout ( eloop_timeout_handler  handler,
void *  eloop_data,
void *  user_data 
)

eloop_cancel_timeout - Cancel timeouts : Matching callback function : Matching eloop_data or ELOOP_ALL_CTX to match all : Matching user_data or ELOOP_ALL_CTX to match all Returns: Number of cancelled timeouts

Cancel matching <handler,eloop_data,user_data> timeouts registered with eloop_register_timeout(). ELOOP_ALL_CTX can be used as a wildcard for cancelling all timeouts regardless of eloop_data/user_data.

Definition at line 346 of file eloop.c.

void eloop_destroy ( void  )

eloop_destroy - Free any resources allocated for the event loop

After calling eloop_destroy(), other eloop_* functions must not be called before re-running eloop_init().

Definition at line 566 of file eloop.c.

int eloop_init ( void  )

eloop_init() - Initialize global event loop data Returns: 0 on success, -1 on failure

This function must be called before any other eloop_* function.

Definition at line 121 of file eloop.c.

int eloop_is_timeout_registered ( eloop_timeout_handler  handler,
void *  eloop_data,
void *  user_data 
)

eloop_is_timeout_registered - Check if a timeout is already registered : Matching callback function : Matching eloop_data : Matching user_data Returns: 1 if the timeout is registered, 0 if the timeout is not registered

Determine if a matching <handler,eloop_data,user_data> timeout is registered with eloop_register_timeout().

Definition at line 368 of file eloop.c.

int eloop_register_event ( void *  event,
size_t  event_size,
eloop_event_handler  handler,
void *  eloop_data,
void *  user_data 
)

eloop_register_event - Register handler for generic events : Event to wait (eloop implementation specific) : Size of event data : Callback function to be called when event is triggered : Callback context data (eloop_data) : Callback context data (user_data) Returns: 0 on success, -1 on failure

Register an event handler for the given event. This function is used to register eloop implementation specific events which are mainly targetted for operating system specific code (driver interface and l2_packet) since the portable code will not be able to use such an OS-specific call. The handler function will be called whenever the event is triggered. The handler function is responsible for clearing the event after having processed it in order to avoid eloop from calling the handler again for the same event.

In case of Windows implementation (eloop_win.c), event pointer is of HANDLE type, i.e., void*. The callers are likely to have 'HANDLE h' type variable, and they would call this function with eloop_register_event(h, sizeof(h), ...).

Definition at line 187 of file eloop_win.c.

int eloop_register_read_sock ( int  sock,
eloop_sock_handler  handler,
void *  eloop_data,
void *  user_data 
)

eloop_register_read_sock - Register handler for read events : File descriptor number for the socket : Callback function to be called when data is available for reading : Callback context data (eloop_ctx) : Callback context data (sock_ctx) Returns: 0 on success, -1 on failure

Register a read socket notifier for the given file descriptor. The handler function will be called whenever data is available for reading from the socket. The handler function is responsible for clearing the event after having processed it in order to avoid eloop from calling the handler again for the same event.

Definition at line 248 of file eloop.c.

int eloop_register_signal ( int  sig,
eloop_signal_handler  handler,
void *  user_data 
)

eloop_register_signal - Register handler for signals : Signal number (e.g., SIGHUP) : Callback function to be called when the signal is received : Callback context data (signal_ctx) Returns: 0 on success, -1 on failure

Register a callback function that will be called when a signal is received. The callback function is actually called only after the system signal handler has returned. This means that the normal limits for sighandlers (i.e., only "safe functions" allowed) do not apply for the registered callback.

Definition at line 446 of file eloop.c.

int eloop_register_signal_reconfig ( eloop_signal_handler  handler,
void *  user_data 
)

eloop_register_signal_reconfig - Register handler for reconfig signals : Callback function to be called when the signal is received : Callback context data (signal_ctx) Returns: 0 on success, -1 on failure

Register a callback function that will be called when a reconfiguration / hangup signal is received. The callback function is actually called only after the system signal handler has returned. This means that the normal limits for sighandlers (i.e., only "safe functions" allowed) do not apply for the registered callback.

This function is a more portable version of eloop_register_signal() since the knowledge of exact details of the signals is hidden in eloop implementation. In case of operating systems using signal(), this function registers a handler for SIGHUP.

Definition at line 480 of file eloop.c.

int eloop_register_signal_terminate ( eloop_signal_handler  handler,
void *  user_data 
)

eloop_register_signal_terminate - Register handler for terminate signals : Callback function to be called when the signal is received : Callback context data (signal_ctx) Returns: 0 on success, -1 on failure

Register a callback function that will be called when a process termination signal is received. The callback function is actually called only after the system signal handler has returned. This means that the normal limits for sighandlers (i.e., only "safe functions" allowed) do not apply for the registered callback.

This function is a more portable version of eloop_register_signal() since the knowledge of exact details of the signals is hidden in eloop implementation. In case of operating systems using signal(), this function registers handlers for SIGINT and SIGTERM.

Definition at line 470 of file eloop.c.

int eloop_register_sock ( int  sock,
eloop_event_type  type,
eloop_sock_handler  handler,
void *  eloop_data,
void *  user_data 
)

eloop_register_sock - Register handler for socket events : File descriptor number for the socket : Type of event to wait for : Callback function to be called when the event is triggered : Callback context data (eloop_ctx) : Callback context data (sock_ctx) Returns: 0 on success, -1 on failure

Register an event notifier for the given socket's file descriptor. The handler function will be called whenever the that event is triggered for the socket. The handler function is responsible for clearing the event after having processed it in order to avoid eloop from calling the handler again for the same event.

Definition at line 277 of file eloop.c.

int eloop_register_timeout ( unsigned int  secs,
unsigned int  usecs,
eloop_timeout_handler  handler,
void *  eloop_data,
void *  user_data 
)

eloop_register_timeout - Register timeout : Number of seconds to the timeout : Number of microseconds to the timeout : Callback function to be called when timeout occurs : Callback context data (eloop_ctx) : Callback context data (sock_ctx) Returns: 0 on success, -1 on failure

Register a timeout that will cause the handler function to be called after given time.

Definition at line 298 of file eloop.c.

void eloop_run ( void  )

eloop_run - Start the event loop

Start the event loop and continue running as long as there are any registered event handlers. This function is run after event loop has been initialized with event_init() and one or more events have been registered.

Definition at line 491 of file eloop.c.

void eloop_terminate ( void  )

eloop_terminate - Terminate event loop

Terminate event loop even if there are registered events. This can be used to request the program to be terminated cleanly.

Definition at line 560 of file eloop.c.

int eloop_terminated ( void  )

eloop_terminated - Check whether event loop has been terminated Returns: 1 = event loop terminate, 0 = event loop still running

This function can be used to check whether eloop_terminate() has been called to request termination of the event loop. This is normally used to abort operations that may still be queued to be run when eloop_terminate() was called.

Definition at line 597 of file eloop.c.

void eloop_unregister_event ( void *  event,
size_t  event_size 
)

eloop_unregister_event - Unregister handler for a generic event : Event to cancel (eloop implementation specific) : Size of event data

Unregister a generic event notifier that was previously registered with eloop_register_event().

Definition at line 216 of file eloop_win.c.

void eloop_unregister_read_sock ( int  sock)

eloop_unregister_read_sock - Unregister handler for read events : File descriptor number for the socket

Unregister a read socket notifier that was previously registered with eloop_register_read_sock().

Definition at line 256 of file eloop.c.

void eloop_unregister_sock ( int  sock,
eloop_event_type  type 
)

eloop_unregister_sock - Unregister handler for socket events : File descriptor number for the socket : Type of event for which sock was registered

Unregister a socket event notifier that was previously registered with eloop_register_sock().

Definition at line 289 of file eloop.c.

void eloop_wait_for_read_sock ( int  sock)

eloop_wait_for_read_sock - Wait for a single reader : File descriptor number for the socket

Do a blocking wait for a single read socket.

Definition at line 603 of file eloop.c.



wpa_supplicant_node
Author(s): Package maintained by Blaise Gassend
autogenerated on Thu Apr 24 2014 15:33:23