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