xnu-2422.1.72.tar.gz

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

<h2>notify_server</h2>
<hr>
<p>
<strong>Function</strong> - Handle the next kernel-generated IPC notification.
<h3>SYNOPSIS</h3>
<pre>
<strong>boolean_t	notify_server</strong>
		<strong>(mach_msg_header_t</strong>	<var>request_msg</var>,
		<strong>mach_msg_header_t</strong>	<var>reply_ms</var><strong>);</strong>
</pre>
<h3>PARAMETERS</h3>
<dl>
<p>
<dt> <var>in_msg</var> 
<dd>
[pointer to in structure]
The notification message received from the
kernel.
<p>
<dt> <var>out_msg</var> 
<dd>
[out structure]
Not used.
</dl>
<h3>DESCRIPTION</h3>
<p>
The <strong>notify_server</strong> function is the MIG generated server
handling function to 
handle messages from the kernel corresponding to IPC notifications.  Such
messages are delivered to the notification port named in a <strong>mach_msg</strong>
or <strong>mach_port_request_notification</strong> call.  The <strong>notify_server</strong>
function performs all necessary 
argument handling for this kernel message and calls the appropriate handling 
function.  These functions must be supplied by the caller.
<h3>RETURN VALUES</h3>
<dl>
<p>
<dt> <strong>TRUE</strong>
<dd>
The message was handled and the appropriate function was called.
<p>
<dt> <strong>FALSE</strong>
<dd>
The message did not apply to the notification mechanism and no other 
action was taken.
</dl>
<h3>RELATED INFORMATION</h3>
<p>
Functions:
<a href="seqnos_notify_server.html"><strong>seqnos_notify_server<strong></a>,
<a href="do_mach_notify_dead_name.html"><strong>do_mach_notify_dead_name<strong></a>,
<a href="do_mach_notify_no_senders.html"><strong>do_mach_notify_no_senders<strong></a>,
<a href="DMN_port_deleted.html"><strong>do_mach_notify_port_deleted<strong></a>,
<a href="do_mach_notify_send_once.html"><strong>do_mach_notify_send_once<strong></a>.