osfmk/man/seqnos_notify_server.html

   1 <h2>seqnos_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       seqnos_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>seqnos_notify_server</strong> function is the MIG generated server handling
  28 function to handle messages from the kernel corresponding to IPC notifications.
  29 Such messages are delivered to the notification port named in a
  30 <strong>mach_msg</strong> or <strong>mach_port_request_notification</strong> call.
  31 The <strong>seqnos_notify_server</strong> function
  32 performs all necessary argument handling for this kernel message and calls the
  33 appropriate handling function.  These functions must be supplied by the caller.
  34 <h3>NOTES</h3>
  35 <p>
  36 <strong>seqnos_notify_server</strong> differs from <strong>notify_server</strong>
  37 in that it supplies message
  38 sequence numbers to the server interfaces.
  39 <h3>RETURN VALUES</h3>
  40 <dl>
  41 <p>
  42 <dt> <strong>TRUE</strong>
  43 <dd>
  44 The message was handled and the appropriate function was called.
  45 <p>
  46 <dt> <strong>FALSE</strong>
  47 <dd>
  48 The message did not apply to the notification mechanism and no other
  49 action was taken.
  50 </dl>
  51 <h3>RELATED INFORMATION</h3>
  52 <p>
  53 Functions:
  54 <a href="notify_server.html"><strong>notify_server<strong></a>,
  55 <a href="do_mach_notify_dead_name.html"><strong>do_seqnos_mach_notify_dead_name<strong></a>,
  56 <a href="do_mach_notify_no_senders.html"><strong>do_seqnos_mach_notify_no_senders<strong></a>,
  57 <a href="DMN_port_deleted.html"><strong>do_seqnos_mach_notify_port_deleted<strong></a>,
  58 <a href="do_mach_notify_send_once.html"><strong>do_seqnos_mach_notify_send_once<strong></a>.