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