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