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