xnu-2422.1.72.tar.gz

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

<h2>clock_alarm_reply</h2>
<hr>
<p>
<strong>Function</strong> - Ring a preset alarm.
<h3>SYNOPSIS</h3>
<pre>
<strong>kern_return_t   clock_alarm_reply</strong>
                <strong>(reply_port_t</strong>                  <var>alarm_reply_port</var>,
                 <strong>kern_return_t</strong>                       <var>reply_code</var>,
                 <strong>alarm_type_t</strong>                        <var>alarm_type</var>,
                 <strong>tvalspec_t</strong>                           <var>wake_time</var><strong>);</strong>
</pre>
<h3>PARAMETERS</h3>
<dl>
<p>
<dt> <var>alarm_reply_port</var> 
<dd>
[in alarm (receive) right]
The reply port named in the corresponding 
<strong>clock_alarm</strong> call.
<p>
<dt> <var>reply_code</var> 
<dd>
[in scalar]
The reply status code from the alarm.  The possible values 
are:
<dl>
<p>
<dt> <strong>KERN_SUCCESS</strong>
<dd>
The alarm was delivered without problem.
<p>
<dt> <strong>KERN_INVALID_VALUE</strong>
<dd>
The <var>alarm_type</var> and/or <var>alarm_time</var> values supplied to
<strong>clock_alarm</strong> were invalid.
<p>
<dt> <strong>KERN_INVALID_LEDGER</strong>
<dd>
The <var>ledger</var> supplied to <strong>clock_alarm</strong> was not a ledger.
<p>
<dt> <strong>KERN_ABORTED</strong>
<dd>
The alarm was terminated via use of <strong>clock_set_time</strong>.
</dl>
<p>
<dt> <var>alarm_type</var> 
<dd>
[in scalar]
The alarm type value supplied to the <strong>clock_alarm</strong> call. 
Only the low order bits of this value are used by the kernel so the high 
order bits are available for application use as an alarm identifier.
<p>
<dt> <var>wake_time</var> 
<dd>
[in structure]
The time when the alarm message was sent.
</dl>
<h3>DESCRIPTION</h3>
<p>
A <strong>clock_alarm_reply</strong> function is called as the result
of a message from the
kernel indicating that a previously requested alarm time (<strong>clock_alarm</strong>)
has arrived.
<h3>RETURN VALUES</h3>
<p>
Only generic errors apply.
<h3>RELATED INFORMATION</h3>
<p>
Functions:
<a href="host_get_clock_service.html"><strong>host_get_clock_service</strong></a>,
<a href="clock_get_attributes.html"><strong>clock_get_attributes</strong></a>,
<a href="clock_get_time.html"><strong>clock_get_time</strong></a>,
<a href="clock_sleep.html"><strong>clock_sleep</strong></a>,
<a href="clock_alarm.html"><strong>clock_alarm</strong></a>,
<a href="clock_reply_server.html"><strong>clock_reply_server</strong></a>,
<a href="clock_set_time.html"><strong>clock_set_time</strong></a>.
<p>
Data Structures:
<a href="tvalspec.html"><strong>tvalspec</strong></a>.