eloop.h revision 1.1.1.11
1/* SPDX-License-Identifier: BSD-2-Clause */ 2/* 3 * dhcpcd - DHCP client daemon 4 * Copyright (c) 2006-2023 Roy Marples <roy@marples.name> 5 * All rights reserved 6 7 * Redistribution and use in source and binary forms, with or without 8 * modification, are permitted provided that the following conditions 9 * are met: 10 * 1. Redistributions of source code must retain the above copyright 11 * notice, this list of conditions and the following disclaimer. 12 * 2. Redistributions in binary form must reproduce the above copyright 13 * notice, this list of conditions and the following disclaimer in the 14 * documentation and/or other materials provided with the distribution. 15 * 16 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND 17 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 18 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 19 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE 20 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 21 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 22 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 23 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 24 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 25 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 26 * SUCH DAMAGE. 27 */ 28 29#ifndef ELOOP_H 30#define ELOOP_H 31 32#include <time.h> 33 34/* Handy macros to create subsecond timeouts */ 35#define CSEC_PER_SEC 100 36#define MSEC_PER_SEC 1000 37#define NSEC_PER_CSEC 10000000 38#define NSEC_PER_MSEC 1000000 39#define NSEC_PER_SEC 1000000000 40 41/* eloop queues are really only for deleting timeouts registered 42 * for a function or object. 43 * The idea being that one interface has different timeouts for 44 * say DHCP and DHCPv6. */ 45#ifndef ELOOP_QUEUE 46 #define ELOOP_QUEUE 1 47#endif 48 49/* Used for deleting a timeout for all queues. */ 50#define ELOOP_QUEUE_ALL 0 51 52/* Forward declare eloop - the content should be invisible to the outside */ 53struct eloop; 54 55#define ELE_READ 0x0001 56#define ELE_WRITE 0x0002 57#define ELE_ERROR 0x0100 58#define ELE_HANGUP 0x0200 59#define ELE_NVAL 0x0400 60 61size_t eloop_event_count(const struct eloop *); 62int eloop_event_add(struct eloop *, int, unsigned short, 63 void (*)(void *, unsigned short), void *); 64int eloop_event_delete(struct eloop *, int); 65 66unsigned long long eloop_timespec_diff(const struct timespec *tsp, 67 const struct timespec *usp, unsigned int *nsp); 68#define eloop_timeout_add_tv(eloop, tv, cb, ctx) \ 69 eloop_q_timeout_add_tv((eloop), ELOOP_QUEUE, (tv), (cb), (ctx)) 70#define eloop_timeout_add_sec(eloop, tv, cb, ctx) \ 71 eloop_q_timeout_add_sec((eloop), ELOOP_QUEUE, (tv), (cb), (ctx)) 72#define eloop_timeout_add_msec(eloop, ms, cb, ctx) \ 73 eloop_q_timeout_add_msec((eloop), ELOOP_QUEUE, (ms), (cb), (ctx)) 74#define eloop_timeout_delete(eloop, cb, ctx) \ 75 eloop_q_timeout_delete((eloop), ELOOP_QUEUE, (cb), (ctx)) 76int eloop_q_timeout_add_tv(struct eloop *, int, 77 const struct timespec *, void (*)(void *), void *); 78int eloop_q_timeout_add_sec(struct eloop *, int, 79 unsigned int, void (*)(void *), void *); 80int eloop_q_timeout_add_msec(struct eloop *, int, 81 unsigned long, void (*)(void *), void *); 82int eloop_q_timeout_delete(struct eloop *, int, void (*)(void *), void *); 83 84int eloop_signal_set_cb(struct eloop *, const int *, size_t, 85 void (*)(int, void *), void *); 86int eloop_signal_mask(struct eloop *, sigset_t *oldset); 87 88struct eloop * eloop_new(void); 89void eloop_clear(struct eloop *, ...); 90void eloop_free(struct eloop *); 91void eloop_exit(struct eloop *, int); 92void eloop_enter(struct eloop *); 93int eloop_forked(struct eloop *); 94int eloop_open(struct eloop *); 95int eloop_start(struct eloop *, sigset_t *); 96 97#endif 98