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

<h2>mach_port_allocate_qos</h2>\r<hr>\r<p>\r<strong>Function</strong> - Allocate a port with specified "quality of service."\r<h3>SYNOPSIS</h3>\r<pre>\r<strong>kern_return_t	mach_port_allocate_qos</strong>\r		<strong>(ipc_space_t</strong>	<var>task</var>,\r		<strong>mach_port_right_t</strong>	<var>right</var>,\r		<strong>mach_port_qos_t</strong>	<var>qos</var>,\r		<strong>mach_port_name_t*</strong>	<var>name</var><strong>);</strong>\r</pre>\r<h3>PARAMETERS</h3>\r<dl>\r<dt> <var>task</var>\r<dd>\r[in task send right] The task acquiring the port right to the allocated port.\r<dt> <var>right</var>\r<dd>\r[in scalar] The type of port right to map to the allocated port.\r<dt> <var>qos</var>\r<dd>\r[pointer to an in/out structure] Structure used to specify\rthe desired "quality of service." This structure indicates whether\r     or not the caller is providing a name for the port and whether or not\r     the port will exhibit realtime behavior.\r<dt> <var>name</var>\r<dd>\r[in/out scalar] The name of the installed port right, either specified by the\r     caller or chosen by the system.\r</dl>\r<h3>DESCRIPTION</h3>\r<p>\rThe <strong>mach_port_allocate_qos</strong> function allocates a port with\rcaller-specified "quality of service" characteristics with or without a\rcaller-specified name; in other words, the caller may specify a desired name\ror it may let the kernel generate the name.  The new port is capable of\rsupporting full Mach port semantics (i.e no-more-senders notification can be\rrequested on the port).\r<h3>NOTES</h3>\r<p>\rThis interface is machine word length specific because of the port\rname parameter.\r<h3>RETURN VALUES</h3>\r<dl>\r<dt> <strong>KERN_NO_SPACE</strong>\r<dd>\rThere was no room in task's IPC name space for another right.\r<dt> <strong>KERN_INVALID_VALUE</strong>\r<dd>\rThe type of right specified by <var>right</var> is either invalid or conflicts\rwith the requested "quality of service" as specified via <var>qos</var>.\r</dl>\r<h3>RELATED INFORMATION</h3>\r<p>\rFunctions:\r<a href="mach_port_allocate.html"><strong>mach_port_allocate</strong></a>,\r<a href="mach_port_allocate_full.html"><strong>mach_port_allocate_full</strong></a>,\r<a href="mach_port_allocate_name.html"><strong>mach_port_allocate_name</strong></a>,\r<a href="mach_port_deallocate.html"><strong>mach_port_deallocate</strong></a>,\r<a href="mach_port_insert_right.html"><strong>mach_port_insert_right</strong></a>,\r<a href="mach_port_extract_right.html"><strong>mach_port_extract_right</strong></a>.\r<p>\rStructures:\r<a href="mach_port_qos.html"><strong>mach_port_qos</strong></a>.