| Current File : //proc/self/root/kunden/usr/share/doc/pulseaudio-libs-devel/html/mainloop-api_8h.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-api.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>
<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-api_8h.html',''); initResizable(); });
/* @license-end */
</script>
<div id="doc-content">
<div class="header">
<div class="summary">
<a href="#nested-classes">Data Structures</a> |
<a href="#typedef-members">Typedefs</a> |
<a href="#enum-members">Enumerations</a> |
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">mainloop-api.h File Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Main loop abstraction layer.
<a href="#details">More...</a></p>
<p><a href="mainloop-api_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="nested-classes"></a>
Data Structures</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structpa__mainloop__api.html">pa_mainloop_api</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">An abstract mainloop API vtable. <a href="structpa__mainloop__api.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="typedef-members"></a>
Typedefs</h2></td></tr>
<tr class="memitem:a02723ebcaea4464cd8d63845d4c2dd92"><td class="memItemLeft" align="right" valign="top">typedef struct <a class="el" href="structpa__mainloop__api.html">pa_mainloop_api</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="mainloop-api_8h.html#a02723ebcaea4464cd8d63845d4c2dd92">pa_mainloop_api</a></td></tr>
<tr class="memdesc:a02723ebcaea4464cd8d63845d4c2dd92"><td class="mdescLeft"> </td><td class="mdescRight">An abstract mainloop API vtable. <a href="mainloop-api_8h.html#a02723ebcaea4464cd8d63845d4c2dd92">More...</a><br /></td></tr>
<tr class="separator:a02723ebcaea4464cd8d63845d4c2dd92"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a781486fdfb048b058b1270d77cf4c44e"><td class="memItemLeft" align="right" valign="top">typedef enum <a class="el" href="mainloop-api_8h.html#a6769e3c8a68703a81a68d5d72b32d1fa">pa_io_event_flags</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="mainloop-api_8h.html#a781486fdfb048b058b1270d77cf4c44e">pa_io_event_flags_t</a></td></tr>
<tr class="memdesc:a781486fdfb048b058b1270d77cf4c44e"><td class="mdescLeft"> </td><td class="mdescRight">A bitmask for IO events. <a href="mainloop-api_8h.html#a781486fdfb048b058b1270d77cf4c44e">More...</a><br /></td></tr>
<tr class="separator:a781486fdfb048b058b1270d77cf4c44e"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ae7acb1df28956a7761ee5488167840a3"><td class="memItemLeft" align="right" valign="top">typedef struct <a class="el" href="mainloop-api_8h.html#ae7acb1df28956a7761ee5488167840a3">pa_io_event</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="mainloop-api_8h.html#ae7acb1df28956a7761ee5488167840a3">pa_io_event</a></td></tr>
<tr class="memdesc:ae7acb1df28956a7761ee5488167840a3"><td class="mdescLeft"> </td><td class="mdescRight">An opaque IO event source object. <a href="mainloop-api_8h.html#ae7acb1df28956a7761ee5488167840a3">More...</a><br /></td></tr>
<tr class="separator:ae7acb1df28956a7761ee5488167840a3"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aa161990f9c5b782773f9dbe87b4cdb97"><td class="memItemLeft" align="right" valign="top">typedef void(* </td><td class="memItemRight" valign="bottom"><a class="el" href="mainloop-api_8h.html#aa161990f9c5b782773f9dbe87b4cdb97">pa_io_event_cb_t</a>) (<a class="el" href="structpa__mainloop__api.html">pa_mainloop_api</a> *ea, <a class="el" href="mainloop-api_8h.html#ae7acb1df28956a7761ee5488167840a3">pa_io_event</a> *e, int fd, <a class="el" href="mainloop-api_8h.html#a781486fdfb048b058b1270d77cf4c44e">pa_io_event_flags_t</a> events, void *userdata)</td></tr>
<tr class="memdesc:aa161990f9c5b782773f9dbe87b4cdb97"><td class="mdescLeft"> </td><td class="mdescRight">An IO event callback prototype. <a href="mainloop-api_8h.html#aa161990f9c5b782773f9dbe87b4cdb97">More...</a><br /></td></tr>
<tr class="separator:aa161990f9c5b782773f9dbe87b4cdb97"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aa903bf03c8bd7e6c69ba4f7472e9e609"><td class="memItemLeft" align="right" valign="top">typedef void(* </td><td class="memItemRight" valign="bottom"><a class="el" href="mainloop-api_8h.html#aa903bf03c8bd7e6c69ba4f7472e9e609">pa_io_event_destroy_cb_t</a>) (<a class="el" href="structpa__mainloop__api.html">pa_mainloop_api</a> *a, <a class="el" href="mainloop-api_8h.html#ae7acb1df28956a7761ee5488167840a3">pa_io_event</a> *e, void *userdata)</td></tr>
<tr class="memdesc:aa903bf03c8bd7e6c69ba4f7472e9e609"><td class="mdescLeft"> </td><td class="mdescRight">A IO event destroy callback prototype. <a href="mainloop-api_8h.html#aa903bf03c8bd7e6c69ba4f7472e9e609">More...</a><br /></td></tr>
<tr class="separator:aa903bf03c8bd7e6c69ba4f7472e9e609"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a45b1a5f366caddb669789d5e69338f06"><td class="memItemLeft" align="right" valign="top">typedef struct <a class="el" href="mainloop-api_8h.html#a45b1a5f366caddb669789d5e69338f06">pa_time_event</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="mainloop-api_8h.html#a45b1a5f366caddb669789d5e69338f06">pa_time_event</a></td></tr>
<tr class="memdesc:a45b1a5f366caddb669789d5e69338f06"><td class="mdescLeft"> </td><td class="mdescRight">An opaque timer event source object. <a href="mainloop-api_8h.html#a45b1a5f366caddb669789d5e69338f06">More...</a><br /></td></tr>
<tr class="separator:a45b1a5f366caddb669789d5e69338f06"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:adbf3f332c476d00937c54d48ae1a0195"><td class="memItemLeft" align="right" valign="top">typedef void(* </td><td class="memItemRight" valign="bottom"><a class="el" href="mainloop-api_8h.html#adbf3f332c476d00937c54d48ae1a0195">pa_time_event_cb_t</a>) (<a class="el" href="structpa__mainloop__api.html">pa_mainloop_api</a> *a, <a class="el" href="mainloop-api_8h.html#a45b1a5f366caddb669789d5e69338f06">pa_time_event</a> *e, const struct timeval *tv, void *userdata)</td></tr>
<tr class="memdesc:adbf3f332c476d00937c54d48ae1a0195"><td class="mdescLeft"> </td><td class="mdescRight">A time event callback prototype. <a href="mainloop-api_8h.html#adbf3f332c476d00937c54d48ae1a0195">More...</a><br /></td></tr>
<tr class="separator:adbf3f332c476d00937c54d48ae1a0195"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a99ceae799eb6238e9163c13bf959a14b"><td class="memItemLeft" align="right" valign="top">typedef void(* </td><td class="memItemRight" valign="bottom"><a class="el" href="mainloop-api_8h.html#a99ceae799eb6238e9163c13bf959a14b">pa_time_event_destroy_cb_t</a>) (<a class="el" href="structpa__mainloop__api.html">pa_mainloop_api</a> *a, <a class="el" href="mainloop-api_8h.html#a45b1a5f366caddb669789d5e69338f06">pa_time_event</a> *e, void *userdata)</td></tr>
<tr class="memdesc:a99ceae799eb6238e9163c13bf959a14b"><td class="mdescLeft"> </td><td class="mdescRight">A time event destroy callback prototype. <a href="mainloop-api_8h.html#a99ceae799eb6238e9163c13bf959a14b">More...</a><br /></td></tr>
<tr class="separator:a99ceae799eb6238e9163c13bf959a14b"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a545440c2c08074c93939cb1240a7d087"><td class="memItemLeft" align="right" valign="top">typedef struct <a class="el" href="mainloop-api_8h.html#a545440c2c08074c93939cb1240a7d087">pa_defer_event</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="mainloop-api_8h.html#a545440c2c08074c93939cb1240a7d087">pa_defer_event</a></td></tr>
<tr class="memdesc:a545440c2c08074c93939cb1240a7d087"><td class="mdescLeft"> </td><td class="mdescRight">An opaque deferred event source object. <a href="mainloop-api_8h.html#a545440c2c08074c93939cb1240a7d087">More...</a><br /></td></tr>
<tr class="separator:a545440c2c08074c93939cb1240a7d087"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a43efe1c689d3c135391a88344acc199a"><td class="memItemLeft" align="right" valign="top">typedef void(* </td><td class="memItemRight" valign="bottom"><a class="el" href="mainloop-api_8h.html#a43efe1c689d3c135391a88344acc199a">pa_defer_event_cb_t</a>) (<a class="el" href="structpa__mainloop__api.html">pa_mainloop_api</a> *a, <a class="el" href="mainloop-api_8h.html#a545440c2c08074c93939cb1240a7d087">pa_defer_event</a> *e, void *userdata)</td></tr>
<tr class="memdesc:a43efe1c689d3c135391a88344acc199a"><td class="mdescLeft"> </td><td class="mdescRight">A defer event callback prototype. <a href="mainloop-api_8h.html#a43efe1c689d3c135391a88344acc199a">More...</a><br /></td></tr>
<tr class="separator:a43efe1c689d3c135391a88344acc199a"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a172bb54939aff91f71d1955a21267fb5"><td class="memItemLeft" align="right" valign="top">typedef void(* </td><td class="memItemRight" valign="bottom"><a class="el" href="mainloop-api_8h.html#a172bb54939aff91f71d1955a21267fb5">pa_defer_event_destroy_cb_t</a>) (<a class="el" href="structpa__mainloop__api.html">pa_mainloop_api</a> *a, <a class="el" href="mainloop-api_8h.html#a545440c2c08074c93939cb1240a7d087">pa_defer_event</a> *e, void *userdata)</td></tr>
<tr class="memdesc:a172bb54939aff91f71d1955a21267fb5"><td class="mdescLeft"> </td><td class="mdescRight">A defer event destroy callback prototype. <a href="mainloop-api_8h.html#a172bb54939aff91f71d1955a21267fb5">More...</a><br /></td></tr>
<tr class="separator:a172bb54939aff91f71d1955a21267fb5"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="enum-members"></a>
Enumerations</h2></td></tr>
<tr class="memitem:a6769e3c8a68703a81a68d5d72b32d1fa"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="mainloop-api_8h.html#a6769e3c8a68703a81a68d5d72b32d1fa">pa_io_event_flags</a> { <br />
  <a class="el" href="mainloop-api_8h.html#a6769e3c8a68703a81a68d5d72b32d1faa458d976392190c7626b4f789bf11b2ea">PA_IO_EVENT_NULL</a> = 0
, <br />
  <a class="el" href="mainloop-api_8h.html#a6769e3c8a68703a81a68d5d72b32d1faaba9fbd1e6cb3031098a2aaa144c78336">PA_IO_EVENT_INPUT</a> = 1
, <br />
  <a class="el" href="mainloop-api_8h.html#a6769e3c8a68703a81a68d5d72b32d1faa3aff35dad0cd23ae3796b3141fee4dce">PA_IO_EVENT_OUTPUT</a> = 2
, <br />
  <a class="el" href="mainloop-api_8h.html#a6769e3c8a68703a81a68d5d72b32d1faa9b6a006b1dc3894fd6bd8d5d99be5831">PA_IO_EVENT_HANGUP</a> = 4
, <br />
  <a class="el" href="mainloop-api_8h.html#a6769e3c8a68703a81a68d5d72b32d1faa7e0f4c300b66f92e0c59a0d56326f488">PA_IO_EVENT_ERROR</a> = 8
<br />
}</td></tr>
<tr class="memdesc:a6769e3c8a68703a81a68d5d72b32d1fa"><td class="mdescLeft"> </td><td class="mdescRight">A bitmask for IO events. <a href="mainloop-api_8h.html#a6769e3c8a68703a81a68d5d72b32d1fa">More...</a><br /></td></tr>
<tr class="separator:a6769e3c8a68703a81a68d5d72b32d1fa"><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:a0b38e33a821ac63ce99b4beb3f6313e8"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="mainloop-api_8h.html#a0b38e33a821ac63ce99b4beb3f6313e8">pa_mainloop_api_once</a> (<a class="el" href="structpa__mainloop__api.html">pa_mainloop_api</a> *m, void(*callback)(<a class="el" href="structpa__mainloop__api.html">pa_mainloop_api</a> *m, void *userdata), void *userdata)</td></tr>
<tr class="memdesc:a0b38e33a821ac63ce99b4beb3f6313e8"><td class="mdescLeft"> </td><td class="mdescRight">Run the specified callback function once from the main loop using an anonymous defer event. <a href="mainloop-api_8h.html#a0b38e33a821ac63ce99b4beb3f6313e8">More...</a><br /></td></tr>
<tr class="separator:a0b38e33a821ac63ce99b4beb3f6313e8"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Main loop abstraction layer. </p>
<p>Both the PulseAudio core and the PulseAudio client library use a main loop abstraction layer. Due to this it is possible to embed PulseAudio into other applications easily. Three main loop implementations are currently available: </p><ul>
<li>A minimal implementation based on the C library's poll() function (See <a class="el" href="mainloop_8h.html">mainloop.h</a>). </li>
<li>A special version of the previous implementation where all of PulseAudio's internal handling runs in a separate thread (See <a class="el" href="thread-mainloop_8h.html">thread-mainloop.h</a>). </li>
<li>A wrapper around the GLIB main loop. Use this to embed PulseAudio into your GLIB/GTK+/GNOME programs (See <a class="el" href="glib-mainloop_8h.html">glib-mainloop.h</a>).</li>
</ul>
<p>The structure <a class="el" href="structpa__mainloop__api.html" title="An abstract mainloop API vtable.">pa_mainloop_api</a> is used as a vtable for the main loop abstraction.</p>
<p>This mainloop abstraction layer has no direct support for UNIX signals. Generic, mainloop implementation agnostic support is available through <a class="el" href="mainloop-signal_8h.html">mainloop-signal.h</a>. </p>
</div><h2 class="groupheader">Typedef Documentation</h2>
<a id="a545440c2c08074c93939cb1240a7d087"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a545440c2c08074c93939cb1240a7d087">◆ </a></span>pa_defer_event</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef struct <a class="el" href="mainloop-api_8h.html#a545440c2c08074c93939cb1240a7d087">pa_defer_event</a> <a class="el" href="mainloop-api_8h.html#a545440c2c08074c93939cb1240a7d087">pa_defer_event</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>An opaque deferred event source object. </p>
<p>Events of this type are triggered once in every main loop iteration </p>
</div>
</div>
<a id="a43efe1c689d3c135391a88344acc199a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a43efe1c689d3c135391a88344acc199a">◆ </a></span>pa_defer_event_cb_t</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef void(* pa_defer_event_cb_t) (<a class="el" href="structpa__mainloop__api.html">pa_mainloop_api</a> *a, <a class="el" href="mainloop-api_8h.html#a545440c2c08074c93939cb1240a7d087">pa_defer_event</a> *e, void *userdata)</td>
</tr>
</table>
</div><div class="memdoc">
<p>A defer event callback prototype. </p>
<dl class="section since"><dt>Since</dt><dd>0.9.3 </dd></dl>
</div>
</div>
<a id="a172bb54939aff91f71d1955a21267fb5"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a172bb54939aff91f71d1955a21267fb5">◆ </a></span>pa_defer_event_destroy_cb_t</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef void(* pa_defer_event_destroy_cb_t) (<a class="el" href="structpa__mainloop__api.html">pa_mainloop_api</a> *a, <a class="el" href="mainloop-api_8h.html#a545440c2c08074c93939cb1240a7d087">pa_defer_event</a> *e, void *userdata)</td>
</tr>
</table>
</div><div class="memdoc">
<p>A defer event destroy callback prototype. </p>
<dl class="section since"><dt>Since</dt><dd>0.9.3 </dd></dl>
</div>
</div>
<a id="ae7acb1df28956a7761ee5488167840a3"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae7acb1df28956a7761ee5488167840a3">◆ </a></span>pa_io_event</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef struct <a class="el" href="mainloop-api_8h.html#ae7acb1df28956a7761ee5488167840a3">pa_io_event</a> <a class="el" href="mainloop-api_8h.html#ae7acb1df28956a7761ee5488167840a3">pa_io_event</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>An opaque IO event source object. </p>
</div>
</div>
<a id="aa161990f9c5b782773f9dbe87b4cdb97"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa161990f9c5b782773f9dbe87b4cdb97">◆ </a></span>pa_io_event_cb_t</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef void(* pa_io_event_cb_t) (<a class="el" href="structpa__mainloop__api.html">pa_mainloop_api</a> *ea, <a class="el" href="mainloop-api_8h.html#ae7acb1df28956a7761ee5488167840a3">pa_io_event</a> *e, int fd, <a class="el" href="mainloop-api_8h.html#a781486fdfb048b058b1270d77cf4c44e">pa_io_event_flags_t</a> events, void *userdata)</td>
</tr>
</table>
</div><div class="memdoc">
<p>An IO event callback prototype. </p>
<dl class="section since"><dt>Since</dt><dd>0.9.3 </dd></dl>
</div>
</div>
<a id="aa903bf03c8bd7e6c69ba4f7472e9e609"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa903bf03c8bd7e6c69ba4f7472e9e609">◆ </a></span>pa_io_event_destroy_cb_t</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef void(* pa_io_event_destroy_cb_t) (<a class="el" href="structpa__mainloop__api.html">pa_mainloop_api</a> *a, <a class="el" href="mainloop-api_8h.html#ae7acb1df28956a7761ee5488167840a3">pa_io_event</a> *e, void *userdata)</td>
</tr>
</table>
</div><div class="memdoc">
<p>A IO event destroy callback prototype. </p>
<dl class="section since"><dt>Since</dt><dd>0.9.3 </dd></dl>
</div>
</div>
<a id="a781486fdfb048b058b1270d77cf4c44e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a781486fdfb048b058b1270d77cf4c44e">◆ </a></span>pa_io_event_flags_t</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef enum <a class="el" href="mainloop-api_8h.html#a6769e3c8a68703a81a68d5d72b32d1fa">pa_io_event_flags</a> <a class="el" href="mainloop-api_8h.html#a781486fdfb048b058b1270d77cf4c44e">pa_io_event_flags_t</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>A bitmask for IO events. </p>
</div>
</div>
<a id="a02723ebcaea4464cd8d63845d4c2dd92"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a02723ebcaea4464cd8d63845d4c2dd92">◆ </a></span>pa_mainloop_api</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef struct <a class="el" href="structpa__mainloop__api.html">pa_mainloop_api</a> <a class="el" href="structpa__mainloop__api.html">pa_mainloop_api</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>An abstract mainloop API vtable. </p>
</div>
</div>
<a id="a45b1a5f366caddb669789d5e69338f06"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a45b1a5f366caddb669789d5e69338f06">◆ </a></span>pa_time_event</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef struct <a class="el" href="mainloop-api_8h.html#a45b1a5f366caddb669789d5e69338f06">pa_time_event</a> <a class="el" href="mainloop-api_8h.html#a45b1a5f366caddb669789d5e69338f06">pa_time_event</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>An opaque timer event source object. </p>
</div>
</div>
<a id="adbf3f332c476d00937c54d48ae1a0195"></a>
<h2 class="memtitle"><span class="permalink"><a href="#adbf3f332c476d00937c54d48ae1a0195">◆ </a></span>pa_time_event_cb_t</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef void(* pa_time_event_cb_t) (<a class="el" href="structpa__mainloop__api.html">pa_mainloop_api</a> *a, <a class="el" href="mainloop-api_8h.html#a45b1a5f366caddb669789d5e69338f06">pa_time_event</a> *e, const struct timeval *tv, void *userdata)</td>
</tr>
</table>
</div><div class="memdoc">
<p>A time event callback prototype. </p>
<dl class="section since"><dt>Since</dt><dd>0.9.3 </dd></dl>
</div>
</div>
<a id="a99ceae799eb6238e9163c13bf959a14b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a99ceae799eb6238e9163c13bf959a14b">◆ </a></span>pa_time_event_destroy_cb_t</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef void(* pa_time_event_destroy_cb_t) (<a class="el" href="structpa__mainloop__api.html">pa_mainloop_api</a> *a, <a class="el" href="mainloop-api_8h.html#a45b1a5f366caddb669789d5e69338f06">pa_time_event</a> *e, void *userdata)</td>
</tr>
</table>
</div><div class="memdoc">
<p>A time event destroy callback prototype. </p>
<dl class="section since"><dt>Since</dt><dd>0.9.3 </dd></dl>
</div>
</div>
<h2 class="groupheader">Enumeration Type Documentation</h2>
<a id="a6769e3c8a68703a81a68d5d72b32d1fa"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6769e3c8a68703a81a68d5d72b32d1fa">◆ </a></span>pa_io_event_flags</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="mainloop-api_8h.html#a6769e3c8a68703a81a68d5d72b32d1fa">pa_io_event_flags</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>A bitmask for IO events. </p>
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="a6769e3c8a68703a81a68d5d72b32d1faa458d976392190c7626b4f789bf11b2ea"></a>PA_IO_EVENT_NULL </td><td class="fielddoc"><p>No event. </p>
</td></tr>
<tr><td class="fieldname"><a id="a6769e3c8a68703a81a68d5d72b32d1faaba9fbd1e6cb3031098a2aaa144c78336"></a>PA_IO_EVENT_INPUT </td><td class="fielddoc"><p>Input event. </p>
</td></tr>
<tr><td class="fieldname"><a id="a6769e3c8a68703a81a68d5d72b32d1faa3aff35dad0cd23ae3796b3141fee4dce"></a>PA_IO_EVENT_OUTPUT </td><td class="fielddoc"><p>Output event. </p>
</td></tr>
<tr><td class="fieldname"><a id="a6769e3c8a68703a81a68d5d72b32d1faa9b6a006b1dc3894fd6bd8d5d99be5831"></a>PA_IO_EVENT_HANGUP </td><td class="fielddoc"><p>Hangup event. </p>
</td></tr>
<tr><td class="fieldname"><a id="a6769e3c8a68703a81a68d5d72b32d1faa7e0f4c300b66f92e0c59a0d56326f488"></a>PA_IO_EVENT_ERROR </td><td class="fielddoc"><p>Error event. </p>
</td></tr>
</table>
</div>
</div>
<h2 class="groupheader">Function Documentation</h2>
<a id="a0b38e33a821ac63ce99b4beb3f6313e8"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0b38e33a821ac63ce99b4beb3f6313e8">◆ </a></span>pa_mainloop_api_once()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void pa_mainloop_api_once </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structpa__mainloop__api.html">pa_mainloop_api</a> * </td>
<td class="paramname"><em>m</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">void(*)(<a class="el" href="structpa__mainloop__api.html">pa_mainloop_api</a> *m, void *userdata) </td>
<td class="paramname"><em>callback</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>Run the specified callback function once from the main loop using an anonymous defer event. </p>
<p>If the mainloop runs in a different thread, you need to follow the mainloop implementation's rules regarding how to safely create defer events. In particular, if you're using <a class="el" href="thread-mainloop_8h.html#a40393b9b64dc8213bcd5f017344baf74">pa_threaded_mainloop</a>, you must lock the mainloop before calling this function. </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-api_8h.html">mainloop-api.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>