From 923ee3f2b907edd37053a2d7b4575d021d77a165 Mon Sep 17 00:00:00 2001 From: Rafael Antognolli Date: Mon, 4 Jul 2011 18:31:23 +0000 Subject: [PATCH] ecore/fd_handler - Add detailed description to this group. SVN revision: 61016 --- legacy/ecore/src/lib/ecore/ecore_main.c | 16 +++++++++++++++- 1 file changed, 15 insertions(+), 1 deletion(-) diff --git a/legacy/ecore/src/lib/ecore/ecore_main.c b/legacy/ecore/src/lib/ecore/ecore_main.c index d2521ec6f1..f1e731f4f2 100644 --- a/legacy/ecore/src/lib/ecore/ecore_main.c +++ b/legacy/ecore/src/lib/ecore/ecore_main.c @@ -777,7 +777,21 @@ ecore_main_loop_select_func_get(void) * * Functions that deal with file descriptor handlers. * - * Examples with functions that deal with file descriptor handlers: + * The @ref Ecore_Fd_Handler can be used to watch a file descriptor for data + * available for reading, for the availability to write without blocking, and + * for errors on the file descriptor. + * + * ecore_main_fd_handler_add() is used to setup a handler for a given file + * descriptor. This file descriptor can be the standard input, a network socket, + * a stream received through some driver of a hardware decoder, etc. Thus it can + * contain errors, like a disconnection, a broken pipe, and so, and that's why + * it's possible to check for these errors with the @ref ECORE_FD_ERROR flag. + * + * An @ref Ecore_Fd_Handler can be used to watch on a file descriptor without + * blocking, still being able to receive events, expire timers, and other watch + * for other things that happen in the Ecore main loop. + * + * Example of use of a file descriptor handler: * @li @ref ecore_fd_handler_example_c */