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