osfmk/man/io_done_queue_terminate.html

   1 <h2>io_done_queue_terminate</h2>
   2 <hr>
   3 <p>
   4 <strong>Function</strong> - Terminate an io_done_queue kernel object.
   5 <h3>SYNOPSIS</h3>
   6 <pre>
   7 <strong>#include&ltdevice/device.h&gt</strong>
   8
   9 <strong>kern_return_t   io_done_queue_terminate</strong>
  10                 <strong>(mach_port_t</strong>   <var>queue</var><strong>);</strong>
  11 </pre>
  12 <h3>PARAMETERS</h3>
  13 <dl>
  14 <p>
  15 <dt> <var>queue</var>
  16 <dd>
  17 [in io-done-queue send right] The port referencing the <strong>io_done_queue</strong>
  18 to be destroyed.
  19 </dl>
  20 <h3>DESCRIPTION</h3>
  21 <p>
  22 The <strong>io_done_queue_terminate</strong> function is called to destroy a previous
  23 instatiation of the kernel object supporting asynchronous read/write
  24 operations on a device.
  25 <h3>RETURN VALUES</h3>
  26 <dl>
  27   <dt> <strong>KERN_INVALID_ARGUMENT</strong>
  28 <dd>
  29      Invalid <var>queue</var> parameter.
  30      <p>
  31 </dl>
  32 <h3>RELATED INFORMATION</h3>
  33 <p>
  34 Functions:
  35 <a href="io_done_queue_create.html"><strong>io_done_queue_create</strong></a>,
  36 <a href="io_done_queue_wait.html"><strong>io_done_queue_wait</strong></a>,
  37 <a href="device_read_async.html"><strong>device_read_async</strong></a>,
  38 <a href="device_read_async_inband.html"><strong>device_read_async_inband</strong></a>,
  39 <a href="DR_overwrite_async.html"><strong>device_read_overwrite_async</strong></a>,
  40 <a href="device_write_async.html"><strong>device_write_async</strong></a>,
  41 <a href="device_write_async_inband.html"><strong>device_write_async_inband</strong></a>.