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