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

Merge branch 'nielsdg/main-loop-docs' into 'main'

Browse Source 
docs: Use gi-docgen syntax in main-loop.md

See merge request GNOME/glib!4455
This commit is contained in:
Philip Withnall 2025-01-13 18:34:10 +00:00
commit ce7e867e57
1 changed files with 44 additions and 44 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

88
docs/reference/glib/main-loop.md
View File

@ -6,65 +6,65 @@ The main event loop manages all the available sources of events for GLib and
GTK applications. These events can come from any number of different types
of sources such as file descriptors (plain files, pipes or sockets) and
timeouts. New types of event sources can also be added using
`g_source_attach()`.
[method@GLib.Source.attach].
To allow multiple independent sets of sources to be handled in different
threads, each source is associated with a `GMainContext`. A `GMainContext`
can only be running in a single thread, but sources can be added to it and
removed from it from other threads. All functions which operate on a
`GMainContext` or a built-in `GSource` are thread-safe.
threads, each source is associated with a [struct@MainContext]. A
[struct@MainContext] can only be running in a single thread, but sources can be
added to it and removed from it from other threads. All functions which operate
on a [struct@MainContext] or a built-in [struct@GLib.Source] are thread-safe.
Each event source is assigned a priority. The default priority,
`G_PRIORITY_DEFAULT`, is 0. Values less than 0 denote higher priorities.
[const@PRIORITY_DEFAULT], is 0. Values less than 0 denote higher priorities.
Values greater than 0 denote lower priorities. Events from high priority
sources are always processed before events from lower priority sources.
Idle functions can also be added, and assigned a priority. These will be run
whenever no events with a higher priority are ready to be processed.
The `GMainLoop` data type represents a main event loop. A GMainLoop is
created with `g_main_loop_new()`. After adding the initial event sources,
`g_main_loop_run()` is called. This continuously checks for new events from
The [struct@GLib.MainLoop] data type represents a main event loop. A [struct@GLib.MainLoop] is
created with [ctor@GLib.MainLoop.new]. After adding the initial event sources,
[method@GLib.MainLoop.run] is called. This continuously checks for new events from
each of the event sources and dispatches them. Finally, the processing of an
event from one of the sources leads to a call to `g_main_loop_quit()` to
exit the main loop, and `g_main_loop_run()` returns.
event from one of the sources leads to a call to [method@GLib.MainLoop.quit] to
exit the main loop, and [method@GLib.MainLoop.run] returns.
It is possible to create new instances of `GMainLoop` recursively. This is
It is possible to create new instances of [struct@GLib.MainLoop] recursively. This is
often used in GTK applications when showing modal dialog boxes. Note that
event sources are associated with a particular `GMainContext`, and will be
checked and dispatched for all main loops associated with that GMainContext.
event sources are associated with a particular [struct@MainContext], and will be
checked and dispatched for all main loops associated with that [struct@GLib.MainContext].
Libraries may contain wrappers of some of these functions, e.g.
`gtk_main()`, `gtk_main_quit()` and `gtk_events_pending()`.
## Creating new source types
One of the unusual features of the `GMainLoop` functionality is that new
types of event source can be created and used in addition to the builtin
One of the unusual features of the [struct@GLib.MainLoop] functionality is that new
types of event source can be created and used in addition to the built-in
type of event source. A new event source type is used for handling GDK
events. A new source type is created by "deriving" from the `GSource`
events. A new source type is created by ‘deriving’ from the [struct@GLib.Source]
structure. The derived type of source is represented by a structure that has
the `GSource` structure as a first element, and other elements specific to
the [struct@GLib.Source] structure as a first element, and other elements specific to
the new source type. To create an instance of the new source type, call
`g_source_new()` passing in the size of the derived structure and a table of
functions. These `GSourceFuncs` determine the behavior of the new source
[ctor@GLib.Source.new], passing in the size of the derived structure and a table of
functions. These [struct@GLib.SourceFuncs] determine the behavior of the new source
type.
New source types basically interact with the main context in two ways. Their
prepare function in `GSourceFuncs` can set a timeout to determine the
prepare function in [struct@GLib.SourceFuncs] can set a timeout to determine the
maximum amount of time that the main loop will sleep before checking the
source again. In addition, or as well, the source can add file descriptors
to the set that the main context checks using `g_source_add_poll()`.
to the set that the main context checks using [method@GLib.Source.add_poll].
## Customizing the main loop iteration
Single iterations of a `GMainContext` can be run with
`g_main_context_iteration()`. In some cases, more detailed control of
Single iterations of a [struct@GLib.MainContext] can be run with
[method@GLib.MainContext.iteration]. In some cases, more detailed control of
exactly how the details of the main loop work is desired, for instance, when
integrating the `GMainLoop` with an external main loop. In such cases, you
can call the component functions of `g_main_context_iteration()` directly.
These functions are `g_main_context_prepare()`, `g_main_context_query()`,
`g_main_context_check()` and `g_main_context_dispatch()`.
integrating the [struct@GLib.MainLoop] with an external main loop. In such cases, you
can call the component functions of [method@GLib.MainContext.iteration] directly.
These functions are [method@GLib.MainContext.prepare], [method@GLib.MainContext.query],
[method@GLib.MainContext.check] and [method@GLib.MainContext.dispatch].
## State of a Main Context
@ -73,46 +73,46 @@ diagram, as shown in this image.
![](mainloop-states.gif)
On UNIX, the GLib mainloop is incompatible with `fork()`. Any program using
the mainloop must either `exec()` or `exit()` from the child without
returning to the mainloop.
On Unix, the GLib main loop is incompatible with `fork()`. Any program using
the main loop must either `exec()` or `exit()` from the child without
returning to the main loop.
## Memory management of sources
There are two options for memory management of the user data passed to a
`GSource` to be passed to its callback on invocation. This data is provided
in calls to `g_timeout_add()`, `g_timeout_add_full()`, `g_idle_add()`, etc.
and more generally, using `g_source_set_callback()`. This data is typically
[struct@GLib.Source] to be passed to its callback on invocation. This data is provided
in calls to [func@GLib.timeout_add], [func@GLib.timeout_add_full], [func@GLib.idle_add], etc.
and more generally, using [method@GLib.Source.set_callback]. This data is typically
an object which ‘owns’ the timeout or idle callback, such as a widget or a
network protocol implementation. In many cases, it is an error for the
callback to be invoked after this owning object has been destroyed, as that
results in use of freed memory.
The first, and preferred, option is to store the source ID returned by
functions such as `g_timeout_add()` or `g_source_attach()`, and explicitly
remove that source from the main context using `g_source_remove()` when the
functions such as [func@GLib.timeout_add] or [method@GLib.Source.attach], and explicitly
remove that source from the main context using [func@GLib.Source.remove] when the
owning object is finalized. This ensures that the callback can only be
invoked while the object is still alive.
The second option is to hold a strong reference to the object in the
callback, and to release it in the callback’s `GDestroyNotify`. This ensures
callback, and to release it in the callback’s [callback@GLib.DestroyNotify]. This ensures
that the object is kept alive until after the source is finalized, which is
guaranteed to be after it is invoked for the final time. The
`GDestroyNotify` is another callback passed to the ‘full’ variants of
`GSource` functions (for example, `g_timeout_add_full()`). It is called when
[callback@GLib.DestroyNotify] is another callback passed to the ‘full’ variants of
[struct@GLib.Source] functions (for example, [func@GLib.timeout_add_full]). It is called when
the source is finalized, and is designed for releasing references like this.
One important caveat of this second approach is that it will keep the object
alive indefinitely if the main loop is stopped before the `GSource` is
alive indefinitely if the main loop is stopped before the [struct@GLib.Source] is
invoked, which may be undesirable.
## Tutorial
`GMainContext` is complicated, and can be particularly intimidating for
[struct@GLib.MainContext] is complicated, and can be particularly intimidating for
developers new to working with GLib. Unfortunately, improper use of
`GMainContext` often results in bugs that may be difficult to debug. The
[struct@GLib.MainContext] often results in bugs that may be difficult to debug. The
[Main Contexts tutorial](https://developer.gnome.org/documentation/tutorials/main-contexts.html)
provides valuable guidance for developers working with `GMainContext`
provides valuable guidance for developers working with [struct@GLib.MainContext]
and is highly recommended reading. In particular, the section
[Using GMainContext in a Library](https://developer.gnome.org/documentation/tutorials/main-contexts.html#using-gmaincontext-in-a-library)
[Using `GMainContext` in a Library](https://developer.gnome.org/documentation/tutorials/main-contexts.html#using-gmaincontext-in-a-library)
documents several pitfalls that library authors should avoid.