]> git.saurik.com Git - apple/xnu.git/blame - osfmk/man/do_mach_notify_dead_name.html
xnu-4903.221.2.tar.gz
[apple/xnu.git] / osfmk / man / do_mach_notify_dead_name.html
CommitLineData
13fec989
A
1<h2>do_mach_notify_dead_name</h2>
2<hr>
3<strong>Server Interface</strong> - Handle the current instance of a dead-name notification.
4<p>
5<h3>SYNOPSIS</h3>
6<pre>
7<strong>kern_return_t do_mach_notify_dead_name</strong>
8 <strong>(notify_port_t</strong> <var>notify</var>,
9 <strong>mach_port_name_t</strong> <var>name</var><strong>);</strong>
10
11
12<strong>kern_return_t do_seqnos_mach_notify_dead_name</strong>
13 <strong>(notify_port_t</strong> <var>notify</var>,
14 <strong>mach_port_seqno_t</strong> <var>seqno</var>,
15 <strong>mach_port_name_t</strong> <var>name</var><strong>);</strong>
16</pre>
17<h3>PARAMETERS</h3>
18<dl>
19<p>
20<dt> <var>notify</var>
21<dd>
22[in notify (receive) right]
23The port to which the notification was sent.
24<p>
25<dt> <var>seqno</var>
26<dd>
27[in scalar]
28The sequence number of this message relative to the
29notification port.
30<p>
31<dt> <var>name</var>
32<dd>
33[in scalar]
34The dead name.
35</dl>
36<h3>DESCRIPTION</h3>
37<p>
38A <strong>do_mach_notify_dead_name</strong> function is called by <strong>notify_server</strong>
39as the
40result of a kernel message indicating that the port name is now
41dead as the result
42of the associated receive right having died. In contrast, a port-deleted
43notification indicates that the port name is no longer usable
44(that is, it no longer names
45a valid right), typically as a result of the right so named being consumed or
46moved. <var>notify</var> is the port named via <strong>mach_port_request_notification</strong>
47or
48<strong>mach_msg</strong>.
49<h3>NOTES</h3>
50<p>
51This interface is machine word length specific because of the port name
52parameter.
53<h3>RETURN VALUES</h3>
54<p>
55Only generic errors apply.
56<h3>RELATED INFORMATION</h3>
57<p>
58Functions:
59<a href="notify_server.html"><strong>notify_server</strong></a>,
60<a href="seqnos_notify_server.html"><strong>seqnos_notify_server</strong></a>,
61<a href="mach_msg.html"><strong>mach_msg</strong></a>,
62<a href="MP_request_notification.html"><strong>mach_port_request_notification</strong></a>,
63<a href="do_mach_notify_no_senders.html"><strong>do_mach_notify_no_senders</strong></a>,
64<a href="DMN_port_deleted.html"><strong>do_mach_notify_port_deleted</strong></a>,
65<a href="do_mach_notify_send_once.html"><strong>do_mach_notify_send_once</strong></a>.