Sylvain Munaut | 12ba778 | 2014-06-16 10:13:40 +0200 | [diff] [blame] | 1 | #pragma once |
Harald Welte | ec8b450 | 2010-02-20 20:34:29 +0100 | [diff] [blame] | 2 | |
Pablo Neira Ayuso | 8341934 | 2011-03-22 16:36:13 +0100 | [diff] [blame] | 3 | #include <osmocom/core/linuxlist.h> |
Harald Welte | ec8b450 | 2010-02-20 20:34:29 +0100 | [diff] [blame] | 4 | |
Harald Welte | ba6988b | 2011-08-17 12:46:48 +0200 | [diff] [blame] | 5 | /*! \defgroup select Select loop abstraction |
| 6 | * @{ |
| 7 | */ |
| 8 | |
Harald Welte | bd598e3 | 2011-08-16 23:26:52 +0200 | [diff] [blame] | 9 | /*! \file select.h |
| 10 | * \brief select loop abstraction |
| 11 | */ |
| 12 | |
| 13 | /*! \brief Indicate interest in reading from the file descriptor */ |
Harald Welte | ec8b450 | 2010-02-20 20:34:29 +0100 | [diff] [blame] | 14 | #define BSC_FD_READ 0x0001 |
Harald Welte | bd598e3 | 2011-08-16 23:26:52 +0200 | [diff] [blame] | 15 | /*! \brief Indicate interest in writing to the file descriptor */ |
Harald Welte | ec8b450 | 2010-02-20 20:34:29 +0100 | [diff] [blame] | 16 | #define BSC_FD_WRITE 0x0002 |
Harald Welte | bd598e3 | 2011-08-16 23:26:52 +0200 | [diff] [blame] | 17 | /*! \brief Indicate interest in exceptions from the file descriptor */ |
Harald Welte | ec8b450 | 2010-02-20 20:34:29 +0100 | [diff] [blame] | 18 | #define BSC_FD_EXCEPT 0x0004 |
| 19 | |
Harald Welte | bd598e3 | 2011-08-16 23:26:52 +0200 | [diff] [blame] | 20 | /*! \brief Structure representing a file dsecriptor */ |
Pablo Neira Ayuso | f7f89d0 | 2011-05-07 12:42:40 +0200 | [diff] [blame] | 21 | struct osmo_fd { |
Harald Welte | bd598e3 | 2011-08-16 23:26:52 +0200 | [diff] [blame] | 22 | /*! linked list for internal management */ |
| 23 | struct llist_head list; |
| 24 | /*! actual operating-system level file decriptor */ |
Harald Welte | ec8b450 | 2010-02-20 20:34:29 +0100 | [diff] [blame] | 25 | int fd; |
Harald Welte | bd598e3 | 2011-08-16 23:26:52 +0200 | [diff] [blame] | 26 | /*! bit-mask or of \ref BSC_FD_READ, \ref BSC_FD_WRITE and/or |
| 27 | * \ref BSC_FD_EXCEPT */ |
Harald Welte | ec8b450 | 2010-02-20 20:34:29 +0100 | [diff] [blame] | 28 | unsigned int when; |
Harald Welte | bd598e3 | 2011-08-16 23:26:52 +0200 | [diff] [blame] | 29 | /*! call-back function to be called once file descriptor becomes |
| 30 | * available */ |
Pablo Neira Ayuso | f7f89d0 | 2011-05-07 12:42:40 +0200 | [diff] [blame] | 31 | int (*cb)(struct osmo_fd *fd, unsigned int what); |
Harald Welte | bd598e3 | 2011-08-16 23:26:52 +0200 | [diff] [blame] | 32 | /*! data pointer passed through to call-back function */ |
Harald Welte | ec8b450 | 2010-02-20 20:34:29 +0100 | [diff] [blame] | 33 | void *data; |
Harald Welte | bd598e3 | 2011-08-16 23:26:52 +0200 | [diff] [blame] | 34 | /*! private number, extending \a data */ |
Harald Welte | ec8b450 | 2010-02-20 20:34:29 +0100 | [diff] [blame] | 35 | unsigned int priv_nr; |
| 36 | }; |
| 37 | |
Pablo Neira Ayuso | f7f89d0 | 2011-05-07 12:42:40 +0200 | [diff] [blame] | 38 | int osmo_fd_register(struct osmo_fd *fd); |
| 39 | void osmo_fd_unregister(struct osmo_fd *fd); |
| 40 | int osmo_select_main(int polling); |
Harald Welte | bd598e3 | 2011-08-16 23:26:52 +0200 | [diff] [blame] | 41 | |
Harald Welte | 6c33ae2 | 2016-03-19 21:17:58 +0100 | [diff] [blame] | 42 | struct osmo_fd *osmo_fd_get_by_fd(int fd); |
| 43 | |
Holger Hans Peter Freyther | 61f2888 | 2016-03-21 09:55:05 +0100 | [diff] [blame] | 44 | /* |
| 45 | * foreign event loop integration |
| 46 | */ |
| 47 | int osmo_fd_fill_fds(void *readset, void *writeset, void *exceptset); |
| 48 | int osmo_fd_disp_fds(void *readset, void *writeset, void *exceptset); |
| 49 | |
Sylvain Munaut | dca7d2c | 2012-04-18 21:53:23 +0200 | [diff] [blame] | 50 | /*! @} */ |