<h2>clock_alarm_reply</h2>

<strong>Function</strong> - Ring a preset alarm.

<h3>SYNOPSIS</h3>

<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>

<h3>PARAMETERS</h3>

<dt> <var>alarm_reply_port</var>

[in alarm (receive) right]

The reply port named in the corresponding

<strong>clock_alarm</strong> call.

<dt> <var>reply_code</var>

[in scalar]

The reply status code from the alarm. The possible values

are:

<dt> <strong>KERN_SUCCESS</strong>

The alarm was delivered without problem.

<dt> <strong>KERN_INVALID_VALUE</strong>

The <var>alarm_type</var> and/or <var>alarm_time</var> values supplied to

<strong>clock_alarm</strong> were invalid.

<dt> <strong>KERN_INVALID_LEDGER</strong>

The <var>ledger</var> supplied to <strong>clock_alarm</strong> was not a ledger.

<dt> <strong>KERN_ABORTED</strong>

The alarm was terminated via use of <strong>clock_set_time</strong>.

<dt> <var>alarm_type</var>

[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.

<dt> <var>wake_time</var>

[in structure]

The time when the alarm message was sent.

<h3>DESCRIPTION</h3>

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>

Only generic errors apply.

<h3>RELATED INFORMATION</h3>

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>.

Data Structures:

<a href="tvalspec.html"><strong>tvalspec</strong></a>.