blob: 18aad35f1b9d38b933347cc32b68f03a4b564719 [file] [log] [blame]
Harald Welteec8b4502010-02-20 20:34:29 +01001#ifndef _BSC_SELECT_H
2#define _BSC_SELECT_H
3
Pablo Neira Ayuso83419342011-03-22 16:36:13 +01004#include <osmocom/core/linuxlist.h>
Harald Welteec8b4502010-02-20 20:34:29 +01005
Harald Welteba6988b2011-08-17 12:46:48 +02006/*! \defgroup select Select loop abstraction
7 * @{
8 */
9
Harald Weltebd598e32011-08-16 23:26:52 +020010/*! \file select.h
11 * \brief select loop abstraction
12 */
13
14/*! \brief Indicate interest in reading from the file descriptor */
Harald Welteec8b4502010-02-20 20:34:29 +010015#define BSC_FD_READ 0x0001
Harald Weltebd598e32011-08-16 23:26:52 +020016/*! \brief Indicate interest in writing to the file descriptor */
Harald Welteec8b4502010-02-20 20:34:29 +010017#define BSC_FD_WRITE 0x0002
Harald Weltebd598e32011-08-16 23:26:52 +020018/*! \brief Indicate interest in exceptions from the file descriptor */
Harald Welteec8b4502010-02-20 20:34:29 +010019#define BSC_FD_EXCEPT 0x0004
20
Harald Weltebd598e32011-08-16 23:26:52 +020021/*! \brief Structure representing a file dsecriptor */
Pablo Neira Ayusof7f89d02011-05-07 12:42:40 +020022struct osmo_fd {
Harald Weltebd598e32011-08-16 23:26:52 +020023 /*! linked list for internal management */
24 struct llist_head list;
25 /*! actual operating-system level file decriptor */
Harald Welteec8b4502010-02-20 20:34:29 +010026 int fd;
Harald Weltebd598e32011-08-16 23:26:52 +020027 /*! bit-mask or of \ref BSC_FD_READ, \ref BSC_FD_WRITE and/or
28 * \ref BSC_FD_EXCEPT */
Harald Welteec8b4502010-02-20 20:34:29 +010029 unsigned int when;
Harald Weltebd598e32011-08-16 23:26:52 +020030 /*! call-back function to be called once file descriptor becomes
31 * available */
Pablo Neira Ayusof7f89d02011-05-07 12:42:40 +020032 int (*cb)(struct osmo_fd *fd, unsigned int what);
Harald Weltebd598e32011-08-16 23:26:52 +020033 /*! data pointer passed through to call-back function */
Harald Welteec8b4502010-02-20 20:34:29 +010034 void *data;
Harald Weltebd598e32011-08-16 23:26:52 +020035 /*! private number, extending \a data */
Harald Welteec8b4502010-02-20 20:34:29 +010036 unsigned int priv_nr;
37};
38
Pablo Neira Ayusof7f89d02011-05-07 12:42:40 +020039int osmo_fd_register(struct osmo_fd *fd);
40void osmo_fd_unregister(struct osmo_fd *fd);
41int osmo_select_main(int polling);
Harald Weltebd598e32011-08-16 23:26:52 +020042
Harald Welteba6988b2011-08-17 12:46:48 +020043/*! }@ */
44
Harald Welteec8b4502010-02-20 20:34:29 +010045#endif /* _BSC_SELECT_H */