eloop.h

Go to the documentation of this file.

/*
 * Event loop
 * Copyright (c) 2002-2006, Jouni Malinen <j@w1.fi>
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License version 2 as
 * published by the Free Software Foundation.
 *
 * Alternatively, this software may be distributed under the terms of BSD
 * license.
 *
 * See README and COPYING for more details.
 *
 * This file defines an event loop interface that supports processing events
 * from registered timeouts (i.e., do something after N seconds), sockets
 * (e.g., a new packet available for reading), and signals. eloop.c is an
 * implementation of this interface using select() and sockets. This is
 * suitable for most UNIX/POSIX systems. When porting to other operating
 * systems, it may be necessary to replace that implementation with OS specific
 * mechanisms.
 */

#ifndef ELOOP_H
#define ELOOP_H

#define ELOOP_ALL_CTX (void *) -1

typedef enum {
        EVENT_TYPE_READ = 0,
        EVENT_TYPE_WRITE,
        EVENT_TYPE_EXCEPTION
} eloop_event_type;

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

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

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

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

int eloop_init(void);

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

void eloop_unregister_read_sock(int sock);

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

void eloop_unregister_sock(int sock, eloop_event_type type);

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

void eloop_unregister_event(void *event, size_t event_size);

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

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

int eloop_is_timeout_registered(eloop_timeout_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_terminate(eloop_signal_handler handler,
                                    void *user_data);

int eloop_register_signal_reconfig(eloop_signal_handler handler,
                                   void *user_data);

void eloop_run(void);

void eloop_terminate(void);

void eloop_destroy(void);

int eloop_terminated(void);

void eloop_wait_for_read_sock(int sock);

#endif /* ELOOP_H */