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