<!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.3"/> <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="navtree.js"></script> <script type="text/javascript"> $(document).ready(initResizable); $(window).load(resizeHeight); </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 style="padding-left: 0.5em;"> <div id="projectname">PulseAudio  <span id="projectnumber">2.1</span> </div> </td> </tr> </tbody> </table> </div> <!-- end header part --> <!-- Generated by Doxygen 1.8.3 --> <div id="navrow1" class="tabs"> <ul class="tablist"> <li><a href="index.html"><span>Main Page</span></a></li> <li><a href="pages.html"><span>Related Pages</span></a></li> <li><a href="annotated.html"><span>Data Structures</span></a></li> <li class="current"><a href="files.html"><span>Files</span></a></li> <li><a href="examples.html"><span>Examples</span></a></li> </ul> </div> <div id="navrow2" class="tabs2"> <ul class="tablist"> <li><a href="files.html"><span>File List</span></a></li> <li><a href="globals.html"><span>Globals</span></a></li> </ul> </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('mainloop_8h_source.html','');}); </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"> 1</span> <span class="preprocessor">#ifndef foomainloophfoo</span></div> <div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="preprocessor"></span><span class="preprocessor">#define foomainloophfoo</span></div> <div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="preprocessor"></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, write to the Free Software</span></div> <div class="line"><a name="l00022"></a><span class="lineno"> 22</span> <span class="comment"> Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307</span></div> <div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="comment"> USA.</span></div> <div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="comment">***/</span></div> <div class="line"><a name="l00025"></a><span class="lineno"> 25</span> </div> <div class="line"><a name="l00026"></a><span class="lineno"> 26</span> <span class="preprocessor">#include <<a class="code" href="mainloop-api_8h.html" title="Main loop abstraction layer.">pulse/mainloop-api.h</a>></span></div> <div class="line"><a name="l00027"></a><span class="lineno"> 27</span> <span class="preprocessor">#include <pulse/cdecl.h></span></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> PA_C_DECL_BEGIN</div> <div class="line"><a name="l00030"></a><span class="lineno"> 30</span> </div> <div class="line"><a name="l00031"></a><span class="lineno"> 31</span> <span class="keyword">struct </span>pollfd;</div> <div class="line"><a name="l00032"></a><span class="lineno"> 32</span> </div> <div class="line"><a name="l00080"></a><span class="lineno"><a class="code" href="mainloop_8h.html#aadf8d428d3e2f00ed762017c7b587cc9"> 80</a></span> <span class="keyword">typedef</span> <span class="keyword">struct </span><a class="code" href="mainloop_8h.html#aadf8d428d3e2f00ed762017c7b587cc9" title="An opaque main loop object.">pa_mainloop</a> <a class="code" href="mainloop_8h.html#aadf8d428d3e2f00ed762017c7b587cc9" title="An opaque main loop object.">pa_mainloop</a>;</div> <div class="line"><a name="l00081"></a><span class="lineno"> 81</span> </div> <div class="line"><a name="l00083"></a><span class="lineno"> 83</span> <a class="code" href="mainloop_8h.html#aadf8d428d3e2f00ed762017c7b587cc9" title="An opaque main loop object.">pa_mainloop</a> *<a class="code" href="mainloop_8h.html#ad6c767781474275159c0a5f3f7e2ecb5" title="Allocate a new main loop object.">pa_mainloop_new</a>(<span class="keywordtype">void</span>);</div> <div class="line"><a name="l00084"></a><span class="lineno"> 84</span> </div> <div class="line"><a name="l00086"></a><span class="lineno"> 86</span> <span class="keywordtype">void</span> <a class="code" href="mainloop_8h.html#a6c6ea37ce2815640f7f1a133f845f8e7" title="Free a main loop object.">pa_mainloop_free</a>(<a class="code" href="mainloop_8h.html#aadf8d428d3e2f00ed762017c7b587cc9" title="An opaque main loop object.">pa_mainloop</a>* m);</div> <div class="line"><a name="l00087"></a><span class="lineno"> 87</span> </div> <div class="line"><a name="l00091"></a><span class="lineno"> 91</span> <span class="keywordtype">int</span> <a class="code" href="mainloop_8h.html#a217ce134af601c1c6ce77c41c99fc0d2" title="Prepare for a single iteration of the main loop.">pa_mainloop_prepare</a>(<a class="code" href="mainloop_8h.html#aadf8d428d3e2f00ed762017c7b587cc9" title="An opaque main loop object.">pa_mainloop</a> *m, <span class="keywordtype">int</span> timeout);</div> <div class="line"><a name="l00092"></a><span class="lineno"> 92</span> </div> <div class="line"><a name="l00094"></a><span class="lineno"> 94</span> <span class="keywordtype">int</span> <a class="code" href="mainloop_8h.html#a9195049c1bd136be73ce0e628523a2df" title="Execute the previously prepared poll.">pa_mainloop_poll</a>(<a class="code" href="mainloop_8h.html#aadf8d428d3e2f00ed762017c7b587cc9" title="An opaque main loop object.">pa_mainloop</a> *m);</div> <div class="line"><a name="l00095"></a><span class="lineno"> 95</span> </div> <div class="line"><a name="l00098"></a><span class="lineno"> 98</span> <span class="keywordtype">int</span> <a class="code" href="mainloop_8h.html#abada884366e125a052bae5f6a4a7481e" title="Dispatch timeout, io and deferred events from the previously executed poll.">pa_mainloop_dispatch</a>(<a class="code" href="mainloop_8h.html#aadf8d428d3e2f00ed762017c7b587cc9" title="An opaque main loop object.">pa_mainloop</a> *m);</div> <div class="line"><a name="l00099"></a><span class="lineno"> 99</span> </div> <div class="line"><a name="l00101"></a><span class="lineno"> 101</span> <span class="keywordtype">int</span> <a class="code" href="mainloop_8h.html#a70065fd3ab808bde3892bf08a8c5f51b" title="Return the return value as specified with the main loop's quit() routine.">pa_mainloop_get_retval</a>(<a class="code" href="mainloop_8h.html#aadf8d428d3e2f00ed762017c7b587cc9" title="An opaque main loop object.">pa_mainloop</a> *m);</div> <div class="line"><a name="l00102"></a><span class="lineno"> 102</span> </div> <div class="line"><a name="l00109"></a><span class="lineno"> 109</span> <span class="keywordtype">int</span> <a class="code" href="mainloop_8h.html#a491422aebe5487800d8be0bf4153cb81" title="Run a single iteration of the main loop.">pa_mainloop_iterate</a>(<a class="code" href="mainloop_8h.html#aadf8d428d3e2f00ed762017c7b587cc9" title="An opaque main loop object.">pa_mainloop</a> *m, <span class="keywordtype">int</span> block, <span class="keywordtype">int</span> *retval);</div> <div class="line"><a name="l00110"></a><span class="lineno"> 110</span> </div> <div class="line"><a name="l00112"></a><span class="lineno"> 112</span> <span class="keywordtype">int</span> <a class="code" href="mainloop_8h.html#afbcd8f4eba09cdfd5323ac9db3718ae8" title="Run unlimited iterations of the main loop object until the main loop's quit() routine is called...">pa_mainloop_run</a>(<a class="code" href="mainloop_8h.html#aadf8d428d3e2f00ed762017c7b587cc9" title="An opaque main loop object.">pa_mainloop</a> *m, <span class="keywordtype">int</span> *retval);</div> <div class="line"><a name="l00113"></a><span class="lineno"> 113</span> </div> <div class="line"><a name="l00117"></a><span class="lineno"> 117</span> <a class="code" href="structpa__mainloop__api.html" title="An abstract mainloop API vtable.">pa_mainloop_api</a>* <a class="code" href="mainloop_8h.html#a9e5b510dabb4eb1a01645c4db65b9ddb" title="Return the abstract main loop abstraction layer vtable for this main loop.">pa_mainloop_get_api</a>(<a class="code" href="mainloop_8h.html#aadf8d428d3e2f00ed762017c7b587cc9" title="An opaque main loop object.">pa_mainloop</a>*m);</div> <div class="line"><a name="l00118"></a><span class="lineno"> 118</span> </div> <div class="line"><a name="l00120"></a><span class="lineno"> 120</span> <span class="keywordtype">void</span> <a class="code" href="mainloop_8h.html#a906bbc80037677a05a1dc73a33a30a44" title="Shutdown the main loop.">pa_mainloop_quit</a>(<a class="code" href="mainloop_8h.html#aadf8d428d3e2f00ed762017c7b587cc9" title="An opaque main loop object.">pa_mainloop</a> *m, <span class="keywordtype">int</span> r);</div> <div class="line"><a name="l00121"></a><span class="lineno"> 121</span> </div> <div class="line"><a name="l00123"></a><span class="lineno"> 123</span> <span class="keywordtype">void</span> <a class="code" href="mainloop_8h.html#a2a81af2882e0c806308b20b97ca5473e" title="Interrupt a running poll (for threaded systems)">pa_mainloop_wakeup</a>(<a class="code" href="mainloop_8h.html#aadf8d428d3e2f00ed762017c7b587cc9" title="An opaque main loop object.">pa_mainloop</a> *m);</div> <div class="line"><a name="l00124"></a><span class="lineno"> 124</span> </div> <div class="line"><a name="l00126"></a><span class="lineno"><a class="code" href="mainloop_8h.html#abe53a62e351d3f15f865fb20973b3ce1"> 126</a></span> <span class="keyword">typedef</span> int (*<a class="code" href="mainloop_8h.html#abe53a62e351d3f15f865fb20973b3ce1" title="Generic prototype of a poll() like function.">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="l00127"></a><span class="lineno"> 127</span> </div> <div class="line"><a name="l00129"></a><span class="lineno"> 129</span> <span class="keywordtype">void</span> <a class="code" href="mainloop_8h.html#ae51c490c29106c0c3b020020c6dc015d" title="Change the poll() implementation.">pa_mainloop_set_poll_func</a>(<a class="code" href="mainloop_8h.html#aadf8d428d3e2f00ed762017c7b587cc9" title="An opaque main loop object.">pa_mainloop</a> *m, <a class="code" href="mainloop_8h.html#abe53a62e351d3f15f865fb20973b3ce1" title="Generic prototype of a poll() like function.">pa_poll_func</a> poll_func, <span class="keywordtype">void</span> *userdata);</div> <div class="line"><a name="l00130"></a><span class="lineno"> 130</span> </div> <div class="line"><a name="l00131"></a><span class="lineno"> 131</span> PA_C_DECL_END</div> <div class="line"><a name="l00132"></a><span class="lineno"> 132</span> </div> <div class="line"><a name="l00133"></a><span class="lineno"> 133</span> <span class="preprocessor">#endif</span></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="http://www.doxygen.org/index.html"> <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.3 </li> </ul> </div> </body> </html>