summaryrefslogtreecommitdiff
path: root/build/doc/html/work-queue_8h_source.html
diff options
context:
space:
mode:
Diffstat (limited to 'build/doc/html/work-queue_8h_source.html')
-rw-r--r--build/doc/html/work-queue_8h_source.html93
1 files changed, 93 insertions, 0 deletions
diff --git a/build/doc/html/work-queue_8h_source.html b/build/doc/html/work-queue_8h_source.html
new file mode 100644
index 00000000..0e99e79d
--- /dev/null
+++ b/build/doc/html/work-queue_8h_source.html
@@ -0,0 +1,93 @@
+<!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.8.15"/>
+<meta name="viewport" content="width=device-width, initial-scale=1"/>
+<title>PipeWire: work-queue.h Source File</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">
+/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
+ $(document).ready(initResizable);
+/* @license-end */</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">PipeWire
+ &#160;<span id="projectnumber">0.2.9</span>
+ </div>
+ </td>
+ </tr>
+ </tbody>
+</table>
+</div>
+<!-- end header part -->
+<!-- Generated by Doxygen 1.8.15 -->
+<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&amp;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&amp;dn=gpl-2.0.txt GPL-v2 */
+$(document).ready(function(){initNavTree('work-queue_8h_source.html','');});
+/* @license-end */
+</script>
+<div id="doc-content">
+<div class="header">
+ <div class="headertitle">
+<div class="title">work-queue.h</div> </div>
+</div><!--header-->
+<div class="contents">
+<a href="work-queue_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span>&#160;<span class="comment">/* PipeWire</span></div><div class="line"><a name="l00002"></a><span class="lineno"> 2</span>&#160;<span class="comment"> *</span></div><div class="line"><a name="l00003"></a><span class="lineno"> 3</span>&#160;<span class="comment"> * Copyright © 2018 Wim Taymans</span></div><div class="line"><a name="l00004"></a><span class="lineno"> 4</span>&#160;<span class="comment"> *</span></div><div class="line"><a name="l00005"></a><span class="lineno"> 5</span>&#160;<span class="comment"> * Permission is hereby granted, free of charge, to any person obtaining a</span></div><div class="line"><a name="l00006"></a><span class="lineno"> 6</span>&#160;<span class="comment"> * copy of this software and associated documentation files (the &quot;Software&quot;),</span></div><div class="line"><a name="l00007"></a><span class="lineno"> 7</span>&#160;<span class="comment"> * to deal in the Software without restriction, including without limitation</span></div><div class="line"><a name="l00008"></a><span class="lineno"> 8</span>&#160;<span class="comment"> * the rights to use, copy, modify, merge, publish, distribute, sublicense,</span></div><div class="line"><a name="l00009"></a><span class="lineno"> 9</span>&#160;<span class="comment"> * and/or sell copies of the Software, and to permit persons to whom the</span></div><div class="line"><a name="l00010"></a><span class="lineno"> 10</span>&#160;<span class="comment"> * Software is furnished to do so, subject to the following conditions:</span></div><div class="line"><a name="l00011"></a><span class="lineno"> 11</span>&#160;<span class="comment"> *</span></div><div class="line"><a name="l00012"></a><span class="lineno"> 12</span>&#160;<span class="comment"> * The above copyright notice and this permission notice (including the next</span></div><div class="line"><a name="l00013"></a><span class="lineno"> 13</span>&#160;<span class="comment"> * paragraph) shall be included in all copies or substantial portions of the</span></div><div class="line"><a name="l00014"></a><span class="lineno"> 14</span>&#160;<span class="comment"> * Software.</span></div><div class="line"><a name="l00015"></a><span class="lineno"> 15</span>&#160;<span class="comment"> *</span></div><div class="line"><a name="l00016"></a><span class="lineno"> 16</span>&#160;<span class="comment"> * THE SOFTWARE IS PROVIDED &quot;AS IS&quot;, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR</span></div><div class="line"><a name="l00017"></a><span class="lineno"> 17</span>&#160;<span class="comment"> * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,</span></div><div class="line"><a name="l00018"></a><span class="lineno"> 18</span>&#160;<span class="comment"> * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL</span></div><div class="line"><a name="l00019"></a><span class="lineno"> 19</span>&#160;<span class="comment"> * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER</span></div><div class="line"><a name="l00020"></a><span class="lineno"> 20</span>&#160;<span class="comment"> * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING</span></div><div class="line"><a name="l00021"></a><span class="lineno"> 21</span>&#160;<span class="comment"> * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER</span></div><div class="line"><a name="l00022"></a><span class="lineno"> 22</span>&#160;<span class="comment"> * DEALINGS IN THE SOFTWARE.</span></div><div class="line"><a name="l00023"></a><span class="lineno"> 23</span>&#160;<span class="comment"> */</span></div><div class="line"><a name="l00024"></a><span class="lineno"> 24</span>&#160;</div><div class="line"><a name="l00025"></a><span class="lineno"> 25</span>&#160;<span class="preprocessor">#ifndef PIPEWIRE_WORK_QUEUE_H</span></div><div class="line"><a name="l00026"></a><span class="lineno"> 26</span>&#160;<span class="preprocessor">#define PIPEWIRE_WORK_QUEUE_H</span></div><div class="line"><a name="l00027"></a><span class="lineno"> 27</span>&#160;</div><div class="line"><a name="l00028"></a><span class="lineno"> 28</span>&#160;<span class="preprocessor">#ifdef __cplusplus</span></div><div class="line"><a name="l00029"></a><span class="lineno"> 29</span>&#160;<span class="keyword">extern</span> <span class="stringliteral">&quot;C&quot;</span> {</div><div class="line"><a name="l00030"></a><span class="lineno"> 30</span>&#160;<span class="preprocessor">#endif</span></div><div class="line"><a name="l00031"></a><span class="lineno"> 31</span>&#160;</div><div class="line"><a name="l00036"></a><span class="lineno"> 36</span>&#160;<span class="keyword">struct </span><a class="code" href="classpw__work__queue.html">pw_work_queue</a>;</div><div class="line"><a name="l00037"></a><span class="lineno"> 37</span>&#160;</div><div class="line"><a name="l00038"></a><span class="lineno"> 38</span>&#160;<span class="preprocessor">#include &lt;<a class="code" href="loop_8h.html">pipewire/loop.h</a>&gt;</span></div><div class="line"><a name="l00039"></a><span class="lineno"> 39</span>&#160;</div><div class="line"><a name="l00040"></a><span class="lineno"><a class="line" href="work-queue_8h.html#a528c2be5bb8ef21bdbe8bfa44485f8bb"> 40</a></span>&#160;<span class="keyword">typedef</span> void (*<a class="code" href="work-queue_8h.html#a528c2be5bb8ef21bdbe8bfa44485f8bb">pw_work_func_t</a>) (<span class="keywordtype">void</span> *obj, <span class="keywordtype">void</span> *<a class="code" href="structdata.html">data</a>, <span class="keywordtype">int</span> res, uint32_t id);</div><div class="line"><a name="l00041"></a><span class="lineno"> 41</span>&#160;</div><div class="line"><a name="l00042"></a><span class="lineno"> 42</span>&#160;<span class="keyword">struct </span><a class="code" href="classpw__work__queue.html">pw_work_queue</a> *</div><div class="line"><a name="l00043"></a><span class="lineno"> 43</span>&#160;<a class="code" href="classpw__work__queue.html#acf03a683177510e35a3859ac16a08119">pw_work_queue_new</a>(<span class="keyword">struct</span> <a class="code" href="structpw__loop.html">pw_loop</a> *loop);</div><div class="line"><a name="l00044"></a><span class="lineno"> 44</span>&#160;</div><div class="line"><a name="l00045"></a><span class="lineno"> 45</span>&#160;<span class="keywordtype">void</span></div><div class="line"><a name="l00046"></a><span class="lineno"> 46</span>&#160;<a class="code" href="classpw__work__queue.html#aa9e1df12736d075ba973a19f4333c2eb">pw_work_queue_destroy</a>(<span class="keyword">struct</span> <a class="code" href="classpw__work__queue.html">pw_work_queue</a> *<a class="code" href="structqueue.html">queue</a>);</div><div class="line"><a name="l00047"></a><span class="lineno"> 47</span>&#160;</div><div class="line"><a name="l00048"></a><span class="lineno"> 48</span>&#160;uint32_t</div><div class="line"><a name="l00049"></a><span class="lineno"> 49</span>&#160;<a class="code" href="classpw__work__queue.html#a31cc6b38eda61a244c7d3fd9024a74db">pw_work_queue_add</a>(<span class="keyword">struct</span> <a class="code" href="classpw__work__queue.html">pw_work_queue</a> *<a class="code" href="structqueue.html">queue</a>,</div><div class="line"><a name="l00050"></a><span class="lineno"> 50</span>&#160; <span class="keywordtype">void</span> *obj, <span class="keywordtype">int</span> res,</div><div class="line"><a name="l00051"></a><span class="lineno"> 51</span>&#160; <a class="code" href="work-queue_8h.html#a528c2be5bb8ef21bdbe8bfa44485f8bb">pw_work_func_t</a> func, <span class="keywordtype">void</span> *<a class="code" href="structdata.html">data</a>);</div><div class="line"><a name="l00052"></a><span class="lineno"> 52</span>&#160;</div><div class="line"><a name="l00053"></a><span class="lineno"> 53</span>&#160;<span class="keywordtype">int</span></div><div class="line"><a name="l00054"></a><span class="lineno"> 54</span>&#160;<a class="code" href="classpw__work__queue.html#a56673e78071d8a9eb28805331c8b2245">pw_work_queue_cancel</a>(<span class="keyword">struct</span> <a class="code" href="classpw__work__queue.html">pw_work_queue</a> *<a class="code" href="structqueue.html">queue</a>, <span class="keywordtype">void</span> *obj, uint32_t <span class="keywordtype">id</span>);</div><div class="line"><a name="l00055"></a><span class="lineno"> 55</span>&#160;</div><div class="line"><a name="l00056"></a><span class="lineno"> 56</span>&#160;<span class="keywordtype">int</span></div><div class="line"><a name="l00057"></a><span class="lineno"> 57</span>&#160;<a class="code" href="classpw__work__queue.html#a7a8bde683bc6cb8091a7d7be9df250fc">pw_work_queue_complete</a>(<span class="keyword">struct</span> <a class="code" href="classpw__work__queue.html">pw_work_queue</a> *<a class="code" href="structqueue.html">queue</a>, <span class="keywordtype">void</span> *obj, uint32_t seq, <span class="keywordtype">int</span> res);</div><div class="line"><a name="l00058"></a><span class="lineno"> 58</span>&#160;</div><div class="line"><a name="l00059"></a><span class="lineno"> 59</span>&#160;<span class="preprocessor">#ifdef __cplusplus</span></div><div class="line"><a name="l00060"></a><span class="lineno"> 60</span>&#160;}</div><div class="line"><a name="l00061"></a><span class="lineno"> 61</span>&#160;<span class="preprocessor">#endif</span></div><div class="line"><a name="l00062"></a><span class="lineno"> 62</span>&#160;</div><div class="line"><a name="l00063"></a><span class="lineno"> 63</span>&#160;<span class="preprocessor">#endif </span><span class="comment">/* PIPEWIRE_WORK_QUEUE_H */</span><span class="preprocessor"></span></div><div class="ttc" id="classpw__work__queue_html"><div class="ttname"><a href="classpw__work__queue.html">pw_work_queue</a></div><div class="ttdoc">PipeWire work queue object.</div></div>
+<div class="ttc" id="structpw__loop_html"><div class="ttname"><a href="structpw__loop.html">pw_loop</a></div><div class="ttdoc">PipeWire loop object provides an implementation of the spa loop interfaces.</div><div class="ttdef"><b>Definition:</b> loop.h:42</div></div>
+<div class="ttc" id="classpw__work__queue_html_aa9e1df12736d075ba973a19f4333c2eb"><div class="ttname"><a href="classpw__work__queue.html#aa9e1df12736d075ba973a19f4333c2eb">pw_work_queue::pw_work_queue_destroy</a></div><div class="ttdeci">void pw_work_queue_destroy(struct pw_work_queue *queue)</div><div class="ttdoc">Destroy a work queue.</div><div class="ttdef"><b>Definition:</b> work-queue.c:131</div></div>
+<div class="ttc" id="classpw__work__queue_html_a56673e78071d8a9eb28805331c8b2245"><div class="ttname"><a href="classpw__work__queue.html#a56673e78071d8a9eb28805331c8b2245">pw_work_queue::pw_work_queue_cancel</a></div><div class="ttdeci">int pw_work_queue_cancel(struct pw_work_queue *queue, void *obj, uint32_t id)</div><div class="ttdoc">Cancel a work item.</div><div class="ttdef"><b>Definition:</b> work-queue.c:210</div></div>
+<div class="ttc" id="classpw__work__queue_html_a31cc6b38eda61a244c7d3fd9024a74db"><div class="ttname"><a href="classpw__work__queue.html#a31cc6b38eda61a244c7d3fd9024a74db">pw_work_queue::pw_work_queue_add</a></div><div class="ttdeci">uint32_t pw_work_queue_add(struct pw_work_queue *queue, void *obj, int res, pw_work_func_t func, void *data)</div><div class="ttdoc">Add an item to the work queue.</div><div class="ttdef"><b>Definition:</b> work-queue.c:161</div></div>
+<div class="ttc" id="structqueue_html"><div class="ttname"><a href="structqueue.html">queue</a></div><div class="ttdef"><b>Definition:</b> stream.c:62</div></div>
+<div class="ttc" id="loop_8h_html"><div class="ttname"><a href="loop_8h.html">loop.h</a></div></div>
+<div class="ttc" id="classpw__work__queue_html_a7a8bde683bc6cb8091a7d7be9df250fc"><div class="ttname"><a href="classpw__work__queue.html#a7a8bde683bc6cb8091a7d7be9df250fc">pw_work_queue::pw_work_queue_complete</a></div><div class="ttdeci">int pw_work_queue_complete(struct pw_work_queue *queue, void *obj, uint32_t seq, int res)</div><div class="ttdoc">Complete a work item.</div><div class="ttdef"><b>Definition:</b> work-queue.c:241</div></div>
+<div class="ttc" id="work-queue_8h_html_a528c2be5bb8ef21bdbe8bfa44485f8bb"><div class="ttname"><a href="work-queue_8h.html#a528c2be5bb8ef21bdbe8bfa44485f8bb">pw_work_func_t</a></div><div class="ttdeci">void(* pw_work_func_t)(void *obj, void *data, int res, uint32_t id)</div><div class="ttdef"><b>Definition:</b> work-queue.h:40</div></div>
+<div class="ttc" id="structdata_html"><div class="ttname"><a href="structdata.html">data</a></div><div class="ttdef"><b>Definition:</b> stream.c:69</div></div>
+<div class="ttc" id="classpw__work__queue_html_acf03a683177510e35a3859ac16a08119"><div class="ttname"><a href="classpw__work__queue.html#acf03a683177510e35a3859ac16a08119">pw_work_queue::pw_work_queue_new</a></div><div class="ttdeci">struct pw_work_queue * pw_work_queue_new(struct pw_loop *loop)</div><div class="ttdoc">Create a new pw_work_queue.</div><div class="ttdef"><b>Definition:</b> work-queue.c:96</div></div>
+</div><!-- fragment --></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_7129a66c92fe7beef816c2ac906ef0b3.html">pipewire</a></li><li class="navelem"><a class="el" href="work-queue_8h.html">work-queue.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.15 </li>
+ </ul>
+</div>
+</body>
+</html>