xnu-2422.1.72.tar.gz

[apple/xnu.git] / osfmk / man / clock_reply_server.html

<h2>clock_reply_server</h2>
<hr>
<p>
<strong>Function</strong> - Handle kernel-generated alarm.
<h3>SYNOPSIS</h3>
<pre>
<strong>boolean_t	clock_reply_server</strong>
		<strong>(mach_msg_header_t</strong>	<var>request_msg</var>,
		<strong>mach_msg_header_t</strong>	<var>reply_ms</var><strong>);</strong>
</pre>
<h3>PARAMETERS</h3>
<dl>
<p>
<dt> <var>in_msg</var> 
<dd>
[pointer to in structure]
The alarm message received from the kernel.
<p>
<dt> <var>out_msg</var> 
<dd>
[out structure]
Not used.
</dl>
<h3>DESCRIPTION</h3>
<p>
The <strong>clock_reply_server</strong> function is the MIG generated server handling
function to handle messages from the kernel corresponding to
clock alarms.  Such 
messages are delivered to the alarm reply port named in a <strong>clock_alarm</strong>
call. The <strong>clock_reply_server</strong> function performs all necessary
argument handling for 
this kernel message and calls the appropriate handling function.  These functions 
must be supplied by the caller.
<h3>RETURN VALUES</h3>
<dl>
<p>
<dt> <strong>TRUE</strong>
<dd>
The message was handled and the appropriate function was called.
<p>
<dt> <strong>FALSE</strong>
<dd>
The message did not apply to the alarm mechanism and no other action 
was taken.
</dl>
<h3>RELATED INFORMATION</h3>
<p>
Functions:
<a href="clock_alarm_reply.html"><strong>clock_alarm_reply<strong></a>.