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