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