xnu-792.6.76.tar.gz

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

diff --git a/osfmk/man/clock_reply_server.html b/osfmk/man/clock_reply_server.html
index 08599b141badaf0548b10bd2a1d715461233e2f2..2f7d36a33db3d10f0432ab303fa775f7f602fd44 100755 (executable)
--- a/osfmk/man/clock_reply_server.html
+++ b/osfmk/man/clock_reply_server.html
@@ -1 +1,49 @@
-<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
\ No newline at end of file
+<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>.