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

<h2>seqnos_notify_server</h2>\r<hr>\r<p>\r<strong>Function</strong> - Handle the next kernel-generated IPC notification.\r<h3>SYNOPSIS</h3>\r<pre>\r<strong>boolean_t	seqnos_notify_server</strong>\r		<strong>(mach_msg_header_t</strong>	<var>request_msg</var>,\r		<strong>mach_msg_header_t</strong>	<var>reply_ms</var><strong>);</strong>\r</pre>\r<h3>PARAMETERS</h3>\r<dl>\r<p>\r<dt> <var>in_msg</var> \r<dd>\r[pointer to in structure]\rThe notification message received from the\rkernel.\r<p>\r<dt> <var>out_msg</var> \r<dd>\r[out structure]\rNot used.\r</dl>\r<h3>DESCRIPTION</h3>\r<p>\rThe <strong>seqnos_notify_server</strong> function is the MIG generated server handling\rfunction to handle messages from the kernel corresponding to IPC notifications. \rSuch messages are delivered to the notification port named in a \r<strong>mach_msg</strong> or <strong>mach_port_request_notification</strong> call.  \rThe <strong>seqnos_notify_server</strong> function\rperforms all necessary argument handling for this kernel message and calls the\rappropriate handling function.  These functions must be supplied by the caller.\r<h3>NOTES</h3>\r<p>\r<strong>seqnos_notify_server</strong> differs from <strong>notify_server</strong>\rin that it supplies message\rsequence numbers to the server interfaces.\r<h3>RETURN VALUES</h3>\r<dl>\r<p>\r<dt> <strong>TRUE</strong>\r<dd>\rThe message was handled and the appropriate function was called.\r<p>\r<dt> <strong>FALSE</strong>\r<dd>\rThe message did not apply to the notification mechanism and no other \raction was taken.\r</dl>\r<h3>RELATED INFORMATION</h3>\r<p>\rFunctions:\r<a href="notify_server.html"><strong>notify_server<strong></a>,\r<a href="do_mach_notify_dead_name.html"><strong>do_seqnos_mach_notify_dead_name<strong></a>,\r<a href="do_mach_notify_no_senders.html"><strong>do_seqnos_mach_notify_no_senders<strong></a>,\r<a href="DMN_port_deleted.html"><strong>do_seqnos_mach_notify_port_deleted<strong></a>,\r<a href="do_mach_notify_send_once.html"><strong>do_seqnos_mach_notify_send_once<strong></a>.\r