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