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