osfmk/man/notify_server.html

   1 <h2>notify_server</h2>
   2 <hr>
   3 <p>
   4 <strong>Function</strong> - Handle the next kernel-generated IPC notification.
   5 <h3>SYNOPSIS</h3>
   6 <pre>
   7 <strong>boolean_t       notify_server</strong>
   8                 <strong>(mach_msg_header_t</strong>     <var>request_msg</var>,
   9                 <strong>mach_msg_header_t</strong>      <var>reply_ms</var><strong>);</strong>
  10 </pre>
  11 <h3>PARAMETERS</h3>
  12 <dl>
  13 <p>
  14 <dt> <var>in_msg</var>
  15 <dd>
  16 [pointer to in structure]
  17 The notification message received from the
  18 kernel.
  19 <p>
  20 <dt> <var>out_msg</var>
  21 <dd>
  22 [out structure]
  23 Not used.
  24 </dl>
  25 <h3>DESCRIPTION</h3>
  26 <p>
  27 The <strong>notify_server</strong> function is the MIG generated server
  28 handling function to
  29 handle messages from the kernel corresponding to IPC notifications.  Such
  30 messages are delivered to the notification port named in a <strong>mach_msg</strong>
  31 or <strong>mach_port_request_notification</strong> call.  The <strong>notify_server</strong>
  32 function performs all necessary
  33 argument handling for this kernel message and calls the appropriate handling
  34 function.  These functions must be supplied by the caller.
  35 <h3>RETURN VALUES</h3>
  36 <dl>
  37 <p>
  38 <dt> <strong>TRUE</strong>
  39 <dd>
  40 The message was handled and the appropriate function was called.
  41 <p>
  42 <dt> <strong>FALSE</strong>
  43 <dd>
  44 The message did not apply to the notification mechanism and no other
  45 action was taken.
  46 </dl>
  47 <h3>RELATED INFORMATION</h3>
  48 <p>
  49 Functions:
  50 <a href="seqnos_notify_server.html"><strong>seqnos_notify_server<strong></a>,
  51 <a href="do_mach_notify_dead_name.html"><strong>do_mach_notify_dead_name<strong></a>,
  52 <a href="do_mach_notify_no_senders.html"><strong>do_mach_notify_no_senders<strong></a>,
  53 <a href="DMN_port_deleted.html"><strong>do_mach_notify_port_deleted<strong></a>,
  54 <a href="do_mach_notify_send_once.html"><strong>do_mach_notify_send_once<strong></a>.