Sophie

Sophie

distrib > Fedora > 18 > x86_64 > media > updates > by-pkgid > 1a595394b241504ff370a8d12ebfcea7 > files > 735

kernel-doc-3.11.10-100.fc18.noarch.rpm

<?xml version="1.0" encoding="ANSI_X3.4-1968" standalone="no"?>
<!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/html; charset=ANSI_X3.4-1968" /><title>cancel_work_sync</title><meta name="generator" content="DocBook XSL Stylesheets V1.78.1" /><link rel="home" href="index.html" title="Linux Device Drivers" /><link rel="up" href="ch01s06.html" title="Workqueues and Kevents" /><link rel="prev" href="API-flush-work.html" title="flush_work" /><link rel="next" href="API-flush-delayed-work.html" title="flush_delayed_work" /></head><body><div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center"><span class="phrase">cancel_work_sync</span></th></tr><tr><td width="20%" align="left"><a accesskey="p" href="API-flush-work.html">Prev</a>&#160;</td><th width="60%" align="center">Workqueues and Kevents</th><td width="20%" align="right">&#160;<a accesskey="n" href="API-flush-delayed-work.html">Next</a></td></tr></table><hr /></div><div class="refentry"><a id="API-cancel-work-sync"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p>cancel_work_sync &#8212; 
     cancel a work and wait for it to finish
 </p></div><div class="refsynopsisdiv"><h2>Synopsis</h2><div class="funcsynopsis"><table border="0" class="funcprototype-table" summary="Function synopsis" style="cellspacing: 0; cellpadding: 0;"><tr><td><code class="funcdef">bool <strong class="fsfunc">cancel_work_sync </strong>(</code></td><td>struct work_struct * <var class="pdparam">work</var><code>)</code>;</td></tr></table><div class="funcprototype-spacer">&#160;</div></div></div><div class="refsect1"><a id="idm140404967456400"></a><h2>Arguments</h2><div class="variablelist"><dl class="variablelist"><dt><span class="term"><em class="parameter"><code>work</code></em></span></dt><dd><p>
     the work to cancel
    </p></dd></dl></div></div><div class="refsect1"><a id="idm140404967453200"></a><h2>Description</h2><p>
   Cancel <em class="parameter"><code>work</code></em> and wait for its execution to finish.  This function
   can be used even if the work re-queues itself or migrates to
   another workqueue.  On return from this function, <em class="parameter"><code>work</code></em> is
   guaranteed to be not pending or executing on any CPU.
   </p><p>

   cancel_work_sync(<span class="structname">delayed_work</span>-&gt;work) must not be used for
   delayed_work's.  Use <code class="function">cancel_delayed_work_sync</code> instead.
   </p><p>

   The caller must ensure that the workqueue on which <em class="parameter"><code>work</code></em> was last
   queued can't be destroyed before this function returns.
</p></div><div class="refsect1"><a id="idm140404967447664"></a><h2>RETURNS</h2><p>
   <code class="constant">true</code> if <em class="parameter"><code>work</code></em> was pending, <code class="constant">false</code> otherwise.
</p></div></div><div class="navfooter"><hr /><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="API-flush-work.html">Prev</a>&#160;</td><td width="20%" align="center"><a accesskey="u" href="ch01s06.html">Up</a></td><td width="40%" align="right">&#160;<a accesskey="n" href="API-flush-delayed-work.html">Next</a></td></tr><tr><td width="40%" align="left" valign="top"><span class="phrase">flush_work</span>&#160;</td><td width="20%" align="center"><a accesskey="h" href="index.html">Home</a></td><td width="40%" align="right" valign="top">&#160;<span class="phrase">flush_delayed_work</span></td></tr></table></div></body></html>