~ubuntu-branches/debian/sid/glib2.0/sid

<meta name="generator" content="GTK-Doc V1.18 (XML mode)">

<a name="id606541"></a><h3>Creating new source types</h3>

<a name="id606610"></a><h3>Customizing the main loop iteration</h3>

events sources that are ready. Otherwise, if <em class="parameter"><code>may_block</code></em> is <a class="link" href="glib-Standard-Macros.html#FALSE:CAPS" title="FALSE"><code class="literal">FALSE</code></a> 

sources are not waited to become ready, only those highest priority 

events sources will be dispatched (if any), that are ready at this 

Note that even when <em class="parameter"><code>may_block</code></em> is <a class="link" href="glib-Standard-Macros.html#TRUE:CAPS" title="TRUE"><code class="literal">TRUE</code></a>, it is still possible for 

<a class="link" href="glib-The-Main-Event-Loop.html#g-main-context-iteration" title="g_main_context_iteration ()"><code class="function">g_main_context_iteration()</code></a> to return <a class="link" href="glib-Standard-Macros.html#FALSE:CAPS" title="FALSE"><code class="literal">FALSE</code></a>, since the the wait may 

store <a class="link" href="glib-The-Main-Event-Loop.html#GPollFD" title="struct GPollFD"><span class="type">GPollFD</span></a> records that need to be polled. <span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym> caller-allocates][<acronym title="Parameter points to an array of items."><span class="acronym">array</span></acronym> length=n_fds]</span>

a typical event source will use <a class="link" href="glib-The-Main-Event-Loop.html#g-source-add-poll" title="g_source_add_poll ()"><code class="function">g_source_add_poll()</code></a> instead.

see <a href="http://library.gnome.org/devel/gio/unstable/GFile.html#g-file-supports-thread-contexts"><code class="function">g_file_supports_thread_contexts()</code></a>.

The type of functions to be called when a child exists.

<td>Status information about the child process,

see waitpid(2) for more information about this field</td>

Note further that using <a class="link" href="glib-The-Main-Event-Loop.html#g-child-watch-source-new" title="g_child_watch_source_new ()"><code class="function">g_child_watch_source_new()</code></a> is not 

compatible with calling <code class="literal">waitpid(-1)</code> in 

the application. Calling <code class="function">waitpid()</code> for individual pids will

still work fine.

Note that on platforms where <a class="link" href="glib-The-Main-Event-Loop.html#GPid" title="GPid"><span class="type">GPid</span></a> must be explicitly closed

(see <a class="link" href="glib-Spawning-Processes.html#g-spawn-close-pid" title="g_spawn_close_pid ()"><code class="function">g_spawn_close_pid()</code></a>) <em class="parameter"><code>pid</code></em> must not be closed while the

source is still active. Typically, you will want to call

<a class="link" href="glib-Spawning-Processes.html#g-spawn-close-pid" title="g_spawn_close_pid ()"><code class="function">g_spawn_close_pid()</code></a> in the callback function for the source.

This is just a placeholder for <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Closures.html#GClosureMarshal"><span class="type">GClosureMarshal</span></a>,

<p>

The <span class="structname">GSourceFuncs</span> struct contains a table of

functions used to handle event sources in a generic manner.

</p>

<p>

For idle sources, the prepare and check functions always return <a class="link" href="glib-Standard-Macros.html#TRUE:CAPS" title="TRUE"><code class="literal">TRUE</code></a>

to indicate that the source is always ready to be processed. The prepare

function also returns a timeout value of 0 to ensure that the <code class="function">poll()</code> call

doesn't block (since that would be time wasted which could have been spent

running the idle function).

</p>

<p>

For timeout sources, the prepare and check functions both return <a class="link" href="glib-Standard-Macros.html#TRUE:CAPS" title="TRUE"><code class="literal">TRUE</code></a>

if the timeout interval has expired. The prepare function also returns

a timeout value to ensure that the <code class="function">poll()</code> call doesn't block too long

and miss the next timeout.

</p>

<p>

For file descriptor sources, the prepare function typically returns <a class="link" href="glib-Standard-Macros.html#FALSE:CAPS" title="FALSE"><code class="literal">FALSE</code></a>,

since it must wait until <code class="function">poll()</code> has been called before it knows whether

any events need to be processed. It sets the returned timeout to -1 to

indicate that it doesn't mind how long the <code class="function">poll()</code> call blocks. In the

check function, it tests the results of the <code class="function">poll()</code> call to see if the

required condition has been met, and returns <a class="link" href="glib-Standard-Macros.html#TRUE:CAPS" title="TRUE"><code class="literal">TRUE</code></a> if so.

</p>

<em class="parameter"><code>timeout_</code></em> values returned which were &gt;= 0.</td>

<td>Called after all the file descriptors are polled. The source

should return <a class="link" href="glib-Standard-Macros.html#TRUE:CAPS" title="TRUE"><code class="literal">TRUE</code></a> if it is ready to be dispatched. Note that some

time may have passed since the previous prepare function was called,

so the source should be checked again here.</td>

<td>Called to dispatch the event source, after it has returned

<a class="link" href="glib-Standard-Macros.html#TRUE:CAPS" title="TRUE"><code class="literal">TRUE</code></a> in either its <em class="parameter"><code>prepare</code></em> or its <em class="parameter"><code>check</code></em> function. The <em class="parameter"><code>dispatch</code></em>

function is passed in a callback function and data. The callback

function may be <a class="link" href="glib-Standard-Macros.html#NULL:CAPS" title="NULL"><code class="literal">NULL</code></a> if the source was never connected to a callback

using <a class="link" href="glib-The-Main-Event-Loop.html#g-source-set-callback" title="g_source_set_callback ()"><code class="function">g_source_set_callback()</code></a>. The <em class="parameter"><code>dispatch</code></em> function should call the

callback function with <em class="parameter"><code>user_data</code></em> and whatever additional parameters

are needed for this type of event source.</td>

<td>Called when the source is finalized.</td>

<span class="normal">  </span><span class="function"><a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#G-OBJECT-CLASS:CAPS">G_OBJECT_CLASS</a></span><span class="normal"> </span><span class="symbol">(</span><span class="normal">parent_class</span><span class="symbol">)-&gt;</span><span class="function">finalize</span><span class="normal"> </span><span class="symbol">(</span><span class="normal">object</span><span class="symbol">);</span>

Calling this function on a destroyed source is an error.

triggers, you can call <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Closures.html#g-source-set-dummy-callback"><code class="function">g_source_set_dummy_callback()</code></a> on it to set a

          Generated by GTK-Doc V1.18</div>