osfmk/man/DMN_port_deleted.html

   1 <h2>do_mach_notify_port_deleted</h2>
   2 <hr>
   3 <p>
   4 <strong>Server Interface</strong> - Handle the current instance of a port-deleted notification.
   5 <h3>SYNOPSIS</h3>
   6 <pre>
   7 <strong>kern_return_t   do_mach_notify_port_deleted</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_port_deleted</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]
  23 The port to which the notification was sent.
  24 <p>
  25 <dt> <var>seqno</var>
  26 <dd>
  27 [in scalar]
  28 The sequence number of this message relative to the
  29 notification port.
  30 <p>
  31 <dt> <var>name</var>
  32 <dd>
  33 [in scalar]
  34 The invalid name.
  35 </dl>
  36 <h3>DESCRIPTION</h3>
  37 <p>
  38 A <strong>do_mach_notify_port_deleted</strong> function is called by
  39 <strong>notify_server</strong> as the
  40 result of a kernel message indicating that a port name is no
  41 longer usable (that is,
  42 it no longer names a valid right), typically as a result of the right so named
  43 being consumed or moved.  In contrast, a dead-name notification
  44 indicates that the
  45 port name is now dead as the result of the associated receive
  46 right having died.
  47 <var>notify</var> is the port named via <strong>mach_port_request_notification</strong>
  48 or <strong>mach_msg</strong>.
  49 <h3>NOTES</h3>
  50 <p>
  51 This interface is machine word length specific because of the port name
  52 parameter.
  53 <h3>RETURN VALUES</h3>
  54 <p>
  55 Only generic errors apply.
  56 <h3>RELATED INFORMATION</h3>
  57 <p>
  58 Functions:
  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_dead_name.html"><strong>do_mach_notify_dead_name</strong></a>,
  64 <a href="do_mach_notify_no_senders.html"><strong>do_mach_notify_no_senders</strong></a>,
  65 <a href="do_mach_notify_send_once.html"><strong>do_mach_notify_send_once</strong></a>.