-<h2>mach_port_allocate_full</h2>
\r<hr>
\r<p>
\r<strong>Function</strong> - Create a port right with full Mach port semantics.
\r<h3>SYNOPSIS</h3>
\r<pre>
\r<strong>kern_return_t mach_port_allocate_full</strong>
\r <strong>(ipc_space_t</strong> <var>task</var>,
\r <strong>mach_port_right_t</strong> <var>right</var>,
\r <strong>subsystem_t</strong> <var>subsystem</var>,
\r <strong>mach_port_qos_t</strong> <var>qos</var>,
\r <strong>task</strong> <var>name</var><strong>);</strong>
\r</pre>
\r<h3>PARAMETERS</h3>
\r<dl>
\r<p>
\r<dt> <var>task</var>
\r<dd>
\r[in task send right] The task acquiring the port right.
\r<p>
\r<dt> <var>right</var>
\r<dd>
\r[in scalar] The kind of entity to be created. This is one of the following:
\r<dl>
\r<p>
\r<dt> <strong>MACH_PORT_RIGHT_RECEIVE</strong>
\r<dd>
\r<strong>mach_port_allocate_full</strong> creates a port. The new port is not a member
\rof any port set. It doesn't have any extant send or send-once
\rrights. Its make-send count is zero, its sequence number is zero, its
\rqueue limit is MACH_PORT_QLIMIT_DEFAULT, and it has no queued
\rmessages. The <var>name</var> parameter
\rdenotes the receive right for the new port.
\rThe owning task does not hold send rights for the new port, only the receive
\rright. The <strong>mach_port_insert_right</strong>
\rand <strong>mach_port_extract_right</strong> interfaces can be used
\rto convert the receive right to a combined send/receive right.
\r<p>
\r<dt> <strong>MACH_PORT_RIGHT_PORT_SET</strong>
\r<dd>
\r<strong>mach_port_allocate_full</strong> creates a port set. The new port set
\rhas no members.
\r<p>
\r<dt> <strong>MACH_PORT_RIGHT_DEAD_NAME</strong>
\r<dd>
\r<strong>mach_port_allocate_full</strong> creates a dead name. The new dead
\rname has one user reference.
\r</dl>
\r<p>
\r<dt> <var>subsystem</var>
\r<dd>
\r[in scalar] The port right naming the subsystem the newly created port
\ris to be associated with.
\r<p>
\r<p>
\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 may be used
\rto mandate the name of the returned port right and/or the port's "quality
\rof service" attribute. The current implementation recognizes two such
\rattributes: regular and realtime.
\r<dt> <var>name</var>
\r<dd>
\r[out scalar] The task's name for the port right. This can be any name
\rthat wasn't in use.
\r</dl>
\r<h3>DESCRIPTION</h3>
\r<p>
\rThe <strong>mach_port_allocate_full</strong> function creates a new right in the
\rspecified task. The new right's name is returned via the <var>name</var> parameter.
\rThe new port supports the full set of Mach port semantics (i.e. no_more_senders
\rdetection will work, if requested).
\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<p>
\r<dt> <strong>KERN_NO_SPACE</strong>
\r<dd>
\rThere was no room in task's IPC name space for another right.
\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.html"><strong>mach_port_allocate_qos</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>.
\r\ No newline at end of file
+<h2>mach_port_allocate_full</h2>
+<hr>
+<p>
+<strong>Function</strong> - Create a port right with full Mach port semantics.
+<h3>SYNOPSIS</h3>
+<pre>
+<strong>kern_return_t mach_port_allocate_full</strong>
+ <strong>(ipc_space_t</strong> <var>task</var>,
+ <strong>mach_port_right_t</strong> <var>right</var>,
+ <strong>subsystem_t</strong> <var>subsystem</var>,
+ <strong>mach_port_qos_t</strong> <var>qos</var>,
+ <strong>task</strong> <var>name</var><strong>);</strong>
+</pre>
+<h3>PARAMETERS</h3>
+<dl>
+<p>
+<dt> <var>task</var>
+<dd>
+[in task send right] The task acquiring the port right.
+<p>
+<dt> <var>right</var>
+<dd>
+[in scalar] The kind of entity to be created. This is one of the following:
+<dl>
+<p>
+<dt> <strong>MACH_PORT_RIGHT_RECEIVE</strong>
+<dd>
+<strong>mach_port_allocate_full</strong> creates a port. The new port is not a member
+of any port set. It doesn't have any extant send or send-once
+rights. Its make-send count is zero, its sequence number is zero, its
+queue limit is MACH_PORT_QLIMIT_DEFAULT, and it has no queued
+messages. The <var>name</var> parameter
+denotes the receive right for the new port.
+The owning task does not hold send rights for the new port, only the receive
+right. The <strong>mach_port_insert_right</strong>
+and <strong>mach_port_extract_right</strong> interfaces can be used
+to convert the receive right to a combined send/receive right.
+<p>
+<dt> <strong>MACH_PORT_RIGHT_PORT_SET</strong>
+<dd>
+<strong>mach_port_allocate_full</strong> creates a port set. The new port set
+has no members.
+<p>
+<dt> <strong>MACH_PORT_RIGHT_DEAD_NAME</strong>
+<dd>
+<strong>mach_port_allocate_full</strong> creates a dead name. The new dead
+name has one user reference.
+</dl>
+<p>
+<dt> <var>subsystem</var>
+<dd>
+[in scalar] The port right naming the subsystem the newly created port
+is to be associated with.
+<p>
+<p>
+<dt> <var>qos</var>
+<dd>
+[pointer to an in/out structure] Structure used to specify
+the desired "quality of service." This structure may be used
+to mandate the name of the returned port right and/or the port's "quality
+of service" attribute. The current implementation recognizes two such
+attributes: regular and realtime.
+<dt> <var>name</var>
+<dd>
+[out scalar] The task's name for the port right. This can be any name
+that wasn't in use.
+</dl>
+<h3>DESCRIPTION</h3>
+<p>
+The <strong>mach_port_allocate_full</strong> function creates a new right in the
+specified task. The new right's name is returned via the <var>name</var> parameter.
+The new port supports the full set of Mach port semantics (i.e. no_more_senders
+detection will work, if requested).
+<h3>NOTES</h3>
+<p>
+This interface is machine word length specific because of the port
+name parameter.
+<h3>RETURN VALUES</h3>
+<dl>
+<p>
+<dt> <strong>KERN_NO_SPACE</strong>
+<dd>
+There was no room in task's IPC name space for another right.
+</dl>
+<h3>RELATED INFORMATION</h3>
+<p>
+Functions:
+<a href="mach_port_allocate.html"><strong>mach_port_allocate</strong></a>,
+<a href="mach_port_allocate.html"><strong>mach_port_allocate_qos</strong></a>,
+<a href="mach_port_allocate_name.html"><strong>mach_port_allocate_name</strong></a>,
+<a href="mach_port_deallocate.html"><strong>mach_port_deallocate</strong></a>,
+<a href="mach_port_insert_right.html"><strong>mach_port_insert_right</strong></a>,
+<a href="mach_port_extract_right.html"><strong>mach_port_extract_right</strong></a>.
+<p>
+Structures:
+<a href="mach_port_qos.html"><strong>mach_port_qos</strong></a>.
projects / apple / xnu.git / blobdiff