xnu-792.6.76.tar.gz

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

diff --git a/osfmk/man/do_mach_notify_dead_name.html b/osfmk/man/do_mach_notify_dead_name.html
index ffc3c74f456d39f5ab077d2ec66b68b45f6dee0c..2f3ffe6c856af55b4f7bc78e0af6abef05f98ee6 100755 (executable)
--- a/osfmk/man/do_mach_notify_dead_name.html
+++ b/osfmk/man/do_mach_notify_dead_name.html
@@ -1 +1,65 @@
-<h2>do_mach_notify_dead_name</h2>\r<hr>\r<strong>Server Interface</strong> - Handle the current instance of a dead-name notification.\r<p>\r<h3>SYNOPSIS</h3>\r<pre>\r<strong>kern_return_t   do_mach_notify_dead_name</strong>\r                <strong>(notify_port_t</strong>                           <var>notify</var>,\r                 <strong>mach_port_name_t</strong>                          <var>name</var><strong>);</strong>\r\r\r<strong>kern_return_t   do_seqnos_mach_notify_dead_name</strong>\r                <strong>(notify_port_t</strong>                           <var>notify</var>,\r                 <strong>mach_port_seqno_t</strong>                        <var>seqno</var>,\r                 <strong>mach_port_name_t</strong>                          <var>name</var><strong>);</strong>\r</pre>\r<h3>PARAMETERS</h3>\r<dl>\r<p>\r<dt> <var>notify</var> \r<dd>\r[in notify (receive) right]\rThe port to which the notification was sent.\r<p>\r<dt> <var>seqno</var> \r<dd>\r[in scalar]\rThe sequence number of this message relative to the\rnotification port.\r<p>\r<dt> <var>name</var> \r<dd>\r[in scalar]\rThe dead name.\r</dl>\r<h3>DESCRIPTION</h3>\r<p>\rA <strong>do_mach_notify_dead_name</strong> function is called by <strong>notify_server</strong>\ras the\rresult of a kernel message indicating that the port name is now\rdead as the result \rof the associated receive right having died.  In contrast, a port-deleted\rnotification indicates that the port name is no longer usable\r(that is, it no longer names \ra valid right), typically as a result of the right so named being consumed or \rmoved. <var>notify</var> is the port named via <strong>mach_port_request_notification</strong>\ror \r<strong>mach_msg</strong>.\r<h3>NOTES</h3>\r<p>\rThis interface is machine word length specific because of the port name\rparameter.\r<h3>RETURN VALUES</h3>\r<p>\rOnly generic errors apply.\r<h3>RELATED INFORMATION</h3>\r<p>\rFunctions:\r<a href="notify_server.html"><strong>notify_server</strong></a>,\r<a href="seqnos_notify_server.html"><strong>seqnos_notify_server</strong></a>,\r<a href="mach_msg.html"><strong>mach_msg</strong></a>,\r<a href="MP_request_notification.html"><strong>mach_port_request_notification</strong></a>,\r<a href="do_mach_notify_no_senders.html"><strong>do_mach_notify_no_senders</strong></a>,\r<a href="DMN_port_deleted.html"><strong>do_mach_notify_port_deleted</strong></a>,\r<a href="do_mach_notify_send_once.html"><strong>do_mach_notify_send_once</strong></a>.\r
\ No newline at end of file
+<h2>do_mach_notify_dead_name</h2>
+<hr>
+<strong>Server Interface</strong> - Handle the current instance of a dead-name notification.
+<p>
+<h3>SYNOPSIS</h3>
+<pre>
+<strong>kern_return_t   do_mach_notify_dead_name</strong>
+                <strong>(notify_port_t</strong>                           <var>notify</var>,
+                 <strong>mach_port_name_t</strong>                          <var>name</var><strong>);</strong>
+
+
+<strong>kern_return_t   do_seqnos_mach_notify_dead_name</strong>
+                <strong>(notify_port_t</strong>                           <var>notify</var>,
+                 <strong>mach_port_seqno_t</strong>                        <var>seqno</var>,
+                 <strong>mach_port_name_t</strong>                          <var>name</var><strong>);</strong>
+</pre>
+<h3>PARAMETERS</h3>
+<dl>
+<p>
+<dt> <var>notify</var> 
+<dd>
+[in notify (receive) right]
+The port to which the notification was sent.
+<p>
+<dt> <var>seqno</var> 
+<dd>
+[in scalar]
+The sequence number of this message relative to the
+notification port.
+<p>
+<dt> <var>name</var> 
+<dd>
+[in scalar]
+The dead name.
+</dl>
+<h3>DESCRIPTION</h3>
+<p>
+A <strong>do_mach_notify_dead_name</strong> function is called by <strong>notify_server</strong>
+as the
+result of a kernel message indicating that the port name is now
+dead as the result 
+of the associated receive right having died.  In contrast, a port-deleted
+notification indicates that the port name is no longer usable
+(that is, it no longer names 
+a valid right), typically as a result of the right so named being consumed or 
+moved. <var>notify</var> is the port named via <strong>mach_port_request_notification</strong>
+or 
+<strong>mach_msg</strong>.
+<h3>NOTES</h3>
+<p>
+This interface is machine word length specific because of the port name
+parameter.
+<h3>RETURN VALUES</h3>
+<p>
+Only generic errors apply.
+<h3>RELATED INFORMATION</h3>
+<p>
+Functions:
+<a href="notify_server.html"><strong>notify_server</strong></a>,
+<a href="seqnos_notify_server.html"><strong>seqnos_notify_server</strong></a>,
+<a href="mach_msg.html"><strong>mach_msg</strong></a>,
+<a href="MP_request_notification.html"><strong>mach_port_request_notification</strong></a>,
+<a href="do_mach_notify_no_senders.html"><strong>do_mach_notify_no_senders</strong></a>,
+<a href="DMN_port_deleted.html"><strong>do_mach_notify_port_deleted</strong></a>,
+<a href="do_mach_notify_send_once.html"><strong>do_mach_notify_send_once</strong></a>.