summaryrefslogtreecommitdiff
path: root/legacy/ecore/src/lib/ecore/ecore_main.c
diff options
context:
space:
mode:
authorMike Blumenkrantz <michael.blumenkrantz@gmail.com>2011-09-14 14:31:54 +0000
committerMike Blumenkrantz <michael.blumenkrantz@gmail.com>2011-09-14 14:31:54 +0000
commit681749300e5575f1191fdbf990e62f008eefc9d8 (patch)
tree9d356bd02c8b090e922fb9a7b69c9bfec0d6e866 /legacy/ecore/src/lib/ecore/ecore_main.c
parent1e533c27b299685ac1c54b645db5751ad702bf3d (diff)
fix and clarify more fd handler docs
SVN revision: 63389
Diffstat (limited to '')
-rw-r--r--legacy/ecore/src/lib/ecore/ecore_main.c11
1 files changed, 6 insertions, 5 deletions
diff --git a/legacy/ecore/src/lib/ecore/ecore_main.c b/legacy/ecore/src/lib/ecore/ecore_main.c
index 59f0a5b428..322006f149 100644
--- a/legacy/ecore/src/lib/ecore/ecore_main.c
+++ b/legacy/ecore/src/lib/ecore/ecore_main.c
@@ -920,17 +920,17 @@ ecore_main_loop_select_func_get(void)
920 * @p func will be called during the execution of @ref ecore_main_loop_begin 920 * @p func will be called during the execution of @ref ecore_main_loop_begin
921 * when the file descriptor is available for reading, or writing, or both. 921 * when the file descriptor is available for reading, or writing, or both.
922 * 922 *
923 * Normally the return value from the @p func is "zero means this handler is 923 * Normally when @p func returns ECORE_CALLBACK_CANCEL, it indicates that the
924 * finished and can be deleted" as is usual for handler callbacks. However, 924 * handler should be marked for deletion (identical to calling @ref ecore_main_fd_handler_del).
925 * if the @p buf_func is supplied, then the return value from the @p func is 925 * However, if the @p buf_func is supplied, then the return value from the @p func indicates that
926 * "non zero means the handler should be called again in a tight loop". 926 * @p func should be called repeatedly until it returns ECORE_CALLBACK_CANCEL.
927 * 927 *
928 * @p buf_func is called during event loop handling to check if data that has 928 * @p buf_func is called during event loop handling to check if data that has
929 * been read from the file descriptor is in a buffer and is available to 929 * been read from the file descriptor is in a buffer and is available to
930 * read. Some systems (notably xlib) handle their own buffering, and would 930 * read. Some systems (notably xlib) handle their own buffering, and would
931 * otherwise not work with select(). These systems should use a @p buf_func. 931 * otherwise not work with select(). These systems should use a @p buf_func.
932 * This is a most annoying hack, only ecore_x uses it, so refer to that for 932 * This is a most annoying hack, only ecore_x uses it, so refer to that for
933 * an example. NOTE - @p func should probably return "one" always if 933 * an example. NOTE - @p func should probably return ECORE_CALLBACK_RENEW always if
934 * @p buf_func is used, to avoid confusion with the other return value 934 * @p buf_func is used, to avoid confusion with the other return value
935 * semantics. 935 * semantics.
936 * 936 *
@@ -944,6 +944,7 @@ ecore_main_loop_select_func_get(void)
944 * buffered and already read from the fd. Can be @c NULL. 944 * buffered and already read from the fd. Can be @c NULL.
945 * @param buf_data The data to pass to the @p buf_func function. 945 * @param buf_data The data to pass to the @p buf_func function.
946 * @return A fd handler handle if successful. @c NULL otherwise. 946 * @return A fd handler handle if successful. @c NULL otherwise.
947 * @note This function CANNOT be used for reading/writing to regular files!
947 * @ingroup Ecore_FD_Handler_Group 948 * @ingroup Ecore_FD_Handler_Group
948 */ 949 */
949EAPI Ecore_Fd_Handler * 950EAPI Ecore_Fd_Handler *