eloop_none.c File Reference

Event loop - empty template (basic structure, but no OS specific operations) More...

#include "includes.h"
#include "common.h"
#include "eloop.h"

Data Structures
struct	eloop_sock
struct	eloop_timeout
struct	eloop_signal
struct	eloop_data
Functions
int	eloop_init (void)
	Initialize global event loop data.
int	eloop_register_read_sock (int sock, void(*handler)(int sock, void *eloop_ctx, void *sock_ctx), void *eloop_data, void *user_data)
void	eloop_unregister_read_sock (int sock)
	Unregister handler for read events.
int	eloop_register_timeout (unsigned int secs, unsigned int usecs, void(*handler)(void *eloop_ctx, void *timeout_ctx), void *eloop_data, void *user_data)
int	eloop_cancel_timeout (void(*handler)(void *eloop_ctx, void *sock_ctx), void *eloop_data, void *user_data)
int	eloop_is_timeout_registered (void(*handler)(void *eloop_ctx, void *timeout_ctx), void *eloop_data, void *user_data)
int	eloop_register_signal (int sig, void(*handler)(int sig, void *eloop_ctx, void *signal_ctx), void *user_data)
int	eloop_register_signal_terminate (void(*handler)(int sig, void *eloop_ctx, void *signal_ctx), void *user_data)
int	eloop_register_signal_reconfig (void(*handler)(int sig, void *eloop_ctx, void *signal_ctx), void *user_data)
void	eloop_run (void)
	Start the event loop.
void	eloop_terminate (void)
	Terminate event loop.
void	eloop_destroy (void)
	Free any resources allocated for the event loop.
int	eloop_terminated (void)
	Check whether event loop has been terminated.
void	eloop_wait_for_read_sock (int sock)
	Wait for a single reader.

---

Detailed Description

Event loop - empty template (basic structure, but no OS specific operations)

Copyright

Copyright (c) 2002-2005, Jouni Malinen <j@w1.fi>

This software may be distributed under the terms of the BSD license. See README for more details.

---

Function Documentation

void eloop_destroy

(

void

)

Free any resources allocated for the event loop.

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

int eloop_init

(

void

)

Initialize global event loop data.

Returns:

0 on success, -1 on failure

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

void eloop_run

(

void

)

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.

void eloop_terminate

(

void

)

Terminate event loop.

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

int eloop_terminated

(

void

)

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.

void eloop_unregister_read_sock

(

int

sock

)

Unregister handler for read events.

Parameters:

sock	File descriptor number for the socket

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

void eloop_wait_for_read_sock

(

int

sock

)

Wait for a single reader.

Parameters:

sock	File descriptor number for the socket

Do a blocking wait for a single read socket.