luc14n0/glib
1
0
Fork 0
mirror of https://gitlab.gnome.org/GNOME/glib.git synced 2025-04-21 14:49:16 +02:00
Code Issues Packages Projects Releases Wiki Activity

GSource: mark some API as "implementation only"

Browse Source 
Clarify that _add_poll() _remove_poll() _add_unix_fd(),
_modify_unix_fd(), _remove_unix_fd(), _query_unix_fd(),
_set_ready_time(), _add_child_source() and _remove_child_source() are only
intended to be used by the implementation of a particular GSource -- not its
consumers.

https://bugzilla.gnome.org/show_bug.cgi?id=724707
This commit is contained in:
Ryan Lortie 2014-02-20 19:05:30 -05:00
parent 1f7100506a
commit 12d65f2509
1 changed files with 27 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

27
glib/gmain.c
View File

@ -1335,6 +1335,9 @@ g_source_get_context (GSource *source)
* the @revents field in the #GPollFD struct and return %TRUE if events need * the @revents field in the #GPollFD struct and return %TRUE if events need
* to be processed. * to be processed.
* *
* This API is only intended to be used by implementations of #GSource.
* Do not call this API on a #GSource that you did not create.
*
* Using this API forces the linear scanning of event sources on each * Using this API forces the linear scanning of event sources on each
* main loop iteration. Newly-written event sources should try to use * main loop iteration. Newly-written event sources should try to use
* g_source_add_unix_fd() instead of this API. * g_source_add_unix_fd() instead of this API.
@ -1371,6 +1374,9 @@ g_source_add_poll (GSource *source,
* *
* Removes a file descriptor from the set of file descriptors polled for * Removes a file descriptor from the set of file descriptors polled for
* this source. * this source.
*
* This API is only intended to be used by implementations of #GSource.
* Do not call this API on a #GSource that you did not create.
**/ **/
void void
g_source_remove_poll (GSource *source, g_source_remove_poll (GSource *source,
@ -1417,6 +1423,9 @@ g_source_remove_poll (GSource *source,
* @source will hold a reference on @child_source while @child_source * @source will hold a reference on @child_source while @child_source
* is attached to it. * is attached to it.
* *
* This API is only intended to be used by implementations of #GSource.
* Do not call this API on a #GSource that you did not create.
*
* Since: 2.28 * Since: 2.28
**/ **/
void void
@ -1473,6 +1482,9 @@ g_child_source_remove_internal (GSource *child_source,
* *
* Detaches @child_source from @source and destroys it. * Detaches @child_source from @source and destroys it.
* *
* This API is only intended to be used by implementations of #GSource.
* Do not call this API on a #GSource that you did not create.
*
* Since: 2.28 * Since: 2.28
**/ **/
void void
@ -1768,6 +1780,9 @@ g_source_get_priority (GSource *source)
* for both sources is reached during the same main context iteration * for both sources is reached during the same main context iteration
* then the order of dispatch is undefined. * then the order of dispatch is undefined.
* *
* This API is only intended to be used by implementations of #GSource.
* Do not call this API on a #GSource that you did not create.
*
* Since: 2.36 * Since: 2.36
**/ **/
void void
@ -2299,6 +2314,9 @@ g_source_remove_by_funcs_user_data (GSourceFuncs *funcs,
* It is not necessary to remove the fd before destroying the source; it * It is not necessary to remove the fd before destroying the source; it
* will be cleaned up automatically. * will be cleaned up automatically.
* *
* This API is only intended to be used by implementations of #GSource.
* Do not call this API on a #GSource that you did not create.
*
* As the name suggests, this function is not available on Windows. * As the name suggests, this function is not available on Windows.
* *
* Returns: an opaque tag * Returns: an opaque tag
@ -2351,6 +2369,9 @@ g_source_add_unix_fd (GSource *source,
* If you want to remove a fd, don't set its event mask to zero. * If you want to remove a fd, don't set its event mask to zero.
* Instead, call g_source_remove_unix_fd(). * Instead, call g_source_remove_unix_fd().
* *
* This API is only intended to be used by implementations of #GSource.
* Do not call this API on a #GSource that you did not create.
*
* As the name suggests, this function is not available on Windows. * As the name suggests, this function is not available on Windows.
* *
* Since: 2.36 * Since: 2.36
@ -2386,6 +2407,9 @@ g_source_modify_unix_fd (GSource *source,
* watched while keeping the same source around. In the normal case you * watched while keeping the same source around. In the normal case you
* will just want to destroy the source. * will just want to destroy the source.
* *
* This API is only intended to be used by implementations of #GSource.
* Do not call this API on a #GSource that you did not create.
*
* As the name suggests, this function is not available on Windows. * As the name suggests, this function is not available on Windows.
* *
* Since: 2.36 * Since: 2.36
@ -2430,6 +2454,9 @@ g_source_remove_unix_fd (GSource *source,
* The return value of this function is only defined when the function * The return value of this function is only defined when the function
* is called from the check or dispatch functions for @source. * is called from the check or dispatch functions for @source.
* *
* This API is only intended to be used by implementations of #GSource.
* Do not call this API on a #GSource that you did not create.
*
* As the name suggests, this function is not available on Windows. * As the name suggests, this function is not available on Windows.
* *
* Returns: the conditions reported on the fd * Returns: the conditions reported on the fd