Main Loop (Generic Event Management)
Convenient way to be notified when certain types of event occur.
A main loop is an object which can trap events and call user functions
when those events happen.
The events that our main loop handles are fixed: file-descriptors being
readied, signals being delivered, timeouts, idle functions and child-process
termination are the currently known events.
GskMainLoop itself is abstract, you must use a system-specific derived class
to do polling. Use gsk_main_loop_default() to get a main loop which is
appropriate to your system.
This structure is passed to the system-dependent polling
mechanism to indicate a change in events we want notification of.
@type: what type of change is to occur.
An event passed back from the system-dependent polling
mechanism.
@type: what type of event occurred.
@process_wait_info:
Information about a process's termination.
@pid: the process-id which terminated.
@exited: whether the process exited, versus being killed
by a signal, including crashes, which exit with SIGSEGV, SIGABRT, etc.
@dumped_core: whether the process dumped core.
An opaque object representing a trap of an event.
Private.
Types of event that can be dealt with by this main-loop.
@GSK_MAIN_LOOP_EVENT_IO:
An input/output event. This is really just a file-descriptor event.
@GSK_MAIN_LOOP_EVENT_SIGNAL:
@GSK_MAIN_LOOP_EVENT_PROCESS:
The virtual function which must be implemented for each type of main-loop.
@object_class: the base class from which the main-loop is derived.
@setup: function to call to initialize the main-loop.
@change: function invoked to indicate that a change in events we
are interested in has occurred.
@poll: function invoked to check which events have occurred.
A main-loop. This holds information about all its sources.
@exit_status: Stored exit status which the user may
return from main().
@event_array_cache:
@first_context: first GMainContext in the list.
@last_context: last GMainContext in the list.
A function which will be invoked when a process terminates.
@info: information about the process and why it terminated.
@user_data: data registered to gsk_main_loop_add_waitpid().
Function to be called repetitively (that is, with no blocking or waiting; however,
other events will continue to be processed). It will stop when gsk_main_loop_remove()
is run on its source, or if it returns FALSE.
@user_data: data registered to gsk_main_loop_add_idle().
@Returns: whether to continue running.
Function to be called whenever a UNIX signal of a particular number is raised.
It will be untrapped when gsk_main_loop_remove() is run on its source,
or if it returns FALSE.
@sig_no: the number of the signal that was raised.
@user_data: data registered to gsk_main_loop_add_signal().
@Returns: whether to continue trapping the unix signal.
Function to invoke whenever a timeout expires.
It will be untrapped when gsk_main_loop_remove() is run on its source,
or if it returns FALSE, or after it runs if it was registered as a one-shot (with
milli_period==-1).
@user_data: data registered to gsk_main_loop_add_timer() or
gsk_main_loop_add_timer_absolute().
@Returns: whether to keep running this timer. (Will be ignored if it is a one-shot timer
or if the source has been destroyed)
Function to run whenever some subset of a set of
requested events are noticed.
@fd: the file-descriptor that the events occured on.
@condition: the events that triggered the callback.
@user_data: data registered to gsk_main_loop_add_io().
@Returns: whether to keep these source.
Indicate user requirements for the main-loop being constructed.
@GSK_MAIN_LOOP_NEEDS_THREADS:
Some main loops (like GskMainLoopKqueue) don't cooperate with
threads at all! This flag precludes choosing main-loops
which are have this property.
If you don't need threads, this flag does not hurt, except
that kqueue() is a pretty good mechanism, so you probably
want to get it right for a high-volume single-threaded server.
Make a new main loop.
@create_flags: Stipulations on the nature of the main-loop.
@Returns: a new main loop.
@Returns:
@main_loop:
@timeout:
@t_waited_out:
@Returns:
@main_loop:
@source_func:
@user_data:
@destroy:
@Returns:
@main_loop:
@signal_number:
@signal_func:
@user_data:
@destroy:
@Returns:
@main_loop:
@process_id:
@waitpid_func:
@user_data:
@destroy:
@Returns:
@main_loop:
@fd:
@events:
@io_func:
@user_data:
@destroy:
@Returns:
@source:
@events:
@source:
@events:
@source:
@events:
@main_loop:
@timer_func:
@timer_data:
@timer_destroy:
@millis_expire:
@milli_period:
@Returns:
@main_loop:
@timer_func:
@timer_data:
@timer_destroy:
@unixtime:
@unixtime_micro:
@Returns:
@timer_source:
@millis_expire:
@milli_period:
@source:
@main_loop:
@context:
@main_loop:
@main_loop:
@Returns:
@source:
@Returns:
@main_loop:
@pid:
@wait_info:
@Returns: