summaryrefslogtreecommitdiffstats
path: root/src/select.c
diff options
context:
space:
mode:
authorHarald Welte <laforge@gnumonks.org>2011-08-17 12:46:48 +0200
committerHarald Welte <laforge@gnumonks.org>2011-08-17 17:14:11 +0200
commitba6988bd893eb08c54ffdb144700530e3a683d6e (patch)
tree0ae180c7c7bd072c5e11b32e2dc1f2200dea8f34 /src/select.c
parent03bba4313f9e6f880ec5cadcb66a0df9663349b9 (diff)
some more doxygen work (include the notion of modules)
Diffstat (limited to 'src/select.c')
-rw-r--r--src/select.c19
1 files changed, 19 insertions, 0 deletions
diff --git a/src/select.c b/src/select.c
index 4b002ae5..c0705d31 100644
--- a/src/select.c
+++ b/src/select.c
@@ -30,10 +30,21 @@
#ifdef HAVE_SYS_SELECT_H
+/*! \addtogroup select
+ * @{
+ */
+
+/*! \file select.c
+ * \brief select loop abstraction
+ */
+
static int maxfd = 0;
static LLIST_HEAD(osmo_fds);
static int unregistered_count;
+/*! \brief Register a new file descriptor with select loop abstraction
+ * \param[in] fd osmocom file descriptor to be registered
+ */
int osmo_fd_register(struct osmo_fd *fd)
{
int flags;
@@ -75,12 +86,18 @@ int osmo_fd_register(struct osmo_fd *fd)
return 0;
}
+/*! \brief Unregister a file descriptor from select loop abstraction
+ * \param[in] fd osmocom file descriptor to be unregistered
+ */
void osmo_fd_unregister(struct osmo_fd *fd)
{
unregistered_count++;
llist_del(&fd->list);
}
+/*! \brief select main loop integration
+ * \param[in] polling should we pollonly (1) or block on select (0)
+ */
int osmo_select_main(int polling)
{
struct osmo_fd *ufd, *tmp;
@@ -150,4 +167,6 @@ restart:
return work;
}
+/*! }@ */
+
#endif /* _HAVE_SYS_SELECT_H */