<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title>glibmm 2.4: Glib::MainContext Class Reference</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
</head>
<body bgcolor="#ffffff">
<table border="0" width="100%">
<tr>
<td width="10%" height="40"><img src="../../images/gtkmm_logo.gif" alt="logo" border="0" width="100%" height="100%"/></td>
<td width="90%" height="40"><img src="../../images/top.gif" alt="top" width="100%" height="40"/></td>
</tr>
</table>
<center>
<a class="qindex" href="../../../../gtkmm-2.4/docs/index.html">Main Page</a>
<a href="../../../../gtkmm-2.4/docs/reference/html/group__Widgets.html">Widgets</a>
<a class="qindex" href="namespaces.html">glibmm Namespaces</a>
<a href="../../../../gtkmm-2.4/docs/tutorial/html/index.html"> Book</a>
</center>
<hr width="100%"/>
<!-- begin main content -->
<div id="content">
<!-- Generated by Doxygen 1.5.3 -->
<div class="nav">
<a class="el" href="namespaceGlib.html">Glib</a>::<a class="el" href="classGlib_1_1MainContext.html">MainContext</a></div>
<h1>Glib::MainContext Class Reference<br>
<small>
[<a class="el" href="group__MainLoop.html">The Main Event Loop</a>]</small>
</h1><!-- doxytag: class="Glib::MainContext" -->Main context.
<a href="#_details">More...</a>
<p>
<p>
<a href="classGlib_1_1MainContext-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Public Types</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">typedef <a class="el" href="classGlib_1_1MainContext.html">Glib::MainContext</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classGlib_1_1MainContext.html#1cbedd2b4d723f53cd98df1bb757f904">CppObjectType</a></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">typedef GMainContext </td><td class="memItemRight" valign="bottom"><a class="el" href="classGlib_1_1MainContext.html#da2ea4035a4809198aecbc748b750495">BaseObjectType</a></td></tr>
<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classGlib_1_1MainContext.html#fde2e29315da1239af998f1826ad5e88">iteration</a> (bool may_block)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Runs a single iteration for the given main loop. <a href="#fde2e29315da1239af998f1826ad5e88"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classGlib_1_1MainContext.html#cf4631ab57318f39f3e15d98ac1aaa5c">pending</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Checks if any sources have pending events for the given context. <a href="#cf4631ab57318f39f3e15d98ac1aaa5c"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classGlib_1_1MainContext.html#5a5e60018f7549f064e71b34b1668020">wakeup</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">If context is currently waiting in a poll(), interrupt the poll(), and continue the iteration process. <a href="#5a5e60018f7549f064e71b34b1668020"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classGlib_1_1MainContext.html#a92ee9cfb192aa5eb6c2aa0841068bbc">acquire</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Tries to become the owner of the specified context. <a href="#a92ee9cfb192aa5eb6c2aa0841068bbc"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classGlib_1_1MainContext.html#68c3d19af76d4b32aeae9d2e4f5c230f">wait</a> (<a class="el" href="classGlib_1_1Cond.html">Glib::Cond</a>& cond, <a class="el" href="classGlib_1_1Mutex.html">Glib::Mutex</a>& mutex)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Tries to become the owner of the specified context, as with <a class="el" href="classGlib_1_1MainContext.html#a92ee9cfb192aa5eb6c2aa0841068bbc" title="Tries to become the owner of the specified context.">acquire()</a>. <a href="#68c3d19af76d4b32aeae9d2e4f5c230f"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classGlib_1_1MainContext.html#ce2d9cdfa27cbe30026932de0526f730">release</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Releases ownership of a context previously acquired by this thread with <a class="el" href="classGlib_1_1MainContext.html#a92ee9cfb192aa5eb6c2aa0841068bbc" title="Tries to become the owner of the specified context.">acquire()</a>. <a href="#ce2d9cdfa27cbe30026932de0526f730"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classGlib_1_1MainContext.html#f6d1fccb3c1f5aab758d5eb1b3c15d6a">prepare</a> (int& priority)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Prepares to poll sources within a main loop. <a href="#f6d1fccb3c1f5aab758d5eb1b3c15d6a"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classGlib_1_1MainContext.html#bd1bdf8fcb0130152237e87942c89ee1">prepare</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Prepares to poll sources within a main loop. <a href="#bd1bdf8fcb0130152237e87942c89ee1"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classGlib_1_1MainContext.html#49e8976cec1ae4f5b5c30feea6094927">query</a> (int max_priority, int& timeout, <a class="elRef" doxygen="libstdc++.tag.xml:http://gcc.gnu.org/onlinedocs/libstdc++/latest-doxygen/" href="http://gcc.gnu.org/onlinedocs/libstdc++/latest-doxygen/classstd_1_1vector.html">std::vector</a><<a class="el" href="classGlib_1_1PollFD.html">PollFD</a>>& fds)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Determines information necessary to poll this main loop. <a href="#49e8976cec1ae4f5b5c30feea6094927"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classGlib_1_1MainContext.html#8061ef816d51cc27372f016c683cc513">check</a> (int max_priority, <a class="elRef" doxygen="libstdc++.tag.xml:http://gcc.gnu.org/onlinedocs/libstdc++/latest-doxygen/" href="http://gcc.gnu.org/onlinedocs/libstdc++/latest-doxygen/classstd_1_1vector.html">std::vector</a><<a class="el" href="classGlib_1_1PollFD.html">PollFD</a>>& fds)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Passes the results of polling back to the main loop. <a href="#8061ef816d51cc27372f016c683cc513"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classGlib_1_1MainContext.html#5c1f06dbac3bbf771c25ce76af0d4880">dispatch</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Dispatches all pending sources. <a href="#5c1f06dbac3bbf771c25ce76af0d4880"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classGlib_1_1MainContext.html#d8383c8f1a1a03b904f9be608ad8eaaf">set_poll_func</a> (GPollFunc poll_func)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Sets the function to use to handle polling of file descriptors. <a href="#d8383c8f1a1a03b904f9be608ad8eaaf"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">GPollFunc </td><td class="memItemRight" valign="bottom"><a class="el" href="classGlib_1_1MainContext.html#34a0b1e31173e163f11053dbcf21b84c">get_poll_func</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Gets the poll function set by g_main_context_set_poll_func(). <a href="#34a0b1e31173e163f11053dbcf21b84c"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classGlib_1_1MainContext.html#7cdbe7d102a781b6aded3cdda45fef34">add_poll</a> (<a class="el" href="classGlib_1_1PollFD.html">PollFD</a>& fd, int priority)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Adds a file descriptor to the set of file descriptors polled for this context. <a href="#7cdbe7d102a781b6aded3cdda45fef34"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classGlib_1_1MainContext.html#33ea2db49dd93739599d19756c251627">remove_poll</a> (<a class="el" href="classGlib_1_1PollFD.html">PollFD</a>& fd)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Removes file descriptor from the set of file descriptors to be polled for a particular context. <a href="#33ea2db49dd93739599d19756c251627"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classGlib_1_1SignalTimeout.html">SignalTimeout</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classGlib_1_1MainContext.html#df307c9028858449e932f5fff100d432">signal_timeout</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Timeout signal, attached to this <a class="el" href="classGlib_1_1MainContext.html" title="Main context.">MainContext</a>. <a href="#df307c9028858449e932f5fff100d432"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classGlib_1_1SignalIdle.html">SignalIdle</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classGlib_1_1MainContext.html#2a12990fb67f7b5c1ed61e36952dd827">signal_idle</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Idle signal, attached to this <a class="el" href="classGlib_1_1MainContext.html" title="Main context.">MainContext</a>. <a href="#2a12990fb67f7b5c1ed61e36952dd827"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classGlib_1_1SignalIO.html">SignalIO</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classGlib_1_1MainContext.html#8c8a4283456eb9036cc09dc3aaf203dc">signal_io</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">I/O signal, attached to this <a class="el" href="classGlib_1_1MainContext.html" title="Main context.">MainContext</a>. <a href="#8c8a4283456eb9036cc09dc3aaf203dc"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classGlib_1_1SignalChildWatch.html">SignalChildWatch</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classGlib_1_1MainContext.html#b646f19ce79faa35d97e8af93e6ca6d6">signal_child_watch</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">child watch signal, attached to this <a class="el" href="classGlib_1_1MainContext.html" title="Main context.">MainContext</a>. <a href="#b646f19ce79faa35d97e8af93e6ca6d6"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classGlib_1_1MainContext.html#71499a662e6ac07590a0972b1b0eac64">reference</a> () const </td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classGlib_1_1MainContext.html#8eaf5d38c393770f150db7bad9a67f9e">unreference</a> () const </td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">GMainContext* </td><td class="memItemRight" valign="bottom"><a class="el" href="classGlib_1_1MainContext.html#0fbf5178aca208161051097f034d3694">gobj</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">const GMainContext* </td><td class="memItemRight" valign="bottom"><a class="el" href="classGlib_1_1MainContext.html#1814534a832aecafba4a790e7b5ca25d">gobj</a> () const </td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">GMainContext* </td><td class="memItemRight" valign="bottom"><a class="el" href="classGlib_1_1MainContext.html#3a841522a3db9ceb73742f9f235c3d2b">gobj_copy</a> () const </td></tr>
<tr><td colspan="2"><br><h2>Static Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">static <a class="el" href="classGlib_1_1RefPtr.html">Glib::RefPtr</a><br>
<<a class="el" href="classGlib_1_1MainContext.html">MainContext</a>> </td><td class="memItemRight" valign="bottom"><a class="el" href="classGlib_1_1MainContext.html#31bd96bf707a21c8a3003337dd3af9c4">create</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Creates a new <a class="el" href="classGlib_1_1MainContext.html" title="Main context.">MainContext</a>. <a href="#31bd96bf707a21c8a3003337dd3af9c4"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">static <a class="el" href="classGlib_1_1RefPtr.html">Glib::RefPtr</a><br>
<<a class="el" href="classGlib_1_1MainContext.html">MainContext</a>> </td><td class="memItemRight" valign="bottom"><a class="el" href="classGlib_1_1MainContext.html#1502cbed045a9fb27d18c6975e1d255d">get_default</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the default main context. <a href="#1502cbed045a9fb27d18c6975e1d255d"></a><br></td></tr>
<tr><td colspan="2"><br><h2>Related Functions</h2></td></tr>
<tr><td colspan="2">(Note that these are not member functions.) <br><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classGlib_1_1RefPtr.html">Glib::RefPtr</a><br>
<<a class="el" href="classGlib_1_1MainContext.html">MainContext</a>> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__MainLoop.html#g043c5714afbad2745b27301dd58470a4">wrap</a> (GMainContext* gobject, bool take_copy=false)</td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
Main context. <hr><h2>Member Typedef Documentation</h2>
<a class="anchor" name="1cbedd2b4d723f53cd98df1bb757f904"></a><!-- doxytag: member="Glib::MainContext::CppObjectType" ref="1cbedd2b4d723f53cd98df1bb757f904" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef <a class="el" href="classGlib_1_1MainContext.html">Glib::MainContext</a> <a class="el" href="classGlib_1_1MainContext.html">Glib::MainContext::CppObjectType</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
</div>
</div><p>
<a class="anchor" name="da2ea4035a4809198aecbc748b750495"></a><!-- doxytag: member="Glib::MainContext::BaseObjectType" ref="da2ea4035a4809198aecbc748b750495" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef GMainContext <a class="el" href="classGlib_1_1MainContext.html#da2ea4035a4809198aecbc748b750495">Glib::MainContext::BaseObjectType</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
</div>
</div><p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="31bd96bf707a21c8a3003337dd3af9c4"></a><!-- doxytag: member="Glib::MainContext::create" ref="31bd96bf707a21c8a3003337dd3af9c4" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static <a class="el" href="classGlib_1_1RefPtr.html">Glib::RefPtr</a><<a class="el" href="classGlib_1_1MainContext.html">MainContext</a>> Glib::MainContext::create </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Creates a new <a class="el" href="classGlib_1_1MainContext.html" title="Main context.">MainContext</a>.
<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>The new <a class="el" href="classGlib_1_1MainContext.html" title="Main context.">MainContext</a>. </dd></dl>
</div>
</div><p>
<a class="anchor" name="1502cbed045a9fb27d18c6975e1d255d"></a><!-- doxytag: member="Glib::MainContext::get_default" ref="1502cbed045a9fb27d18c6975e1d255d" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static <a class="el" href="classGlib_1_1RefPtr.html">Glib::RefPtr</a><<a class="el" href="classGlib_1_1MainContext.html">MainContext</a>> Glib::MainContext::get_default </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Returns the default main context.
<p>
This is the main context used for main loop functions when a main loop is not explicitly specified. <dl class="return" compact><dt><b>Returns:</b></dt><dd>The new <a class="el" href="classGlib_1_1MainContext.html" title="Main context.">MainContext</a>. </dd></dl>
</div>
</div><p>
<a class="anchor" name="fde2e29315da1239af998f1826ad5e88"></a><!-- doxytag: member="Glib::MainContext::iteration" ref="fde2e29315da1239af998f1826ad5e88" args="(bool may_block)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool Glib::MainContext::iteration </td>
<td>(</td>
<td class="paramtype">bool </td>
<td class="paramname"> <em>may_block</em> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Runs a single iteration for the given main loop.
<p>
This involves checking to see if any event sources are ready to be processed, then if no events sources are ready and may_block is true, waiting for a source to become ready, then dispatching the highest priority events sources that are ready. Note that even when may_block is true, it is still possible for <a class="el" href="classGlib_1_1MainContext.html#fde2e29315da1239af998f1826ad5e88" title="Runs a single iteration for the given main loop.">iteration()</a> to return false, since the the wait may be interrupted for other reasons than an event source becoming ready. <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>may_block</em> </td><td>Whether the call may block. </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>true if events were dispatched. </dd></dl>
</div>
</div><p>
<a class="anchor" name="cf4631ab57318f39f3e15d98ac1aaa5c"></a><!-- doxytag: member="Glib::MainContext::pending" ref="cf4631ab57318f39f3e15d98ac1aaa5c" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool Glib::MainContext::pending </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Checks if any sources have pending events for the given context.
<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>true if events are pending. </dd></dl>
</div>
</div><p>
<a class="anchor" name="5a5e60018f7549f064e71b34b1668020"></a><!-- doxytag: member="Glib::MainContext::wakeup" ref="5a5e60018f7549f064e71b34b1668020" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Glib::MainContext::wakeup </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
If context is currently waiting in a poll(), interrupt the poll(), and continue the iteration process.
<p>
</div>
</div><p>
<a class="anchor" name="a92ee9cfb192aa5eb6c2aa0841068bbc"></a><!-- doxytag: member="Glib::MainContext::acquire" ref="a92ee9cfb192aa5eb6c2aa0841068bbc" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool Glib::MainContext::acquire </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Tries to become the owner of the specified context.
<p>
If some other context is the owner of the context, returns FALSE immediately. Ownership is properly recursive: the owner can require ownership again and will release ownership when <a class="el" href="classGlib_1_1MainContext.html#ce2d9cdfa27cbe30026932de0526f730" title="Releases ownership of a context previously acquired by this thread with acquire()...">release()</a> is called as many times as <a class="el" href="classGlib_1_1MainContext.html#a92ee9cfb192aa5eb6c2aa0841068bbc" title="Tries to become the owner of the specified context.">acquire()</a>. You must be the owner of a context before you can call <a class="el" href="classGlib_1_1MainContext.html#bd1bdf8fcb0130152237e87942c89ee1" title="Prepares to poll sources within a main loop.">prepare()</a>, <a class="el" href="classGlib_1_1MainContext.html#49e8976cec1ae4f5b5c30feea6094927" title="Determines information necessary to poll this main loop.">query()</a>, <a class="el" href="classGlib_1_1MainContext.html#8061ef816d51cc27372f016c683cc513" title="Passes the results of polling back to the main loop.">check()</a>, <a class="el" href="classGlib_1_1MainContext.html#5c1f06dbac3bbf771c25ce76af0d4880" title="Dispatches all pending sources.">dispatch()</a>. <dl class="return" compact><dt><b>Returns:</b></dt><dd>true if the operation succeeded, and this thread is now the owner of context. </dd></dl>
</div>
</div><p>
<a class="anchor" name="68c3d19af76d4b32aeae9d2e4f5c230f"></a><!-- doxytag: member="Glib::MainContext::wait" ref="68c3d19af76d4b32aeae9d2e4f5c230f" args="(Glib::Cond &cond, Glib::Mutex &mutex)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool Glib::MainContext::wait </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classGlib_1_1Cond.html">Glib::Cond</a>& </td>
<td class="paramname"> <em>cond</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classGlib_1_1Mutex.html">Glib::Mutex</a>& </td>
<td class="paramname"> <em>mutex</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Tries to become the owner of the specified context, as with <a class="el" href="classGlib_1_1MainContext.html#a92ee9cfb192aa5eb6c2aa0841068bbc" title="Tries to become the owner of the specified context.">acquire()</a>.
<p>
But if another thread is the owner, atomically drop mutex and wait on cond until that owner releases ownership or until cond is signaled, then try again (once) to become the owner. <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>cond</em> </td><td>A condition variable. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>mutex</em> </td><td>A mutex, currently held. </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>true if the operation succeeded, and this thread is now the owner of context. </dd></dl>
</div>
</div><p>
<a class="anchor" name="ce2d9cdfa27cbe30026932de0526f730"></a><!-- doxytag: member="Glib::MainContext::release" ref="ce2d9cdfa27cbe30026932de0526f730" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Glib::MainContext::release </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Releases ownership of a context previously acquired by this thread with <a class="el" href="classGlib_1_1MainContext.html#a92ee9cfb192aa5eb6c2aa0841068bbc" title="Tries to become the owner of the specified context.">acquire()</a>.
<p>
If the context was acquired multiple times, the only release ownership when <a class="el" href="classGlib_1_1MainContext.html#ce2d9cdfa27cbe30026932de0526f730" title="Releases ownership of a context previously acquired by this thread with acquire()...">release()</a> is called as many times as it was acquired.
</div>
</div><p>
<a class="anchor" name="f6d1fccb3c1f5aab758d5eb1b3c15d6a"></a><!-- doxytag: member="Glib::MainContext::prepare" ref="f6d1fccb3c1f5aab758d5eb1b3c15d6a" args="(int &priority)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool Glib::MainContext::prepare </td>
<td>(</td>
<td class="paramtype">int & </td>
<td class="paramname"> <em>priority</em> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Prepares to poll sources within a main loop.
<p>
The resulting information for polling is determined by calling <a class="el" href="classGlib_1_1MainContext.html#49e8976cec1ae4f5b5c30feea6094927" title="Determines information necessary to poll this main loop.">query()</a>. <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>priority</em> </td><td>Location to store priority of highest priority source already ready. </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>true if some source is ready to be dispatched prior to polling. </dd></dl>
</div>
</div><p>
<a class="anchor" name="bd1bdf8fcb0130152237e87942c89ee1"></a><!-- doxytag: member="Glib::MainContext::prepare" ref="bd1bdf8fcb0130152237e87942c89ee1" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool Glib::MainContext::prepare </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Prepares to poll sources within a main loop.
<p>
The resulting information for polling is determined by calling <a class="el" href="classGlib_1_1MainContext.html#49e8976cec1ae4f5b5c30feea6094927" title="Determines information necessary to poll this main loop.">query()</a>. <dl class="return" compact><dt><b>Returns:</b></dt><dd>true if some source is ready to be dispatched prior to polling. </dd></dl>
</div>
</div><p>
<a class="anchor" name="49e8976cec1ae4f5b5c30feea6094927"></a><!-- doxytag: member="Glib::MainContext::query" ref="49e8976cec1ae4f5b5c30feea6094927" args="(int max_priority, int &timeout, std::vector< PollFD > &fds)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Glib::MainContext::query </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"> <em>max_priority</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int & </td>
<td class="paramname"> <em>timeout</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="elRef" doxygen="libstdc++.tag.xml:http://gcc.gnu.org/onlinedocs/libstdc++/latest-doxygen/" href="http://gcc.gnu.org/onlinedocs/libstdc++/latest-doxygen/classstd_1_1vector.html">std::vector</a><<a class="el" href="classGlib_1_1PollFD.html">PollFD</a>>& </td>
<td class="paramname"> <em>fds</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Determines information necessary to poll this main loop.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>max_priority</em> </td><td>Maximum priority source to check. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>timeout</em> </td><td>Location to store timeout to be used in polling. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>fds</em> </td><td>Location to store <a class="el" href="classGlib_1_1PollFD.html">Glib::PollFD</a> records that need to be polled. </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>the number of records actually stored in fds, or, if more than n_fds records need to be stored, the number of records that need to be stored. </dd></dl>
</div>
</div><p>
<a class="anchor" name="8061ef816d51cc27372f016c683cc513"></a><!-- doxytag: member="Glib::MainContext::check" ref="8061ef816d51cc27372f016c683cc513" args="(int max_priority, std::vector< PollFD > &fds)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool Glib::MainContext::check </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"> <em>max_priority</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="elRef" doxygen="libstdc++.tag.xml:http://gcc.gnu.org/onlinedocs/libstdc++/latest-doxygen/" href="http://gcc.gnu.org/onlinedocs/libstdc++/latest-doxygen/classstd_1_1vector.html">std::vector</a><<a class="el" href="classGlib_1_1PollFD.html">PollFD</a>>& </td>
<td class="paramname"> <em>fds</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Passes the results of polling back to the main loop.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>max_priority</em> </td><td>Maximum numerical priority of sources to check. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>fds</em> </td><td>Vector of <a class="el" href="classGlib_1_1PollFD.html">Glib::PollFD</a>'s that was passed to the last call to <a class="el" href="classGlib_1_1MainContext.html#49e8976cec1ae4f5b5c30feea6094927" title="Determines information necessary to poll this main loop.">query()</a> </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>true if some sources are ready to be dispatched. </dd></dl>
</div>
</div><p>
<a class="anchor" name="5c1f06dbac3bbf771c25ce76af0d4880"></a><!-- doxytag: member="Glib::MainContext::dispatch" ref="5c1f06dbac3bbf771c25ce76af0d4880" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Glib::MainContext::dispatch </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Dispatches all pending sources.
<p>
</div>
</div><p>
<a class="anchor" name="d8383c8f1a1a03b904f9be608ad8eaaf"></a><!-- doxytag: member="Glib::MainContext::set_poll_func" ref="d8383c8f1a1a03b904f9be608ad8eaaf" args="(GPollFunc poll_func)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Glib::MainContext::set_poll_func </td>
<td>(</td>
<td class="paramtype">GPollFunc </td>
<td class="paramname"> <em>poll_func</em> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Sets the function to use to handle polling of file descriptors.
<p>
It will be used instead of the poll() system call (or GLib's replacement function, which is used where poll() isn't available). This function could possibly be used to integrate the GLib event loop with an external event loop. <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>poll_func</em> </td><td>The function to call to poll all file descriptors. </td></tr>
</table>
</dl>
</div>
</div><p>
<a class="anchor" name="34a0b1e31173e163f11053dbcf21b84c"></a><!-- doxytag: member="Glib::MainContext::get_poll_func" ref="34a0b1e31173e163f11053dbcf21b84c" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">GPollFunc Glib::MainContext::get_poll_func </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Gets the poll function set by g_main_context_set_poll_func().
<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>The poll function </dd></dl>
</div>
</div><p>
<a class="anchor" name="7cdbe7d102a781b6aded3cdda45fef34"></a><!-- doxytag: member="Glib::MainContext::add_poll" ref="7cdbe7d102a781b6aded3cdda45fef34" args="(PollFD &fd, int priority)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Glib::MainContext::add_poll </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classGlib_1_1PollFD.html">PollFD</a>& </td>
<td class="paramname"> <em>fd</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"> <em>priority</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Adds a file descriptor to the set of file descriptors polled for this context.
<p>
This will very seldomly be used directly. Instead a typical event source will use <a class="el" href="classGlib_1_1Source.html#3a0843a960cad7a25919a682c37c9d03" title="Adds a file descriptor to the set of file descriptors polled for this source.">Glib::Source::add_poll()</a> instead. <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>fd</em> </td><td>A <a class="el" href="classGlib_1_1PollFD.html">PollFD</a> structure holding information about a file descriptor to watch. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>priority</em> </td><td>The priority for this file descriptor which should be the same as the priority used for <a class="el" href="classGlib_1_1Source.html#77c4b83960b2fd8d65b10ade1fc2e2fb" title="Adds a Source to a context so that it will be executed within that context.">Glib::Source::attach()</a> to ensure that the file descriptor is polled whenever the results may be needed. </td></tr>
</table>
</dl>
</div>
</div><p>
<a class="anchor" name="33ea2db49dd93739599d19756c251627"></a><!-- doxytag: member="Glib::MainContext::remove_poll" ref="33ea2db49dd93739599d19756c251627" args="(PollFD &fd)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Glib::MainContext::remove_poll </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classGlib_1_1PollFD.html">PollFD</a>& </td>
<td class="paramname"> <em>fd</em> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Removes file descriptor from the set of file descriptors to be polled for a particular context.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>fd</em> </td><td>A <a class="el" href="classGlib_1_1PollFD.html">PollFD</a> structure holding information about a file descriptor. </td></tr>
</table>
</dl>
</div>
</div><p>
<a class="anchor" name="df307c9028858449e932f5fff100d432"></a><!-- doxytag: member="Glib::MainContext::signal_timeout" ref="df307c9028858449e932f5fff100d432" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classGlib_1_1SignalTimeout.html">SignalTimeout</a> Glib::MainContext::signal_timeout </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Timeout signal, attached to this <a class="el" href="classGlib_1_1MainContext.html" title="Main context.">MainContext</a>.
<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>A signal proxy; you want to use <a class="el" href="classGlib_1_1SignalTimeout.html#75b555ed13d91e6903e927f9e0d7afd2" title="Connects a timeout handler.">SignalTimeout::connect()</a>. </dd></dl>
</div>
</div><p>
<a class="anchor" name="2a12990fb67f7b5c1ed61e36952dd827"></a><!-- doxytag: member="Glib::MainContext::signal_idle" ref="2a12990fb67f7b5c1ed61e36952dd827" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classGlib_1_1SignalIdle.html">SignalIdle</a> Glib::MainContext::signal_idle </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Idle signal, attached to this <a class="el" href="classGlib_1_1MainContext.html" title="Main context.">MainContext</a>.
<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>A signal proxy; you want to use <a class="el" href="classGlib_1_1SignalIdle.html#c8befbaf1d10a17d1f3f75143e967a3f" title="Connects an idle handler.">SignalIdle::connect()</a>. </dd></dl>
</div>
</div><p>
<a class="anchor" name="8c8a4283456eb9036cc09dc3aaf203dc"></a><!-- doxytag: member="Glib::MainContext::signal_io" ref="8c8a4283456eb9036cc09dc3aaf203dc" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classGlib_1_1SignalIO.html">SignalIO</a> Glib::MainContext::signal_io </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
I/O signal, attached to this <a class="el" href="classGlib_1_1MainContext.html" title="Main context.">MainContext</a>.
<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>A signal proxy; you want to use <a class="el" href="classGlib_1_1SignalIO.html#c205b21234d26094e75e0931c968c5d2" title="Connects an I/O handler.">SignalIO::connect()</a>. </dd></dl>
</div>
</div><p>
<a class="anchor" name="b646f19ce79faa35d97e8af93e6ca6d6"></a><!-- doxytag: member="Glib::MainContext::signal_child_watch" ref="b646f19ce79faa35d97e8af93e6ca6d6" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classGlib_1_1SignalChildWatch.html">SignalChildWatch</a> Glib::MainContext::signal_child_watch </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
child watch signal, attached to this <a class="el" href="classGlib_1_1MainContext.html" title="Main context.">MainContext</a>.
<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>A signal proxy; you want to use <a class="el" href="classGlib_1_1SignalChildWatch.html#4c2f5be316b9600133129cc974b6b5bb" title="Connects a child watch handler.">SignalChildWatch::connect()</a>. </dd></dl>
</div>
</div><p>
<a class="anchor" name="71499a662e6ac07590a0972b1b0eac64"></a><!-- doxytag: member="Glib::MainContext::reference" ref="71499a662e6ac07590a0972b1b0eac64" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Glib::MainContext::reference </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
</div>
</div><p>
<a class="anchor" name="8eaf5d38c393770f150db7bad9a67f9e"></a><!-- doxytag: member="Glib::MainContext::unreference" ref="8eaf5d38c393770f150db7bad9a67f9e" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Glib::MainContext::unreference </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
</div>
</div><p>
<a class="anchor" name="0fbf5178aca208161051097f034d3694"></a><!-- doxytag: member="Glib::MainContext::gobj" ref="0fbf5178aca208161051097f034d3694" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">GMainContext* Glib::MainContext::gobj </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
</div>
</div><p>
<a class="anchor" name="1814534a832aecafba4a790e7b5ca25d"></a><!-- doxytag: member="Glib::MainContext::gobj" ref="1814534a832aecafba4a790e7b5ca25d" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const GMainContext* Glib::MainContext::gobj </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
</div>
</div><p>
<a class="anchor" name="3a841522a3db9ceb73742f9f235c3d2b"></a><!-- doxytag: member="Glib::MainContext::gobj_copy" ref="3a841522a3db9ceb73742f9f235c3d2b" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">GMainContext* Glib::MainContext::gobj_copy </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
</div>
</div><p>
<hr>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="main_8h.html">main.h</a></ul>
</div> <!-- end main content -->
<hr><address><small>
Generated for glibmm 2.4 by <a href="http://www.doxygen.org/index.html">
Doxygen</a> 1.5.3 © 1997-2001</small></address>
</body>
</html>
distrib
>
Mandriva
>
2008.1
>
x86_64
>
media
>
main-release
>
by-pkgid
>
e8cbfa9673da18966abee0a6d7051b87
>
files
>
189
