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