<!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: operation.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('operation_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">operation.h File Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Asynchronous operations.
<a href="#details">More...</a></p>
<p><a href="operation_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:a5614a07f2e7a129e4cb16596ed452a0c"><td class="memItemLeft" align="right" valign="top">typedef struct <a class="el" href="operation_8h.html#a5614a07f2e7a129e4cb16596ed452a0c">pa_operation</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="operation_8h.html#a5614a07f2e7a129e4cb16596ed452a0c">pa_operation</a></td></tr>
<tr class="memdesc:a5614a07f2e7a129e4cb16596ed452a0c"><td class="mdescLeft"> </td><td class="mdescRight">An asynchronous operation object. <a href="#a5614a07f2e7a129e4cb16596ed452a0c">More...</a><br /></td></tr>
<tr class="separator:a5614a07f2e7a129e4cb16596ed452a0c"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a17b3ad7cd9302460790fe3bd194f0d59"><td class="memItemLeft" align="right" valign="top">typedef void(* </td><td class="memItemRight" valign="bottom"><a class="el" href="operation_8h.html#a17b3ad7cd9302460790fe3bd194f0d59">pa_operation_notify_cb_t</a>) (<a class="el" href="operation_8h.html#a5614a07f2e7a129e4cb16596ed452a0c">pa_operation</a> *o, void *userdata)</td></tr>
<tr class="memdesc:a17b3ad7cd9302460790fe3bd194f0d59"><td class="mdescLeft"> </td><td class="mdescRight">A callback for operation state changes. <a href="#a17b3ad7cd9302460790fe3bd194f0d59">More...</a><br /></td></tr>
<tr class="separator:a17b3ad7cd9302460790fe3bd194f0d59"><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:a7a3c7d92ccff6291242c5ba44e98d648"><td class="memItemLeft" align="right" valign="top"><a class="el" href="operation_8h.html#a5614a07f2e7a129e4cb16596ed452a0c">pa_operation</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="operation_8h.html#a7a3c7d92ccff6291242c5ba44e98d648">pa_operation_ref</a> (<a class="el" href="operation_8h.html#a5614a07f2e7a129e4cb16596ed452a0c">pa_operation</a> *o)</td></tr>
<tr class="memdesc:a7a3c7d92ccff6291242c5ba44e98d648"><td class="mdescLeft"> </td><td class="mdescRight">Increase the reference count by one. <a href="#a7a3c7d92ccff6291242c5ba44e98d648">More...</a><br /></td></tr>
<tr class="separator:a7a3c7d92ccff6291242c5ba44e98d648"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a8d2ef9bb2ff961ee31675882bf125227"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="operation_8h.html#a8d2ef9bb2ff961ee31675882bf125227">pa_operation_unref</a> (<a class="el" href="operation_8h.html#a5614a07f2e7a129e4cb16596ed452a0c">pa_operation</a> *o)</td></tr>
<tr class="memdesc:a8d2ef9bb2ff961ee31675882bf125227"><td class="mdescLeft"> </td><td class="mdescRight">Decrease the reference count by one. <a href="#a8d2ef9bb2ff961ee31675882bf125227">More...</a><br /></td></tr>
<tr class="separator:a8d2ef9bb2ff961ee31675882bf125227"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a2629761f072c1ffa8114dd85220768f6"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="operation_8h.html#a2629761f072c1ffa8114dd85220768f6">pa_operation_cancel</a> (<a class="el" href="operation_8h.html#a5614a07f2e7a129e4cb16596ed452a0c">pa_operation</a> *o)</td></tr>
<tr class="memdesc:a2629761f072c1ffa8114dd85220768f6"><td class="mdescLeft"> </td><td class="mdescRight">Cancel the operation. <a href="#a2629761f072c1ffa8114dd85220768f6">More...</a><br /></td></tr>
<tr class="separator:a2629761f072c1ffa8114dd85220768f6"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:acabeaea114e87658e1dadc214d7a2c35"><td class="memItemLeft" align="right" valign="top"><a class="el" href="def_8h.html#a7690ad935f83aee30828308c8e63bda4">pa_operation_state_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="operation_8h.html#acabeaea114e87658e1dadc214d7a2c35">pa_operation_get_state</a> (<a class="el" href="operation_8h.html#a5614a07f2e7a129e4cb16596ed452a0c">pa_operation</a> *o)</td></tr>
<tr class="memdesc:acabeaea114e87658e1dadc214d7a2c35"><td class="mdescLeft"> </td><td class="mdescRight">Return the current status of the operation. <a href="#acabeaea114e87658e1dadc214d7a2c35">More...</a><br /></td></tr>
<tr class="separator:acabeaea114e87658e1dadc214d7a2c35"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aa4ed26ddfbe9c2d5adbc81cf9cc8f8f7"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="operation_8h.html#aa4ed26ddfbe9c2d5adbc81cf9cc8f8f7">pa_operation_set_state_callback</a> (<a class="el" href="operation_8h.html#a5614a07f2e7a129e4cb16596ed452a0c">pa_operation</a> *o, <a class="el" href="operation_8h.html#a17b3ad7cd9302460790fe3bd194f0d59">pa_operation_notify_cb_t</a> cb, void *userdata)</td></tr>
<tr class="memdesc:aa4ed26ddfbe9c2d5adbc81cf9cc8f8f7"><td class="mdescLeft"> </td><td class="mdescRight">Set the callback function that is called when the operation state changes. <a href="#aa4ed26ddfbe9c2d5adbc81cf9cc8f8f7">More...</a><br /></td></tr>
<tr class="separator:aa4ed26ddfbe9c2d5adbc81cf9cc8f8f7"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Asynchronous operations. </p>
</div><h2 class="groupheader">Typedef Documentation</h2>
<a id="a5614a07f2e7a129e4cb16596ed452a0c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5614a07f2e7a129e4cb16596ed452a0c">◆ </a></span>pa_operation</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef struct <a class="el" href="operation_8h.html#a5614a07f2e7a129e4cb16596ed452a0c">pa_operation</a> <a class="el" href="operation_8h.html#a5614a07f2e7a129e4cb16596ed452a0c">pa_operation</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>An asynchronous operation object. </p>
</div>
</div>
<a id="a17b3ad7cd9302460790fe3bd194f0d59"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a17b3ad7cd9302460790fe3bd194f0d59">◆ </a></span>pa_operation_notify_cb_t</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef void(* pa_operation_notify_cb_t) (<a class="el" href="operation_8h.html#a5614a07f2e7a129e4cb16596ed452a0c">pa_operation</a> *o, void *userdata)</td>
</tr>
</table>
</div><div class="memdoc">
<p>A callback for operation state changes. </p>
</div>
</div>
<h2 class="groupheader">Function Documentation</h2>
<a id="a2629761f072c1ffa8114dd85220768f6"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2629761f072c1ffa8114dd85220768f6">◆ </a></span>pa_operation_cancel()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void pa_operation_cancel </td>
<td>(</td>
<td class="paramtype"><a class="el" href="operation_8h.html#a5614a07f2e7a129e4cb16596ed452a0c">pa_operation</a> * </td>
<td class="paramname"><em>o</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Cancel the operation. </p>
<p>Beware! This will not necessarily cancel the execution of the operation on the server side. However it will make sure that the callback associated with this operation will not be called anymore, effectively disabling the operation from the client side's view. </p>
</div>
</div>
<a id="acabeaea114e87658e1dadc214d7a2c35"></a>
<h2 class="memtitle"><span class="permalink"><a href="#acabeaea114e87658e1dadc214d7a2c35">◆ </a></span>pa_operation_get_state()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="def_8h.html#a7690ad935f83aee30828308c8e63bda4">pa_operation_state_t</a> pa_operation_get_state </td>
<td>(</td>
<td class="paramtype"><a class="el" href="operation_8h.html#a5614a07f2e7a129e4cb16596ed452a0c">pa_operation</a> * </td>
<td class="paramname"><em>o</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Return the current status of the operation. </p>
</div>
</div>
<a id="a7a3c7d92ccff6291242c5ba44e98d648"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7a3c7d92ccff6291242c5ba44e98d648">◆ </a></span>pa_operation_ref()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="operation_8h.html#a5614a07f2e7a129e4cb16596ed452a0c">pa_operation</a>* pa_operation_ref </td>
<td>(</td>
<td class="paramtype"><a class="el" href="operation_8h.html#a5614a07f2e7a129e4cb16596ed452a0c">pa_operation</a> * </td>
<td class="paramname"><em>o</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Increase the reference count by one. </p>
</div>
</div>
<a id="aa4ed26ddfbe9c2d5adbc81cf9cc8f8f7"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa4ed26ddfbe9c2d5adbc81cf9cc8f8f7">◆ </a></span>pa_operation_set_state_callback()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void pa_operation_set_state_callback </td>
<td>(</td>
<td class="paramtype"><a class="el" href="operation_8h.html#a5614a07f2e7a129e4cb16596ed452a0c">pa_operation</a> * </td>
<td class="paramname"><em>o</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="operation_8h.html#a17b3ad7cd9302460790fe3bd194f0d59">pa_operation_notify_cb_t</a> </td>
<td class="paramname"><em>cb</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>Set the callback function that is called when the operation state changes. </p>
<p>Usually this is not necessary, since the functions that create pa_operation objects already take a callback that is called when the operation finishes. Registering a state change callback is mainly useful, if you want to get called back also if the operation gets cancelled. </p><dl class="section since"><dt>Since</dt><dd>4.0 </dd></dl>
</div>
</div>
<a id="a8d2ef9bb2ff961ee31675882bf125227"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8d2ef9bb2ff961ee31675882bf125227">◆ </a></span>pa_operation_unref()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void pa_operation_unref </td>
<td>(</td>
<td class="paramtype"><a class="el" href="operation_8h.html#a5614a07f2e7a129e4cb16596ed452a0c">pa_operation</a> * </td>
<td class="paramname"><em>o</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Decrease the reference count by one. </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="operation_8h.html">operation.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
>
224
