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

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