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