[apple/xnu.git] / osfmk / man / io_done_queue_create.html

<h2>io_done_queue_create</h2>\r<hr>\r<p>\r<strong>Function</strong> - Create an <strong>io_done_queue</strong> kernel object.\r<h3>SYNOPSIS</h3>\r<pre>\r<strong>kern_return_t   io_done_queue_create</strong>\r                <strong>(mach_port_t</strong>                               <var>host</var>,\r                 <strong>mach_port_t</strong>                               <var>queue</var><strong>);</strong>\r</pre>\r<h3>PARAMETERS</h3>\r<dl>\r<p>\r<dt> <var>host</var>\r<dd>\r[in host-name send right] The name (or control) port for the host on \rwhich the io_done_queue should be created.\r<p>\r<dt> <var>queue</var>\r<dd>\r[out io-done-queue send right] The port referencing the created\rio_done_queue.\r</dl>\r<h3>DESCRIPTION</h3>\r<p>\rThe io_done_queue_create function is called to create a new\rinstatiation of the kernel object supporting asynchronous read/write\roperations on a device.\r<h3>RETURN VALUES</h3>\r<dl>\r<dt> <strong>KERN_INVALID_ARGUMENT</strong>\r<dd>\r     Invalid <var>host</var> parameter.\r     <p>\r     <dt> <strong>KERN_RESOURCE_SHORTAGE</strong>\r<dd>\r     Insufficient kernel resources to allocate kernel object.\r</dl>\r<h3>RELATED INFORMATION</h3>\r<p>\rFunctions:\r<a href="io_done_queue_terminate.html"><strong>io_done_queue_terminate</strong></a>,\r<a href="io_done_queue_wait.html"><strong>io_done_queue_wait</strong></a>,\r<a href="device_read_async.html"><strong>device_read_async</strong></a>,\r<a href="device_read_async_inband.html"><strong>device_read_async_inband</strong></a>,\r<a href="DR_overwrite_async.html"><strong>device_read_overwrite_async</strong></a>,\r<a href="device_write_async.html"><strong>device_write_async</strong></a>,\r<a href="device_write_async_inband.html"><strong>device_write_async_inband</strong></a>.\r