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