<!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-signal.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-signal_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-signal.h File Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>UNIX signal support for main loops.
<a href="#details">More...</a></p>
<p><a href="mainloop-signal_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:a8346c68814daec286cef332fa9df302c"><td class="memItemLeft" align="right" valign="top">typedef struct <a class="el" href="mainloop-signal_8h.html#a8346c68814daec286cef332fa9df302c">pa_signal_event</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="mainloop-signal_8h.html#a8346c68814daec286cef332fa9df302c">pa_signal_event</a></td></tr>
<tr class="memdesc:a8346c68814daec286cef332fa9df302c"><td class="mdescLeft"> </td><td class="mdescRight">An opaque UNIX signal event source object. <a href="#a8346c68814daec286cef332fa9df302c">More...</a><br /></td></tr>
<tr class="separator:a8346c68814daec286cef332fa9df302c"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a7d658f2cba34a9fa27d7270269b5d88e"><td class="memItemLeft" align="right" valign="top">typedef void(* </td><td class="memItemRight" valign="bottom"><a class="el" href="mainloop-signal_8h.html#a7d658f2cba34a9fa27d7270269b5d88e">pa_signal_cb_t</a>) (<a class="el" href="structpa__mainloop__api.html">pa_mainloop_api</a> *api, <a class="el" href="mainloop-signal_8h.html#a8346c68814daec286cef332fa9df302c">pa_signal_event</a> *e, int sig, void *userdata)</td></tr>
<tr class="memdesc:a7d658f2cba34a9fa27d7270269b5d88e"><td class="mdescLeft"> </td><td class="mdescRight">Callback prototype for signal events. <a href="#a7d658f2cba34a9fa27d7270269b5d88e">More...</a><br /></td></tr>
<tr class="separator:a7d658f2cba34a9fa27d7270269b5d88e"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a724c7f155d4ad57fb367bf93f02d91b5"><td class="memItemLeft" align="right" valign="top">typedef void(* </td><td class="memItemRight" valign="bottom"><a class="el" href="mainloop-signal_8h.html#a724c7f155d4ad57fb367bf93f02d91b5">pa_signal_destroy_cb_t</a>) (<a class="el" href="structpa__mainloop__api.html">pa_mainloop_api</a> *api, <a class="el" href="mainloop-signal_8h.html#a8346c68814daec286cef332fa9df302c">pa_signal_event</a> *e, void *userdata)</td></tr>
<tr class="memdesc:a724c7f155d4ad57fb367bf93f02d91b5"><td class="mdescLeft"> </td><td class="mdescRight">Destroy callback prototype for signal events. <a href="#a724c7f155d4ad57fb367bf93f02d91b5">More...</a><br /></td></tr>
<tr class="separator:a724c7f155d4ad57fb367bf93f02d91b5"><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:a08bd75b482aabc45114dbcb53f004fe6"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="mainloop-signal_8h.html#a08bd75b482aabc45114dbcb53f004fe6">pa_signal_init</a> (<a class="el" href="structpa__mainloop__api.html">pa_mainloop_api</a> *api)</td></tr>
<tr class="memdesc:a08bd75b482aabc45114dbcb53f004fe6"><td class="mdescLeft"> </td><td class="mdescRight">Initialize the UNIX signal subsystem and bind it to the specified main loop. <a href="#a08bd75b482aabc45114dbcb53f004fe6">More...</a><br /></td></tr>
<tr class="separator:a08bd75b482aabc45114dbcb53f004fe6"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ae75dbfe9876a5482a5c644bac5abf479"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="mainloop-signal_8h.html#ae75dbfe9876a5482a5c644bac5abf479">pa_signal_done</a> (void)</td></tr>
<tr class="memdesc:ae75dbfe9876a5482a5c644bac5abf479"><td class="mdescLeft"> </td><td class="mdescRight">Cleanup the signal subsystem. <a href="#ae75dbfe9876a5482a5c644bac5abf479">More...</a><br /></td></tr>
<tr class="separator:ae75dbfe9876a5482a5c644bac5abf479"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ac1648b4c7046eea5809e21838b604d12"><td class="memItemLeft" align="right" valign="top"><a class="el" href="mainloop-signal_8h.html#a8346c68814daec286cef332fa9df302c">pa_signal_event</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="mainloop-signal_8h.html#ac1648b4c7046eea5809e21838b604d12">pa_signal_new</a> (int sig, <a class="el" href="mainloop-signal_8h.html#a7d658f2cba34a9fa27d7270269b5d88e">pa_signal_cb_t</a> callback, void *userdata)</td></tr>
<tr class="memdesc:ac1648b4c7046eea5809e21838b604d12"><td class="mdescLeft"> </td><td class="mdescRight">Create a new UNIX signal event source object. <a href="#ac1648b4c7046eea5809e21838b604d12">More...</a><br /></td></tr>
<tr class="separator:ac1648b4c7046eea5809e21838b604d12"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ab5a95e3bcd871864274083aea58a60fa"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="mainloop-signal_8h.html#ab5a95e3bcd871864274083aea58a60fa">pa_signal_free</a> (<a class="el" href="mainloop-signal_8h.html#a8346c68814daec286cef332fa9df302c">pa_signal_event</a> *e)</td></tr>
<tr class="memdesc:ab5a95e3bcd871864274083aea58a60fa"><td class="mdescLeft"> </td><td class="mdescRight">Free a UNIX signal event source object. <a href="#ab5a95e3bcd871864274083aea58a60fa">More...</a><br /></td></tr>
<tr class="separator:ab5a95e3bcd871864274083aea58a60fa"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a50aae9c5fa6b8a3466a8e36fd2d437e2"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="mainloop-signal_8h.html#a50aae9c5fa6b8a3466a8e36fd2d437e2">pa_signal_set_destroy</a> (<a class="el" href="mainloop-signal_8h.html#a8346c68814daec286cef332fa9df302c">pa_signal_event</a> *e, <a class="el" href="mainloop-signal_8h.html#a724c7f155d4ad57fb367bf93f02d91b5">pa_signal_destroy_cb_t</a> callback)</td></tr>
<tr class="memdesc:a50aae9c5fa6b8a3466a8e36fd2d437e2"><td class="mdescLeft"> </td><td class="mdescRight">Set a function that is called when the signal event source is destroyed. <a href="#a50aae9c5fa6b8a3466a8e36fd2d437e2">More...</a><br /></td></tr>
<tr class="separator:a50aae9c5fa6b8a3466a8e36fd2d437e2"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>UNIX signal support for main loops. </p>
<p>In contrast to other main loop event sources such as timer and IO events, UNIX signal support requires modification of the global process environment. Due to this the generic main loop abstraction layer as defined in <a class="el" href="mainloop-api_8h.html">mainloop-api.h</a> doesn't have direct support for UNIX signals. However, you may hook signal support into an abstract main loop via the routines defined herein. </p>
</div><h2 class="groupheader">Typedef Documentation</h2>
<a id="a7d658f2cba34a9fa27d7270269b5d88e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7d658f2cba34a9fa27d7270269b5d88e">◆ </a></span>pa_signal_cb_t</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef void(* pa_signal_cb_t) (<a class="el" href="structpa__mainloop__api.html">pa_mainloop_api</a> *api, <a class="el" href="mainloop-signal_8h.html#a8346c68814daec286cef332fa9df302c">pa_signal_event</a> *e, int sig, void *userdata)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Callback prototype for signal events. </p>
</div>
</div>
<a id="a724c7f155d4ad57fb367bf93f02d91b5"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a724c7f155d4ad57fb367bf93f02d91b5">◆ </a></span>pa_signal_destroy_cb_t</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef void(* pa_signal_destroy_cb_t) (<a class="el" href="structpa__mainloop__api.html">pa_mainloop_api</a> *api, <a class="el" href="mainloop-signal_8h.html#a8346c68814daec286cef332fa9df302c">pa_signal_event</a> *e, void *userdata)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Destroy callback prototype for signal events. </p>
</div>
</div>
<a id="a8346c68814daec286cef332fa9df302c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8346c68814daec286cef332fa9df302c">◆ </a></span>pa_signal_event</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef struct <a class="el" href="mainloop-signal_8h.html#a8346c68814daec286cef332fa9df302c">pa_signal_event</a> <a class="el" href="mainloop-signal_8h.html#a8346c68814daec286cef332fa9df302c">pa_signal_event</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>An opaque UNIX signal event source object. </p>
</div>
</div>
<h2 class="groupheader">Function Documentation</h2>
<a id="ae75dbfe9876a5482a5c644bac5abf479"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae75dbfe9876a5482a5c644bac5abf479">◆ </a></span>pa_signal_done()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void pa_signal_done </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Cleanup the signal subsystem. </p>
</div>
</div>
<a id="ab5a95e3bcd871864274083aea58a60fa"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab5a95e3bcd871864274083aea58a60fa">◆ </a></span>pa_signal_free()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void pa_signal_free </td>
<td>(</td>
<td class="paramtype"><a class="el" href="mainloop-signal_8h.html#a8346c68814daec286cef332fa9df302c">pa_signal_event</a> * </td>
<td class="paramname"><em>e</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Free a UNIX signal event source object. </p>
</div>
</div>
<a id="a08bd75b482aabc45114dbcb53f004fe6"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a08bd75b482aabc45114dbcb53f004fe6">◆ </a></span>pa_signal_init()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int pa_signal_init </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structpa__mainloop__api.html">pa_mainloop_api</a> * </td>
<td class="paramname"><em>api</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Initialize the UNIX signal subsystem and bind it to the specified main loop. </p>
</div>
</div>
<a id="ac1648b4c7046eea5809e21838b604d12"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac1648b4c7046eea5809e21838b604d12">◆ </a></span>pa_signal_new()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="mainloop-signal_8h.html#a8346c68814daec286cef332fa9df302c">pa_signal_event</a>* pa_signal_new </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"><em>sig</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="mainloop-signal_8h.html#a7d658f2cba34a9fa27d7270269b5d88e">pa_signal_cb_t</a> </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>Create a new UNIX signal event source object. </p>
</div>
</div>
<a id="a50aae9c5fa6b8a3466a8e36fd2d437e2"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a50aae9c5fa6b8a3466a8e36fd2d437e2">◆ </a></span>pa_signal_set_destroy()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void pa_signal_set_destroy </td>
<td>(</td>
<td class="paramtype"><a class="el" href="mainloop-signal_8h.html#a8346c68814daec286cef332fa9df302c">pa_signal_event</a> * </td>
<td class="paramname"><em>e</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="mainloop-signal_8h.html#a724c7f155d4ad57fb367bf93f02d91b5">pa_signal_destroy_cb_t</a> </td>
<td class="paramname"><em>callback</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Set a function that is called when the signal event source is destroyed. </p>
<p>Use this to free the userdata argument if required </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-signal_8h.html">mainloop-signal.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
>
202
