<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> <html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8"> <title>PulseAudio: operation.h File Reference</title> <link href="doxygen.css" rel="stylesheet" type="text/css"> <link href="tabs.css" rel="stylesheet" type="text/css"> </head><body> <!-- Generated by Doxygen 1.5.5 --> <div class="navigation" id="top"> <div class="tabs"> <ul> <li><a href="main.html"><span>Main Page</span></a></li> <li><a href="pages.html"><span>Related Pages</span></a></li> <li><a href="classes.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> <div class="contents"> <h1>operation.h File Reference</h1>Asynchronous operations. <a href="#_details">More...</a> <p> <p> <a href="operation_8h-source.html">Go to the source code of this file.</a><table border="0" cellpadding="0" cellspacing="0"> <tr><td></td></tr> <tr><td colspan="2"><br><h2>Typedefs</h2></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">typedef struct <a class="el" href="operation_8h.html#5614a07f2e7a129e4cb16596ed452a0c">pa_operation</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="operation_8h.html#5614a07f2e7a129e4cb16596ed452a0c">pa_operation</a></td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">An asynchronous operation object. <a href="#5614a07f2e7a129e4cb16596ed452a0c"></a><br></td></tr> <tr><td colspan="2"><br><h2>Functions</h2></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="operation_8h.html#5614a07f2e7a129e4cb16596ed452a0c">pa_operation</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="operation_8h.html#7a3c7d92ccff6291242c5ba44e98d648">pa_operation_ref</a> (<a class="el" href="operation_8h.html#5614a07f2e7a129e4cb16596ed452a0c">pa_operation</a> *o)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Increase the reference count by one. <a href="#7a3c7d92ccff6291242c5ba44e98d648"></a><br></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="operation_8h.html#8d2ef9bb2ff961ee31675882bf125227">pa_operation_unref</a> (<a class="el" href="operation_8h.html#5614a07f2e7a129e4cb16596ed452a0c">pa_operation</a> *o)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Decrease the reference count by one. <a href="#8d2ef9bb2ff961ee31675882bf125227"></a><br></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="operation_8h.html#2629761f072c1ffa8114dd85220768f6">pa_operation_cancel</a> (<a class="el" href="operation_8h.html#5614a07f2e7a129e4cb16596ed452a0c">pa_operation</a> *o)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Cancel the operation. <a href="#2629761f072c1ffa8114dd85220768f6"></a><br></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="def_8h.html#7690ad935f83aee30828308c8e63bda4">pa_operation_state_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="operation_8h.html#cabeaea114e87658e1dadc214d7a2c35">pa_operation_get_state</a> (<a class="el" href="operation_8h.html#5614a07f2e7a129e4cb16596ed452a0c">pa_operation</a> *o)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Return the current status of the operation. <a href="#cabeaea114e87658e1dadc214d7a2c35"></a><br></td></tr> </table> <hr><a name="_details"></a><h2>Detailed Description</h2> Asynchronous operations. <p> <hr><h2>Typedef Documentation</h2> <a class="anchor" name="5614a07f2e7a129e4cb16596ed452a0c"></a><!-- doxytag: member="operation.h::pa_operation" ref="5614a07f2e7a129e4cb16596ed452a0c" args="" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">typedef struct <a class="el" href="operation_8h.html#5614a07f2e7a129e4cb16596ed452a0c">pa_operation</a> <a class="el" href="operation_8h.html#5614a07f2e7a129e4cb16596ed452a0c">pa_operation</a> </td> </tr> </table> </div> <div class="memdoc"> <p> An asynchronous operation object. <p> <dl compact><dt><b>Examples: </b></dt><dd> <a class="el" href="pacat_8c-example.html#a63">pacat.c</a>, and <a class="el" href="paplay_8c-example.html#a9">paplay.c</a>.</dl> </div> </div><p> <hr><h2>Function Documentation</h2> <a class="anchor" name="2629761f072c1ffa8114dd85220768f6"></a><!-- doxytag: member="operation.h::pa_operation_cancel" ref="2629761f072c1ffa8114dd85220768f6" args="(pa_operation *o)" --> <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#5614a07f2e7a129e4cb16596ed452a0c">pa_operation</a> * </td> <td class="paramname"> <em>o</em> </td> <td> ) </td> <td width="100%"></td> </tr> </table> </div> <div class="memdoc"> <p> Cancel the operation. <p> Beware! This will not necessarily cancel the execution of the operation on the server side. </div> </div><p> <a class="anchor" name="cabeaea114e87658e1dadc214d7a2c35"></a><!-- doxytag: member="operation.h::pa_operation_get_state" ref="cabeaea114e87658e1dadc214d7a2c35" args="(pa_operation *o)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="def_8h.html#7690ad935f83aee30828308c8e63bda4">pa_operation_state_t</a> pa_operation_get_state </td> <td>(</td> <td class="paramtype"><a class="el" href="operation_8h.html#5614a07f2e7a129e4cb16596ed452a0c">pa_operation</a> * </td> <td class="paramname"> <em>o</em> </td> <td> ) </td> <td width="100%"></td> </tr> </table> </div> <div class="memdoc"> <p> Return the current status of the operation. <p> </div> </div><p> <a class="anchor" name="7a3c7d92ccff6291242c5ba44e98d648"></a><!-- doxytag: member="operation.h::pa_operation_ref" ref="7a3c7d92ccff6291242c5ba44e98d648" args="(pa_operation *o)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="operation_8h.html#5614a07f2e7a129e4cb16596ed452a0c">pa_operation</a>* pa_operation_ref </td> <td>(</td> <td class="paramtype"><a class="el" href="operation_8h.html#5614a07f2e7a129e4cb16596ed452a0c">pa_operation</a> * </td> <td class="paramname"> <em>o</em> </td> <td> ) </td> <td width="100%"></td> </tr> </table> </div> <div class="memdoc"> <p> Increase the reference count by one. <p> </div> </div><p> <a class="anchor" name="8d2ef9bb2ff961ee31675882bf125227"></a><!-- doxytag: member="operation.h::pa_operation_unref" ref="8d2ef9bb2ff961ee31675882bf125227" args="(pa_operation *o)" --> <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#5614a07f2e7a129e4cb16596ed452a0c">pa_operation</a> * </td> <td class="paramname"> <em>o</em> </td> <td> ) </td> <td width="100%"></td> </tr> </table> </div> <div class="memdoc"> <p> Decrease the reference count by one. <p> <dl compact><dt><b>Examples: </b></dt><dd> <a class="el" href="pacat_8c-example.html#a71">pacat.c</a>, and <a class="el" href="paplay_8c-example.html#a15">paplay.c</a>.</dl> </div> </div><p> </div> <hr size="1"><address style="text-align: right;"><small>Generated on Wed Mar 26 12:02:40 2008 for PulseAudio by <a href="http://www.doxygen.org/index.html"> <img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.5 </small></address> </body> </html>