| Current File : //kunden/usr/share/doc/pulseaudio-libs-devel/html/mainloop_8h_source.html |
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://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.9.1"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>PulseAudio: 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>
<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">15.0</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.1 -->
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
$(function() {
initMenu('',false,false,'search.php','Search');
});
/* @license-end */</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">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function(){initNavTree('mainloop_8h_source.html',''); initResizable(); });
/* @license-end */
</script>
<div id="doc-content">
<div class="header">
<div class="headertitle">
<div class="title">mainloop.h</div> </div>
</div><!--header-->
<div class="contents">
<a href="mainloop_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"><a class="line" href="mainloop_8h.html#aadf8d428d3e2f00ed762017c7b587cc9"> 1</a></span> <span class="preprocessor">#ifndef foomainloophfoo</span></div>
<div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="preprocessor">#define foomainloophfoo</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 2004-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>  </div>
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span> PA_C_DECL_BEGIN</div>
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span>  </div>
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span> <span class="keyword">struct </span>pollfd;</div>
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span>  </div>
<div class="line"><a name="l00078"></a><span class="lineno"> 78</span> <span class="keyword">typedef</span> <span class="keyword">struct </span><a class="code" href="mainloop_8h.html#aadf8d428d3e2f00ed762017c7b587cc9">pa_mainloop</a> <a class="code" href="mainloop_8h.html#aadf8d428d3e2f00ed762017c7b587cc9">pa_mainloop</a>;</div>
<div class="line"><a name="l00079"></a><span class="lineno"> 79</span>  </div>
<div class="line"><a name="l00081"></a><span class="lineno"><a class="line" href="mainloop_8h.html#ad6c767781474275159c0a5f3f7e2ecb5"> 81</a></span> <a class="code" href="mainloop_8h.html#aadf8d428d3e2f00ed762017c7b587cc9">pa_mainloop</a> *<a class="code" href="mainloop_8h.html#ad6c767781474275159c0a5f3f7e2ecb5">pa_mainloop_new</a>(<span class="keywordtype">void</span>);</div>
<div class="line"><a name="l00082"></a><span class="lineno"> 82</span>  </div>
<div class="line"><a name="l00084"></a><span class="lineno"><a class="line" href="mainloop_8h.html#a6c6ea37ce2815640f7f1a133f845f8e7"> 84</a></span> <span class="keywordtype">void</span> <a class="code" href="mainloop_8h.html#a6c6ea37ce2815640f7f1a133f845f8e7">pa_mainloop_free</a>(<a class="code" href="mainloop_8h.html#aadf8d428d3e2f00ed762017c7b587cc9">pa_mainloop</a>* m);</div>
<div class="line"><a name="l00085"></a><span class="lineno"> 85</span>  </div>
<div class="line"><a name="l00089"></a><span class="lineno"><a class="line" href="mainloop_8h.html#a217ce134af601c1c6ce77c41c99fc0d2"> 89</a></span> <span class="keywordtype">int</span> <a class="code" href="mainloop_8h.html#a217ce134af601c1c6ce77c41c99fc0d2">pa_mainloop_prepare</a>(<a class="code" href="mainloop_8h.html#aadf8d428d3e2f00ed762017c7b587cc9">pa_mainloop</a> *m, <span class="keywordtype">int</span> timeout);</div>
<div class="line"><a name="l00090"></a><span class="lineno"> 90</span>  </div>
<div class="line"><a name="l00092"></a><span class="lineno"><a class="line" href="mainloop_8h.html#a9195049c1bd136be73ce0e628523a2df"> 92</a></span> <span class="keywordtype">int</span> <a class="code" href="mainloop_8h.html#a9195049c1bd136be73ce0e628523a2df">pa_mainloop_poll</a>(<a class="code" href="mainloop_8h.html#aadf8d428d3e2f00ed762017c7b587cc9">pa_mainloop</a> *m);</div>
<div class="line"><a name="l00093"></a><span class="lineno"> 93</span>  </div>
<div class="line"><a name="l00096"></a><span class="lineno"><a class="line" href="mainloop_8h.html#abada884366e125a052bae5f6a4a7481e"> 96</a></span> <span class="keywordtype">int</span> <a class="code" href="mainloop_8h.html#abada884366e125a052bae5f6a4a7481e">pa_mainloop_dispatch</a>(<a class="code" href="mainloop_8h.html#aadf8d428d3e2f00ed762017c7b587cc9">pa_mainloop</a> *m);</div>
<div class="line"><a name="l00097"></a><span class="lineno"> 97</span>  </div>
<div class="line"><a name="l00099"></a><span class="lineno"><a class="line" href="mainloop_8h.html#a22d124316bd08dd543009f83695d5571"> 99</a></span> <span class="keywordtype">int</span> <a class="code" href="mainloop_8h.html#a22d124316bd08dd543009f83695d5571">pa_mainloop_get_retval</a>(<span class="keyword">const</span> <a class="code" href="mainloop_8h.html#aadf8d428d3e2f00ed762017c7b587cc9">pa_mainloop</a> *m);</div>
<div class="line"><a name="l00100"></a><span class="lineno"> 100</span>  </div>
<div class="line"><a name="l00107"></a><span class="lineno"><a class="line" href="mainloop_8h.html#a491422aebe5487800d8be0bf4153cb81"> 107</a></span> <span class="keywordtype">int</span> <a class="code" href="mainloop_8h.html#a491422aebe5487800d8be0bf4153cb81">pa_mainloop_iterate</a>(<a class="code" href="mainloop_8h.html#aadf8d428d3e2f00ed762017c7b587cc9">pa_mainloop</a> *m, <span class="keywordtype">int</span> block, <span class="keywordtype">int</span> *retval);</div>
<div class="line"><a name="l00108"></a><span class="lineno"> 108</span>  </div>
<div class="line"><a name="l00113"></a><span class="lineno"><a class="line" href="mainloop_8h.html#afbcd8f4eba09cdfd5323ac9db3718ae8"> 113</a></span> <span class="keywordtype">int</span> <a class="code" href="mainloop_8h.html#afbcd8f4eba09cdfd5323ac9db3718ae8">pa_mainloop_run</a>(<a class="code" href="mainloop_8h.html#aadf8d428d3e2f00ed762017c7b587cc9">pa_mainloop</a> *m, <span class="keywordtype">int</span> *retval);</div>
<div class="line"><a name="l00114"></a><span class="lineno"> 114</span>  </div>
<div class="line"><a name="l00118"></a><span class="lineno"><a class="line" href="mainloop_8h.html#a9e5b510dabb4eb1a01645c4db65b9ddb"> 118</a></span> <a class="code" href="structpa__mainloop__api.html">pa_mainloop_api</a>* <a class="code" href="mainloop_8h.html#a9e5b510dabb4eb1a01645c4db65b9ddb">pa_mainloop_get_api</a>(<a class="code" href="mainloop_8h.html#aadf8d428d3e2f00ed762017c7b587cc9">pa_mainloop</a>*m);</div>
<div class="line"><a name="l00119"></a><span class="lineno"> 119</span>  </div>
<div class="line"><a name="l00121"></a><span class="lineno"><a class="line" href="mainloop_8h.html#a3000eb1bacba8773424a779cbbb12572"> 121</a></span> <span class="keywordtype">void</span> <a class="code" href="mainloop_8h.html#a3000eb1bacba8773424a779cbbb12572">pa_mainloop_quit</a>(<a class="code" href="mainloop_8h.html#aadf8d428d3e2f00ed762017c7b587cc9">pa_mainloop</a> *m, <span class="keywordtype">int</span> retval);</div>
<div class="line"><a name="l00122"></a><span class="lineno"> 122</span>  </div>
<div class="line"><a name="l00124"></a><span class="lineno"><a class="line" href="mainloop_8h.html#a2a81af2882e0c806308b20b97ca5473e"> 124</a></span> <span class="keywordtype">void</span> <a class="code" href="mainloop_8h.html#a2a81af2882e0c806308b20b97ca5473e">pa_mainloop_wakeup</a>(<a class="code" href="mainloop_8h.html#aadf8d428d3e2f00ed762017c7b587cc9">pa_mainloop</a> *m);</div>
<div class="line"><a name="l00125"></a><span class="lineno"> 125</span>  </div>
<div class="line"><a name="l00127"></a><span class="lineno"><a class="line" href="mainloop_8h.html#aa39d2a51b19fffe587a591a6637a49bf"> 127</a></span> <span class="keyword">typedef</span> int (*<a class="code" href="mainloop_8h.html#aa39d2a51b19fffe587a591a6637a49bf">pa_poll_func</a>)(<span class="keyword">struct </span>pollfd *ufds, <span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> nfds, <span class="keywordtype">int</span> timeout, <span class="keywordtype">void</span>*userdata);</div>
<div class="line"><a name="l00128"></a><span class="lineno"> 128</span>  </div>
<div class="line"><a name="l00130"></a><span class="lineno"><a class="line" href="mainloop_8h.html#ae51c490c29106c0c3b020020c6dc015d"> 130</a></span> <span class="keywordtype">void</span> <a class="code" href="mainloop_8h.html#ae51c490c29106c0c3b020020c6dc015d">pa_mainloop_set_poll_func</a>(<a class="code" href="mainloop_8h.html#aadf8d428d3e2f00ed762017c7b587cc9">pa_mainloop</a> *m, <a class="code" href="mainloop_8h.html#aa39d2a51b19fffe587a591a6637a49bf">pa_poll_func</a> poll_func, <span class="keywordtype">void</span> *userdata);</div>
<div class="line"><a name="l00131"></a><span class="lineno"> 131</span>  </div>
<div class="line"><a name="l00132"></a><span class="lineno"> 132</span> PA_C_DECL_END</div>
<div class="line"><a name="l00133"></a><span class="lineno"> 133</span>  </div>
<div class="line"><a name="l00134"></a><span class="lineno"> 134</span> <span class="preprocessor">#endif</span></div>
<div class="ttc" id="amainloop-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="amainloop_8h_html_a217ce134af601c1c6ce77c41c99fc0d2"><div class="ttname"><a href="mainloop_8h.html#a217ce134af601c1c6ce77c41c99fc0d2">pa_mainloop_prepare</a></div><div class="ttdeci">int pa_mainloop_prepare(pa_mainloop *m, int timeout)</div><div class="ttdoc">Prepare for a single iteration of the main loop.</div></div>
<div class="ttc" id="amainloop_8h_html_a22d124316bd08dd543009f83695d5571"><div class="ttname"><a href="mainloop_8h.html#a22d124316bd08dd543009f83695d5571">pa_mainloop_get_retval</a></div><div class="ttdeci">int pa_mainloop_get_retval(const pa_mainloop *m)</div><div class="ttdoc">Return the return value as specified with the main loop's quit() routine.</div></div>
<div class="ttc" id="amainloop_8h_html_a2a81af2882e0c806308b20b97ca5473e"><div class="ttname"><a href="mainloop_8h.html#a2a81af2882e0c806308b20b97ca5473e">pa_mainloop_wakeup</a></div><div class="ttdeci">void pa_mainloop_wakeup(pa_mainloop *m)</div><div class="ttdoc">Interrupt a running poll (for threaded systems)</div></div>
<div class="ttc" id="amainloop_8h_html_a3000eb1bacba8773424a779cbbb12572"><div class="ttname"><a href="mainloop_8h.html#a3000eb1bacba8773424a779cbbb12572">pa_mainloop_quit</a></div><div class="ttdeci">void pa_mainloop_quit(pa_mainloop *m, int retval)</div><div class="ttdoc">Shutdown the main loop with the specified return value.</div></div>
<div class="ttc" id="amainloop_8h_html_a491422aebe5487800d8be0bf4153cb81"><div class="ttname"><a href="mainloop_8h.html#a491422aebe5487800d8be0bf4153cb81">pa_mainloop_iterate</a></div><div class="ttdeci">int pa_mainloop_iterate(pa_mainloop *m, int block, int *retval)</div><div class="ttdoc">Run a single iteration of the main loop.</div></div>
<div class="ttc" id="amainloop_8h_html_a6c6ea37ce2815640f7f1a133f845f8e7"><div class="ttname"><a href="mainloop_8h.html#a6c6ea37ce2815640f7f1a133f845f8e7">pa_mainloop_free</a></div><div class="ttdeci">void pa_mainloop_free(pa_mainloop *m)</div><div class="ttdoc">Free a main loop object.</div></div>
<div class="ttc" id="amainloop_8h_html_a9195049c1bd136be73ce0e628523a2df"><div class="ttname"><a href="mainloop_8h.html#a9195049c1bd136be73ce0e628523a2df">pa_mainloop_poll</a></div><div class="ttdeci">int pa_mainloop_poll(pa_mainloop *m)</div><div class="ttdoc">Execute the previously prepared poll.</div></div>
<div class="ttc" id="amainloop_8h_html_a9e5b510dabb4eb1a01645c4db65b9ddb"><div class="ttname"><a href="mainloop_8h.html#a9e5b510dabb4eb1a01645c4db65b9ddb">pa_mainloop_get_api</a></div><div class="ttdeci">pa_mainloop_api * pa_mainloop_get_api(pa_mainloop *m)</div><div class="ttdoc">Return the abstract main loop abstraction layer vtable for this main loop.</div></div>
<div class="ttc" id="amainloop_8h_html_aa39d2a51b19fffe587a591a6637a49bf"><div class="ttname"><a href="mainloop_8h.html#aa39d2a51b19fffe587a591a6637a49bf">pa_poll_func</a></div><div class="ttdeci">int(* pa_poll_func)(struct pollfd *ufds, unsigned long nfds, int timeout, void *userdata)</div><div class="ttdoc">Generic prototype of a poll() like function.</div><div class="ttdef"><b>Definition:</b> mainloop.h:127</div></div>
<div class="ttc" id="amainloop_8h_html_aadf8d428d3e2f00ed762017c7b587cc9"><div class="ttname"><a href="mainloop_8h.html#aadf8d428d3e2f00ed762017c7b587cc9">pa_mainloop</a></div><div class="ttdeci">struct pa_mainloop pa_mainloop</div><div class="ttdoc">An opaque main loop object.</div><div class="ttdef"><b>Definition:</b> mainloop.h:78</div></div>
<div class="ttc" id="amainloop_8h_html_abada884366e125a052bae5f6a4a7481e"><div class="ttname"><a href="mainloop_8h.html#abada884366e125a052bae5f6a4a7481e">pa_mainloop_dispatch</a></div><div class="ttdeci">int pa_mainloop_dispatch(pa_mainloop *m)</div><div class="ttdoc">Dispatch timeout, io and deferred events from the previously executed poll.</div></div>
<div class="ttc" id="amainloop_8h_html_ad6c767781474275159c0a5f3f7e2ecb5"><div class="ttname"><a href="mainloop_8h.html#ad6c767781474275159c0a5f3f7e2ecb5">pa_mainloop_new</a></div><div class="ttdeci">pa_mainloop * pa_mainloop_new(void)</div><div class="ttdoc">Allocate a new main loop object.</div></div>
<div class="ttc" id="amainloop_8h_html_ae51c490c29106c0c3b020020c6dc015d"><div class="ttname"><a href="mainloop_8h.html#ae51c490c29106c0c3b020020c6dc015d">pa_mainloop_set_poll_func</a></div><div class="ttdeci">void pa_mainloop_set_poll_func(pa_mainloop *m, pa_poll_func poll_func, void *userdata)</div><div class="ttdoc">Change the poll() implementation.</div></div>
<div class="ttc" id="amainloop_8h_html_afbcd8f4eba09cdfd5323ac9db3718ae8"><div class="ttname"><a href="mainloop_8h.html#afbcd8f4eba09cdfd5323ac9db3718ae8">pa_mainloop_run</a></div><div class="ttdeci">int pa_mainloop_run(pa_mainloop *m, int *retval)</div><div class="ttdoc">Run unlimited iterations of the main loop object until the main loop's quit() routine is called.</div></div>
<div class="ttc" id="astructpa__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:87</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="mainloop_8h.html">mainloop.h</a></li>
<li class="footer">Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.1 </li>
</ul>
</div>
</body>
</html>