<!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: mainloop.h File Reference</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('mainloop_8h.html','');});
</script>
<div id="doc-content">
<div class="header">
<div class="summary">
<a href="#typedef-members">Typedefs</a> |
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">mainloop.h File Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>A minimal main loop implementation based on the C library's poll() function.
<a href="#details">More...</a></p>
<p><a href="mainloop_8h_source.html">Go to the source code of this file.</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="typedef-members"></a>
Typedefs</h2></td></tr>
<tr class="memitem:aadf8d428d3e2f00ed762017c7b587cc9"><td class="memItemLeft" align="right" valign="top">typedef struct <a class="el" href="mainloop_8h.html#aadf8d428d3e2f00ed762017c7b587cc9">pa_mainloop</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="mainloop_8h.html#aadf8d428d3e2f00ed762017c7b587cc9">pa_mainloop</a></td></tr>
<tr class="memdesc:aadf8d428d3e2f00ed762017c7b587cc9"><td class="mdescLeft"> </td><td class="mdescRight">An opaque main loop object. <a href="#aadf8d428d3e2f00ed762017c7b587cc9">More...</a><br /></td></tr>
<tr class="separator:aadf8d428d3e2f00ed762017c7b587cc9"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aa39d2a51b19fffe587a591a6637a49bf"><td class="memItemLeft" align="right" valign="top">typedef int(* </td><td class="memItemRight" valign="bottom"><a class="el" href="mainloop_8h.html#aa39d2a51b19fffe587a591a6637a49bf">pa_poll_func</a>) (struct pollfd *ufds, unsigned long nfds, int timeout, void *userdata)</td></tr>
<tr class="memdesc:aa39d2a51b19fffe587a591a6637a49bf"><td class="mdescLeft"> </td><td class="mdescRight">Generic prototype of a poll() like function. <a href="#aa39d2a51b19fffe587a591a6637a49bf">More...</a><br /></td></tr>
<tr class="separator:aa39d2a51b19fffe587a591a6637a49bf"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:ad6c767781474275159c0a5f3f7e2ecb5"><td class="memItemLeft" align="right" valign="top"><a class="el" href="mainloop_8h.html#aadf8d428d3e2f00ed762017c7b587cc9">pa_mainloop</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="mainloop_8h.html#ad6c767781474275159c0a5f3f7e2ecb5">pa_mainloop_new</a> (void)</td></tr>
<tr class="memdesc:ad6c767781474275159c0a5f3f7e2ecb5"><td class="mdescLeft"> </td><td class="mdescRight">Allocate a new main loop object. <a href="#ad6c767781474275159c0a5f3f7e2ecb5">More...</a><br /></td></tr>
<tr class="separator:ad6c767781474275159c0a5f3f7e2ecb5"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a6c6ea37ce2815640f7f1a133f845f8e7"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="mainloop_8h.html#a6c6ea37ce2815640f7f1a133f845f8e7">pa_mainloop_free</a> (<a class="el" href="mainloop_8h.html#aadf8d428d3e2f00ed762017c7b587cc9">pa_mainloop</a> *m)</td></tr>
<tr class="memdesc:a6c6ea37ce2815640f7f1a133f845f8e7"><td class="mdescLeft"> </td><td class="mdescRight">Free a main loop object. <a href="#a6c6ea37ce2815640f7f1a133f845f8e7">More...</a><br /></td></tr>
<tr class="separator:a6c6ea37ce2815640f7f1a133f845f8e7"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a217ce134af601c1c6ce77c41c99fc0d2"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="mainloop_8h.html#a217ce134af601c1c6ce77c41c99fc0d2">pa_mainloop_prepare</a> (<a class="el" href="mainloop_8h.html#aadf8d428d3e2f00ed762017c7b587cc9">pa_mainloop</a> *m, int timeout)</td></tr>
<tr class="memdesc:a217ce134af601c1c6ce77c41c99fc0d2"><td class="mdescLeft"> </td><td class="mdescRight">Prepare for a single iteration of the main loop. <a href="#a217ce134af601c1c6ce77c41c99fc0d2">More...</a><br /></td></tr>
<tr class="separator:a217ce134af601c1c6ce77c41c99fc0d2"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a9195049c1bd136be73ce0e628523a2df"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="mainloop_8h.html#a9195049c1bd136be73ce0e628523a2df">pa_mainloop_poll</a> (<a class="el" href="mainloop_8h.html#aadf8d428d3e2f00ed762017c7b587cc9">pa_mainloop</a> *m)</td></tr>
<tr class="memdesc:a9195049c1bd136be73ce0e628523a2df"><td class="mdescLeft"> </td><td class="mdescRight">Execute the previously prepared poll. <a href="#a9195049c1bd136be73ce0e628523a2df">More...</a><br /></td></tr>
<tr class="separator:a9195049c1bd136be73ce0e628523a2df"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:abada884366e125a052bae5f6a4a7481e"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="mainloop_8h.html#abada884366e125a052bae5f6a4a7481e">pa_mainloop_dispatch</a> (<a class="el" href="mainloop_8h.html#aadf8d428d3e2f00ed762017c7b587cc9">pa_mainloop</a> *m)</td></tr>
<tr class="memdesc:abada884366e125a052bae5f6a4a7481e"><td class="mdescLeft"> </td><td class="mdescRight">Dispatch timeout, io and deferred events from the previously executed poll. <a href="#abada884366e125a052bae5f6a4a7481e">More...</a><br /></td></tr>
<tr class="separator:abada884366e125a052bae5f6a4a7481e"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a70065fd3ab808bde3892bf08a8c5f51b"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="mainloop_8h.html#a70065fd3ab808bde3892bf08a8c5f51b">pa_mainloop_get_retval</a> (<a class="el" href="mainloop_8h.html#aadf8d428d3e2f00ed762017c7b587cc9">pa_mainloop</a> *m)</td></tr>
<tr class="memdesc:a70065fd3ab808bde3892bf08a8c5f51b"><td class="mdescLeft"> </td><td class="mdescRight">Return the return value as specified with the main loop's quit() routine. <a href="#a70065fd3ab808bde3892bf08a8c5f51b">More...</a><br /></td></tr>
<tr class="separator:a70065fd3ab808bde3892bf08a8c5f51b"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a491422aebe5487800d8be0bf4153cb81"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="mainloop_8h.html#a491422aebe5487800d8be0bf4153cb81">pa_mainloop_iterate</a> (<a class="el" href="mainloop_8h.html#aadf8d428d3e2f00ed762017c7b587cc9">pa_mainloop</a> *m, int block, int *retval)</td></tr>
<tr class="memdesc:a491422aebe5487800d8be0bf4153cb81"><td class="mdescLeft"> </td><td class="mdescRight">Run a single iteration of the main loop. <a href="#a491422aebe5487800d8be0bf4153cb81">More...</a><br /></td></tr>
<tr class="separator:a491422aebe5487800d8be0bf4153cb81"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:afbcd8f4eba09cdfd5323ac9db3718ae8"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="mainloop_8h.html#afbcd8f4eba09cdfd5323ac9db3718ae8">pa_mainloop_run</a> (<a class="el" href="mainloop_8h.html#aadf8d428d3e2f00ed762017c7b587cc9">pa_mainloop</a> *m, int *retval)</td></tr>
<tr class="memdesc:afbcd8f4eba09cdfd5323ac9db3718ae8"><td class="mdescLeft"> </td><td class="mdescRight">Run unlimited iterations of the main loop object until the main loop's quit() routine is called. <a href="#afbcd8f4eba09cdfd5323ac9db3718ae8">More...</a><br /></td></tr>
<tr class="separator:afbcd8f4eba09cdfd5323ac9db3718ae8"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a9e5b510dabb4eb1a01645c4db65b9ddb"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structpa__mainloop__api.html">pa_mainloop_api</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="mainloop_8h.html#a9e5b510dabb4eb1a01645c4db65b9ddb">pa_mainloop_get_api</a> (<a class="el" href="mainloop_8h.html#aadf8d428d3e2f00ed762017c7b587cc9">pa_mainloop</a> *m)</td></tr>
<tr class="memdesc:a9e5b510dabb4eb1a01645c4db65b9ddb"><td class="mdescLeft"> </td><td class="mdescRight">Return the abstract main loop abstraction layer vtable for this main loop. <a href="#a9e5b510dabb4eb1a01645c4db65b9ddb">More...</a><br /></td></tr>
<tr class="separator:a9e5b510dabb4eb1a01645c4db65b9ddb"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a3000eb1bacba8773424a779cbbb12572"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="mainloop_8h.html#a3000eb1bacba8773424a779cbbb12572">pa_mainloop_quit</a> (<a class="el" href="mainloop_8h.html#aadf8d428d3e2f00ed762017c7b587cc9">pa_mainloop</a> *m, int retval)</td></tr>
<tr class="memdesc:a3000eb1bacba8773424a779cbbb12572"><td class="mdescLeft"> </td><td class="mdescRight">Shutdown the main loop with the specified return value. <a href="#a3000eb1bacba8773424a779cbbb12572">More...</a><br /></td></tr>
<tr class="separator:a3000eb1bacba8773424a779cbbb12572"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a2a81af2882e0c806308b20b97ca5473e"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="mainloop_8h.html#a2a81af2882e0c806308b20b97ca5473e">pa_mainloop_wakeup</a> (<a class="el" href="mainloop_8h.html#aadf8d428d3e2f00ed762017c7b587cc9">pa_mainloop</a> *m)</td></tr>
<tr class="memdesc:a2a81af2882e0c806308b20b97ca5473e"><td class="mdescLeft"> </td><td class="mdescRight">Interrupt a running poll (for threaded systems) <a href="#a2a81af2882e0c806308b20b97ca5473e">More...</a><br /></td></tr>
<tr class="separator:a2a81af2882e0c806308b20b97ca5473e"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ae51c490c29106c0c3b020020c6dc015d"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="mainloop_8h.html#ae51c490c29106c0c3b020020c6dc015d">pa_mainloop_set_poll_func</a> (<a class="el" href="mainloop_8h.html#aadf8d428d3e2f00ed762017c7b587cc9">pa_mainloop</a> *m, <a class="el" href="mainloop_8h.html#aa39d2a51b19fffe587a591a6637a49bf">pa_poll_func</a> poll_func, void *userdata)</td></tr>
<tr class="memdesc:ae51c490c29106c0c3b020020c6dc015d"><td class="mdescLeft"> </td><td class="mdescRight">Change the poll() implementation. <a href="#ae51c490c29106c0c3b020020c6dc015d">More...</a><br /></td></tr>
<tr class="separator:ae51c490c29106c0c3b020020c6dc015d"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>A minimal main loop implementation based on the C library's poll() function. </p>
<p>Using the routines defined herein you may create a simple main loop supporting the generic main loop abstraction layer as defined in <a class="el" href="mainloop-api_8h.html">mainloop-api.h</a>. This implementation is thread safe as long as you access the main loop object from a single thread only.</p>
<p>See also <a class="el" href="mainloop.html">Main Loop</a> </p>
</div><h2 class="groupheader">Typedef Documentation</h2>
<a id="aadf8d428d3e2f00ed762017c7b587cc9"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aadf8d428d3e2f00ed762017c7b587cc9">◆ </a></span>pa_mainloop</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef struct <a class="el" href="mainloop_8h.html#aadf8d428d3e2f00ed762017c7b587cc9">pa_mainloop</a> <a class="el" href="mainloop_8h.html#aadf8d428d3e2f00ed762017c7b587cc9">pa_mainloop</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>An opaque main loop object. </p>
</div>
</div>
<a id="aa39d2a51b19fffe587a591a6637a49bf"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa39d2a51b19fffe587a591a6637a49bf">◆ </a></span>pa_poll_func</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef int(* pa_poll_func) (struct pollfd *ufds, unsigned long nfds, int timeout, void *userdata)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Generic prototype of a poll() like function. </p>
</div>
</div>
<h2 class="groupheader">Function Documentation</h2>
<a id="abada884366e125a052bae5f6a4a7481e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#abada884366e125a052bae5f6a4a7481e">◆ </a></span>pa_mainloop_dispatch()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int pa_mainloop_dispatch </td>
<td>(</td>
<td class="paramtype"><a class="el" href="mainloop_8h.html#aadf8d428d3e2f00ed762017c7b587cc9">pa_mainloop</a> * </td>
<td class="paramname"><em>m</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Dispatch timeout, io and deferred events from the previously executed poll. </p>
<p>Returns a negative value on error. On success returns the number of source dispatched. </p>
</div>
</div>
<a id="a6c6ea37ce2815640f7f1a133f845f8e7"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6c6ea37ce2815640f7f1a133f845f8e7">◆ </a></span>pa_mainloop_free()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void pa_mainloop_free </td>
<td>(</td>
<td class="paramtype"><a class="el" href="mainloop_8h.html#aadf8d428d3e2f00ed762017c7b587cc9">pa_mainloop</a> * </td>
<td class="paramname"><em>m</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Free a main loop object. </p>
</div>
</div>
<a id="a9e5b510dabb4eb1a01645c4db65b9ddb"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9e5b510dabb4eb1a01645c4db65b9ddb">◆ </a></span>pa_mainloop_get_api()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="structpa__mainloop__api.html">pa_mainloop_api</a>* pa_mainloop_get_api </td>
<td>(</td>
<td class="paramtype"><a class="el" href="mainloop_8h.html#aadf8d428d3e2f00ed762017c7b587cc9">pa_mainloop</a> * </td>
<td class="paramname"><em>m</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Return the abstract main loop abstraction layer vtable for this main loop. </p>
<p>No need to free the API as it is owned by the loop and is destroyed when the loop is freed. </p>
</div>
</div>
<a id="a70065fd3ab808bde3892bf08a8c5f51b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a70065fd3ab808bde3892bf08a8c5f51b">◆ </a></span>pa_mainloop_get_retval()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int pa_mainloop_get_retval </td>
<td>(</td>
<td class="paramtype"><a class="el" href="mainloop_8h.html#aadf8d428d3e2f00ed762017c7b587cc9">pa_mainloop</a> * </td>
<td class="paramname"><em>m</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Return the return value as specified with the main loop's quit() routine. </p>
</div>
</div>
<a id="a491422aebe5487800d8be0bf4153cb81"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a491422aebe5487800d8be0bf4153cb81">◆ </a></span>pa_mainloop_iterate()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int pa_mainloop_iterate </td>
<td>(</td>
<td class="paramtype"><a class="el" href="mainloop_8h.html#aadf8d428d3e2f00ed762017c7b587cc9">pa_mainloop</a> * </td>
<td class="paramname"><em>m</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>block</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int * </td>
<td class="paramname"><em>retval</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Run a single iteration of the main loop. </p>
<p>This is a convenience function for <a class="el" href="mainloop_8h.html#a217ce134af601c1c6ce77c41c99fc0d2" title="Prepare for a single iteration of the main loop. ">pa_mainloop_prepare()</a>, <a class="el" href="mainloop_8h.html#a9195049c1bd136be73ce0e628523a2df" title="Execute the previously prepared poll. ">pa_mainloop_poll()</a> and <a class="el" href="mainloop_8h.html#abada884366e125a052bae5f6a4a7481e" title="Dispatch timeout, io and deferred events from the previously executed poll. ">pa_mainloop_dispatch()</a>. Returns a negative value on error or exit request. If block is nonzero, block for events if none are queued. Optionally return the return value as specified with the main loop's quit() routine in the integer variable retval points to. On success returns the number of sources dispatched in this iteration. </p>
</div>
</div>
<a id="ad6c767781474275159c0a5f3f7e2ecb5"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad6c767781474275159c0a5f3f7e2ecb5">◆ </a></span>pa_mainloop_new()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="mainloop_8h.html#aadf8d428d3e2f00ed762017c7b587cc9">pa_mainloop</a>* pa_mainloop_new </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Allocate a new main loop object. </p>
</div>
</div>
<a id="a9195049c1bd136be73ce0e628523a2df"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9195049c1bd136be73ce0e628523a2df">◆ </a></span>pa_mainloop_poll()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int pa_mainloop_poll </td>
<td>(</td>
<td class="paramtype"><a class="el" href="mainloop_8h.html#aadf8d428d3e2f00ed762017c7b587cc9">pa_mainloop</a> * </td>
<td class="paramname"><em>m</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Execute the previously prepared poll. </p>
<p>Returns a negative value on error. </p>
</div>
</div>
<a id="a217ce134af601c1c6ce77c41c99fc0d2"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a217ce134af601c1c6ce77c41c99fc0d2">◆ </a></span>pa_mainloop_prepare()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int pa_mainloop_prepare </td>
<td>(</td>
<td class="paramtype"><a class="el" href="mainloop_8h.html#aadf8d428d3e2f00ed762017c7b587cc9">pa_mainloop</a> * </td>
<td class="paramname"><em>m</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></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Prepare for a single iteration of the main loop. </p>
<p>Returns a negative value on error or exit request. timeout specifies a maximum timeout for the subsequent poll, or -1 for blocking behaviour. . </p>
</div>
</div>
<a id="a3000eb1bacba8773424a779cbbb12572"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3000eb1bacba8773424a779cbbb12572">◆ </a></span>pa_mainloop_quit()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void pa_mainloop_quit </td>
<td>(</td>
<td class="paramtype"><a class="el" href="mainloop_8h.html#aadf8d428d3e2f00ed762017c7b587cc9">pa_mainloop</a> * </td>
<td class="paramname"><em>m</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>retval</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Shutdown the main loop with the specified return value. </p>
</div>
</div>
<a id="afbcd8f4eba09cdfd5323ac9db3718ae8"></a>
<h2 class="memtitle"><span class="permalink"><a href="#afbcd8f4eba09cdfd5323ac9db3718ae8">◆ </a></span>pa_mainloop_run()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int pa_mainloop_run </td>
<td>(</td>
<td class="paramtype"><a class="el" href="mainloop_8h.html#aadf8d428d3e2f00ed762017c7b587cc9">pa_mainloop</a> * </td>
<td class="paramname"><em>m</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int * </td>
<td class="paramname"><em>retval</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Run unlimited iterations of the main loop object until the main loop's quit() routine is called. </p>
</div>
</div>
<a id="ae51c490c29106c0c3b020020c6dc015d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae51c490c29106c0c3b020020c6dc015d">◆ </a></span>pa_mainloop_set_poll_func()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void pa_mainloop_set_poll_func </td>
<td>(</td>
<td class="paramtype"><a class="el" href="mainloop_8h.html#aadf8d428d3e2f00ed762017c7b587cc9">pa_mainloop</a> * </td>
<td class="paramname"><em>m</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="mainloop_8h.html#aa39d2a51b19fffe587a591a6637a49bf">pa_poll_func</a> </td>
<td class="paramname"><em>poll_func</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">void * </td>
<td class="paramname"><em>userdata</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Change the poll() implementation. </p>
</div>
</div>
<a id="a2a81af2882e0c806308b20b97ca5473e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2a81af2882e0c806308b20b97ca5473e">◆ </a></span>pa_mainloop_wakeup()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void pa_mainloop_wakeup </td>
<td>(</td>
<td class="paramtype"><a class="el" href="mainloop_8h.html#aadf8d428d3e2f00ed762017c7b587cc9">pa_mainloop</a> * </td>
<td class="paramname"><em>m</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Interrupt a running poll (for threaded systems) </p>
</div>
</div>
</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.13 </li>
</ul>
</div>
</body>
</html>
distrib
>
Mageia
>
6
>
x86_64
>
media
>
core-updates
>
by-pkgid
>
a41e5ac5fb332416cb8019ae392f1f99
>
files
>
206
