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