xref: /xnu-10002.41.9/osfmk/man/clock_reply_server.html (revision 699cd48037512bf4380799317ca44ca453c82f57)
1*699cd480SApple OSS Distributions<h2>clock_reply_server</h2>
2*699cd480SApple OSS Distributions<hr>
3*699cd480SApple OSS Distributions<p>
4*699cd480SApple OSS Distributions<strong>Function</strong> - Handle kernel-generated alarm.
5*699cd480SApple OSS Distributions<h3>SYNOPSIS</h3>
6*699cd480SApple OSS Distributions<pre>
7*699cd480SApple OSS Distributions<strong>boolean_t	clock_reply_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 alarm message received from the kernel.
18*699cd480SApple OSS Distributions<p>
19*699cd480SApple OSS Distributions<dt> <var>out_msg</var>
20*699cd480SApple OSS Distributions<dd>
21*699cd480SApple OSS Distributions[out structure]
22*699cd480SApple OSS DistributionsNot used.
23*699cd480SApple OSS Distributions</dl>
24*699cd480SApple OSS Distributions<h3>DESCRIPTION</h3>
25*699cd480SApple OSS Distributions<p>
26*699cd480SApple OSS DistributionsThe <strong>clock_reply_server</strong> function is the MIG generated server handling
27*699cd480SApple OSS Distributionsfunction to handle messages from the kernel corresponding to
28*699cd480SApple OSS Distributionsclock alarms.  Such
29*699cd480SApple OSS Distributionsmessages are delivered to the alarm reply port named in a <strong>clock_alarm</strong>
30*699cd480SApple OSS Distributionscall. The <strong>clock_reply_server</strong> function performs all necessary
31*699cd480SApple OSS Distributionsargument handling for
32*699cd480SApple OSS Distributionsthis kernel message and calls the appropriate handling function.  These functions
33*699cd480SApple OSS Distributionsmust be supplied by the caller.
34*699cd480SApple OSS Distributions<h3>RETURN VALUES</h3>
35*699cd480SApple OSS Distributions<dl>
36*699cd480SApple OSS Distributions<p>
37*699cd480SApple OSS Distributions<dt> <strong>TRUE</strong>
38*699cd480SApple OSS Distributions<dd>
39*699cd480SApple OSS DistributionsThe message was handled and the appropriate function was called.
40*699cd480SApple OSS Distributions<p>
41*699cd480SApple OSS Distributions<dt> <strong>FALSE</strong>
42*699cd480SApple OSS Distributions<dd>
43*699cd480SApple OSS DistributionsThe message did not apply to the alarm mechanism and no other action
44*699cd480SApple OSS Distributionswas taken.
45*699cd480SApple OSS Distributions</dl>
46*699cd480SApple OSS Distributions<h3>RELATED INFORMATION</h3>
47*699cd480SApple OSS Distributions<p>
48*699cd480SApple OSS DistributionsFunctions:
49*699cd480SApple OSS Distributions<a href="clock_alarm_reply.html"><strong>clock_alarm_reply<strong></a>.
50