<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> <html xmlns="http://www.w3.org/1999/xhtml"> <head> <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> <meta http-equiv="X-UA-Compatible" content="IE=9"/> <meta name="generator" content="Doxygen 1.8.13"/> <meta name="viewport" content="width=device-width, initial-scale=1"/> <title>PulseAudio: thread-mainloop.h Source File</title> <link href="tabs.css" rel="stylesheet" type="text/css"/> <script type="text/javascript" src="jquery.js"></script> <script type="text/javascript" src="dynsections.js"></script> <link href="navtree.css" rel="stylesheet" type="text/css"/> <script type="text/javascript" src="resize.js"></script> <script type="text/javascript" src="navtreedata.js"></script> <script type="text/javascript" src="navtree.js"></script> <script type="text/javascript"> $(document).ready(initResizable); </script> <link href="doxygen.css" rel="stylesheet" type="text/css" /> </head> <body> <div id="top"><!-- do not remove this div, it is closed by doxygen! --> <div id="titlearea"> <table cellspacing="0" cellpadding="0"> <tbody> <tr style="height: 56px;"> <td id="projectalign" style="padding-left: 0.5em;"> <div id="projectname">PulseAudio  <span id="projectnumber">10.0.0-1.1.mga6</span> </div> </td> </tr> </tbody> </table> </div> <!-- end header part --> <!-- Generated by Doxygen 1.8.13 --> <script type="text/javascript" src="menudata.js"></script> <script type="text/javascript" src="menu.js"></script> <script type="text/javascript"> $(function() { initMenu('',false,false,'search.php','Search'); }); </script> <div id="main-nav"></div> </div><!-- top --> <div id="side-nav" class="ui-resizable side-nav-resizable"> <div id="nav-tree"> <div id="nav-tree-contents"> <div id="nav-sync" class="sync"></div> </div> </div> <div id="splitbar" style="-moz-user-select:none;" class="ui-resizable-handle"> </div> </div> <script type="text/javascript"> $(document).ready(function(){initNavTree('thread-mainloop_8h_source.html','');}); </script> <div id="doc-content"> <div class="header"> <div class="headertitle"> <div class="title">thread-mainloop.h</div> </div> </div><!--header--> <div class="contents"> <a href="thread-mainloop_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> <span class="preprocessor">#ifndef foothreadmainloophfoo</span></div><div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="preprocessor">#define foothreadmainloophfoo</span></div><div class="line"><a name="l00003"></a><span class="lineno"> 3</span> </div><div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="comment">/***</span></div><div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="comment"> This file is part of PulseAudio.</span></div><div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="comment"></span></div><div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="comment"> Copyright 2006 Lennart Poettering</span></div><div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="comment"> Copyright 2006 Pierre Ossman <ossman@cendio.se> for Cendio AB</span></div><div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="comment"></span></div><div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="comment"> PulseAudio is free software; you can redistribute it and/or modify</span></div><div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="comment"> it under the terms of the GNU Lesser General Public License as published</span></div><div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="comment"> by the Free Software Foundation; either version 2.1 of the License,</span></div><div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="comment"> or (at your option) any later version.</span></div><div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="comment"></span></div><div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="comment"> PulseAudio is distributed in the hope that it will be useful, but</span></div><div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="comment"> WITHOUT ANY WARRANTY; without even the implied warranty of</span></div><div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="comment"> MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU</span></div><div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="comment"> General Public License for more details.</span></div><div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="comment"></span></div><div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="comment"> You should have received a copy of the GNU Lesser General Public License</span></div><div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="comment"> along with PulseAudio; if not, see <http://www.gnu.org/licenses/>.</span></div><div class="line"><a name="l00022"></a><span class="lineno"> 22</span> <span class="comment">***/</span></div><div class="line"><a name="l00023"></a><span class="lineno"> 23</span> </div><div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="preprocessor">#include <<a class="code" href="mainloop-api_8h.html">pulse/mainloop-api.h</a>></span></div><div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="preprocessor">#include <pulse/cdecl.h></span></div><div class="line"><a name="l00026"></a><span class="lineno"> 26</span> <span class="preprocessor">#include <<a class="code" href="version_8h.html">pulse/version.h</a>></span></div><div class="line"><a name="l00027"></a><span class="lineno"> 27</span> </div><div class="line"><a name="l00028"></a><span class="lineno"> 28</span> PA_C_DECL_BEGIN</div><div class="line"><a name="l00029"></a><span class="lineno"> 29</span> </div><div class="line"><a name="l00246"></a><span class="lineno"><a class="line" href="thread-mainloop_8h.html#a40393b9b64dc8213bcd5f017344baf74"> 246</a></span> <span class="keyword">typedef</span> <span class="keyword">struct </span><a class="code" href="thread-mainloop_8h.html#a40393b9b64dc8213bcd5f017344baf74">pa_threaded_mainloop</a> <a class="code" href="thread-mainloop_8h.html#a40393b9b64dc8213bcd5f017344baf74">pa_threaded_mainloop</a>;</div><div class="line"><a name="l00247"></a><span class="lineno"> 247</span> </div><div class="line"><a name="l00251"></a><span class="lineno"> 251</span> <a class="code" href="thread-mainloop_8h.html#a40393b9b64dc8213bcd5f017344baf74">pa_threaded_mainloop</a> *<a class="code" href="thread-mainloop_8h.html#a3b8bf5f49d7eb9d6fe6ea008eb6482f2">pa_threaded_mainloop_new</a>(<span class="keywordtype">void</span>);</div><div class="line"><a name="l00252"></a><span class="lineno"> 252</span> </div><div class="line"><a name="l00256"></a><span class="lineno"> 256</span> <span class="keywordtype">void</span> <a class="code" href="thread-mainloop_8h.html#a00afff8173668f12e19d574cd4e4134b">pa_threaded_mainloop_free</a>(<a class="code" href="thread-mainloop_8h.html#a40393b9b64dc8213bcd5f017344baf74">pa_threaded_mainloop</a>* m);</div><div class="line"><a name="l00257"></a><span class="lineno"> 257</span> </div><div class="line"><a name="l00259"></a><span class="lineno"> 259</span> <span class="keywordtype">int</span> <a class="code" href="thread-mainloop_8h.html#a2faf4ddb9a94f74d6e7ef80843e73d30">pa_threaded_mainloop_start</a>(<a class="code" href="thread-mainloop_8h.html#a40393b9b64dc8213bcd5f017344baf74">pa_threaded_mainloop</a> *m);</div><div class="line"><a name="l00260"></a><span class="lineno"> 260</span> </div><div class="line"><a name="l00263"></a><span class="lineno"> 263</span> <span class="keywordtype">void</span> <a class="code" href="thread-mainloop_8h.html#a2a017a59832e81a44aa8989c403fb70e">pa_threaded_mainloop_stop</a>(<a class="code" href="thread-mainloop_8h.html#a40393b9b64dc8213bcd5f017344baf74">pa_threaded_mainloop</a> *m);</div><div class="line"><a name="l00264"></a><span class="lineno"> 264</span> </div><div class="line"><a name="l00271"></a><span class="lineno"> 271</span> <span class="keywordtype">void</span> <a class="code" href="thread-mainloop_8h.html#a2fd002f510ed24cabacb63a26bf4c977">pa_threaded_mainloop_lock</a>(<a class="code" href="thread-mainloop_8h.html#a40393b9b64dc8213bcd5f017344baf74">pa_threaded_mainloop</a> *m);</div><div class="line"><a name="l00272"></a><span class="lineno"> 272</span> </div><div class="line"><a name="l00274"></a><span class="lineno"> 274</span> <span class="keywordtype">void</span> <a class="code" href="thread-mainloop_8h.html#ab2b2beaa3a66135da67d61db211f0829">pa_threaded_mainloop_unlock</a>(<a class="code" href="thread-mainloop_8h.html#a40393b9b64dc8213bcd5f017344baf74">pa_threaded_mainloop</a> *m);</div><div class="line"><a name="l00275"></a><span class="lineno"> 275</span> </div><div class="line"><a name="l00285"></a><span class="lineno"> 285</span> <span class="keywordtype">void</span> <a class="code" href="thread-mainloop_8h.html#ac96d19260567d0406350f1b3a14c4bed">pa_threaded_mainloop_wait</a>(<a class="code" href="thread-mainloop_8h.html#a40393b9b64dc8213bcd5f017344baf74">pa_threaded_mainloop</a> *m);</div><div class="line"><a name="l00286"></a><span class="lineno"> 286</span> </div><div class="line"><a name="l00292"></a><span class="lineno"> 292</span> <span class="keywordtype">void</span> <a class="code" href="thread-mainloop_8h.html#ad253b70911af81c04417793841a15766">pa_threaded_mainloop_signal</a>(<a class="code" href="thread-mainloop_8h.html#a40393b9b64dc8213bcd5f017344baf74">pa_threaded_mainloop</a> *m, <span class="keywordtype">int</span> wait_for_accept);</div><div class="line"><a name="l00293"></a><span class="lineno"> 293</span> </div><div class="line"><a name="l00298"></a><span class="lineno"> 298</span> <span class="keywordtype">void</span> <a class="code" href="thread-mainloop_8h.html#a254b0862e30845a4b0427a7a74b3db91">pa_threaded_mainloop_accept</a>(<a class="code" href="thread-mainloop_8h.html#a40393b9b64dc8213bcd5f017344baf74">pa_threaded_mainloop</a> *m);</div><div class="line"><a name="l00299"></a><span class="lineno"> 299</span> </div><div class="line"><a name="l00302"></a><span class="lineno"> 302</span> <span class="keywordtype">int</span> <a class="code" href="thread-mainloop_8h.html#a487aaf9946ccddbd54c68a6c3fb3fe39">pa_threaded_mainloop_get_retval</a>(<a class="code" href="thread-mainloop_8h.html#a40393b9b64dc8213bcd5f017344baf74">pa_threaded_mainloop</a> *m);</div><div class="line"><a name="l00303"></a><span class="lineno"> 303</span> </div><div class="line"><a name="l00307"></a><span class="lineno"> 307</span> <a class="code" href="structpa__mainloop__api.html">pa_mainloop_api</a>* <a class="code" href="thread-mainloop_8h.html#aab3c05099eafa9947aa7894af2f79fda">pa_threaded_mainloop_get_api</a>(<a class="code" href="thread-mainloop_8h.html#a40393b9b64dc8213bcd5f017344baf74">pa_threaded_mainloop</a>*m);</div><div class="line"><a name="l00308"></a><span class="lineno"> 308</span> </div><div class="line"><a name="l00310"></a><span class="lineno"> 310</span> <span class="keywordtype">int</span> <a class="code" href="thread-mainloop_8h.html#a7a5f04b51cc3011de90e1490c8baacd0">pa_threaded_mainloop_in_thread</a>(<a class="code" href="thread-mainloop_8h.html#a40393b9b64dc8213bcd5f017344baf74">pa_threaded_mainloop</a> *m);</div><div class="line"><a name="l00311"></a><span class="lineno"> 311</span> </div><div class="line"><a name="l00313"></a><span class="lineno"> 313</span> <span class="keywordtype">void</span> <a class="code" href="thread-mainloop_8h.html#ab44d948b5091a906640e4b33ee3d0983">pa_threaded_mainloop_set_name</a>(<a class="code" href="thread-mainloop_8h.html#a40393b9b64dc8213bcd5f017344baf74">pa_threaded_mainloop</a> *m, <span class="keyword">const</span> <span class="keywordtype">char</span> *name);</div><div class="line"><a name="l00314"></a><span class="lineno"> 314</span> </div><div class="line"><a name="l00315"></a><span class="lineno"> 315</span> PA_C_DECL_END</div><div class="line"><a name="l00316"></a><span class="lineno"> 316</span> </div><div class="line"><a name="l00317"></a><span class="lineno"> 317</span> <span class="preprocessor">#endif</span></div><div class="ttc" id="structpa__mainloop__api_html"><div class="ttname"><a href="structpa__mainloop__api.html">pa_mainloop_api</a></div><div class="ttdoc">An abstract mainloop API vtable. </div><div class="ttdef"><b>Definition:</b> mainloop-api.h:80</div></div> <div class="ttc" id="thread-mainloop_8h_html_a40393b9b64dc8213bcd5f017344baf74"><div class="ttname"><a href="thread-mainloop_8h.html#a40393b9b64dc8213bcd5f017344baf74">pa_threaded_mainloop</a></div><div class="ttdeci">struct pa_threaded_mainloop pa_threaded_mainloop</div><div class="ttdoc">An opaque threaded main loop object. </div><div class="ttdef"><b>Definition:</b> thread-mainloop.h:246</div></div> <div class="ttc" id="thread-mainloop_8h_html_a254b0862e30845a4b0427a7a74b3db91"><div class="ttname"><a href="thread-mainloop_8h.html#a254b0862e30845a4b0427a7a74b3db91">pa_threaded_mainloop_accept</a></div><div class="ttdeci">void pa_threaded_mainloop_accept(pa_threaded_mainloop *m)</div><div class="ttdoc">Accept a signal from the event thread issued with pa_threaded_mainloop_signal(). </div></div> <div class="ttc" id="mainloop-api_8h_html"><div class="ttname"><a href="mainloop-api_8h.html">mainloop-api.h</a></div><div class="ttdoc">Main loop abstraction layer. </div></div> <div class="ttc" id="thread-mainloop_8h_html_a2a017a59832e81a44aa8989c403fb70e"><div class="ttname"><a href="thread-mainloop_8h.html#a2a017a59832e81a44aa8989c403fb70e">pa_threaded_mainloop_stop</a></div><div class="ttdeci">void pa_threaded_mainloop_stop(pa_threaded_mainloop *m)</div><div class="ttdoc">Terminate the event loop thread cleanly. </div></div> <div class="ttc" id="thread-mainloop_8h_html_a7a5f04b51cc3011de90e1490c8baacd0"><div class="ttname"><a href="thread-mainloop_8h.html#a7a5f04b51cc3011de90e1490c8baacd0">pa_threaded_mainloop_in_thread</a></div><div class="ttdeci">int pa_threaded_mainloop_in_thread(pa_threaded_mainloop *m)</div><div class="ttdoc">Returns non-zero when called from within the event loop thread. </div></div> <div class="ttc" id="thread-mainloop_8h_html_ac96d19260567d0406350f1b3a14c4bed"><div class="ttname"><a href="thread-mainloop_8h.html#ac96d19260567d0406350f1b3a14c4bed">pa_threaded_mainloop_wait</a></div><div class="ttdeci">void pa_threaded_mainloop_wait(pa_threaded_mainloop *m)</div><div class="ttdoc">Wait for an event to be signalled by the event loop thread. </div></div> <div class="ttc" id="thread-mainloop_8h_html_a00afff8173668f12e19d574cd4e4134b"><div class="ttname"><a href="thread-mainloop_8h.html#a00afff8173668f12e19d574cd4e4134b">pa_threaded_mainloop_free</a></div><div class="ttdeci">void pa_threaded_mainloop_free(pa_threaded_mainloop *m)</div><div class="ttdoc">Free a threaded main loop object. </div></div> <div class="ttc" id="thread-mainloop_8h_html_a2faf4ddb9a94f74d6e7ef80843e73d30"><div class="ttname"><a href="thread-mainloop_8h.html#a2faf4ddb9a94f74d6e7ef80843e73d30">pa_threaded_mainloop_start</a></div><div class="ttdeci">int pa_threaded_mainloop_start(pa_threaded_mainloop *m)</div><div class="ttdoc">Start the event loop thread. </div></div> <div class="ttc" id="thread-mainloop_8h_html_a3b8bf5f49d7eb9d6fe6ea008eb6482f2"><div class="ttname"><a href="thread-mainloop_8h.html#a3b8bf5f49d7eb9d6fe6ea008eb6482f2">pa_threaded_mainloop_new</a></div><div class="ttdeci">pa_threaded_mainloop * pa_threaded_mainloop_new(void)</div><div class="ttdoc">Allocate a new threaded main loop object. </div></div> <div class="ttc" id="version_8h_html"><div class="ttname"><a href="version_8h.html">version.h</a></div><div class="ttdoc">Define header version. </div></div> <div class="ttc" id="thread-mainloop_8h_html_a2fd002f510ed24cabacb63a26bf4c977"><div class="ttname"><a href="thread-mainloop_8h.html#a2fd002f510ed24cabacb63a26bf4c977">pa_threaded_mainloop_lock</a></div><div class="ttdeci">void pa_threaded_mainloop_lock(pa_threaded_mainloop *m)</div><div class="ttdoc">Lock the event loop object, effectively blocking the event loop thread from processing events...</div></div> <div class="ttc" id="thread-mainloop_8h_html_aab3c05099eafa9947aa7894af2f79fda"><div class="ttname"><a href="thread-mainloop_8h.html#aab3c05099eafa9947aa7894af2f79fda">pa_threaded_mainloop_get_api</a></div><div class="ttdeci">pa_mainloop_api * pa_threaded_mainloop_get_api(pa_threaded_mainloop *m)</div><div class="ttdoc">Return the main loop abstraction layer vtable for this main loop. </div></div> <div class="ttc" id="thread-mainloop_8h_html_a487aaf9946ccddbd54c68a6c3fb3fe39"><div class="ttname"><a href="thread-mainloop_8h.html#a487aaf9946ccddbd54c68a6c3fb3fe39">pa_threaded_mainloop_get_retval</a></div><div class="ttdeci">int pa_threaded_mainloop_get_retval(pa_threaded_mainloop *m)</div><div class="ttdoc">Return the return value as specified with the main loop&#39;s pa_mainloop_quit() routine. </div></div> <div class="ttc" id="thread-mainloop_8h_html_ad253b70911af81c04417793841a15766"><div class="ttname"><a href="thread-mainloop_8h.html#ad253b70911af81c04417793841a15766">pa_threaded_mainloop_signal</a></div><div class="ttdeci">void pa_threaded_mainloop_signal(pa_threaded_mainloop *m, int wait_for_accept)</div><div class="ttdoc">Signal all threads waiting for a signalling event in pa_threaded_mainloop_wait(). ...</div></div> <div class="ttc" id="thread-mainloop_8h_html_ab44d948b5091a906640e4b33ee3d0983"><div class="ttname"><a href="thread-mainloop_8h.html#ab44d948b5091a906640e4b33ee3d0983">pa_threaded_mainloop_set_name</a></div><div class="ttdeci">void pa_threaded_mainloop_set_name(pa_threaded_mainloop *m, const char *name)</div><div class="ttdoc">Sets the name of the thread. </div></div> <div class="ttc" id="thread-mainloop_8h_html_ab2b2beaa3a66135da67d61db211f0829"><div class="ttname"><a href="thread-mainloop_8h.html#ab2b2beaa3a66135da67d61db211f0829">pa_threaded_mainloop_unlock</a></div><div class="ttdeci">void pa_threaded_mainloop_unlock(pa_threaded_mainloop *m)</div><div class="ttdoc">Unlock the event loop object, inverse of pa_threaded_mainloop_lock(). </div></div> </div><!-- fragment --></div><!-- contents --> </div><!-- doc-content --> <!-- start footer part --> <div id="nav-path" class="navpath"><!-- id is needed for treeview function! --> <ul> <li class="navelem"><a class="el" href="dir_68267d1309a1af8e8297ef4c3efbcdba.html">src</a></li><li class="navelem"><a class="el" href="dir_ec5b0a79aff2db41fe5d1b9326f09c28.html">pulse</a></li><li class="navelem"><a class="el" href="thread-mainloop_8h.html">thread-mainloop.h</a></li> <li class="footer">Generated by <a href="http://www.doxygen.org/index.html"> <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.13 </li> </ul> </div> </body> </html>