osfmk/man/clock_reply_server.html

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