Back to Darwin Xnu

Clock Alarm Reply

osfmk/man/clock_alarm_reply.html

latest1.7 KB
Original Source

clock_alarm_reply


Function - Ring a preset alarm.

SYNOPSIS

**kern\_return\_t clock\_alarm\_reply**** (reply\_port\_t **alarm\_reply\_port,** kern\_return\_t **reply\_code,** alarm\_type\_t **alarm\_type,** tvalspec\_t **wake\_time** );**

PARAMETERS

alarm_reply_port[in alarm (receive) right] The reply port named in the corresponding clock_alarm call.

reply_code[in scalar] The reply status code from the alarm. The possible values are:

KERN_SUCCESS The alarm was delivered without problem.

KERN_INVALID_VALUE The alarm_type and/or alarm_time values supplied to clock_alarm were invalid.

KERN_INVALID_LEDGER The ledger supplied to clock_alarm was not a ledger.

KERN_ABORTED The alarm was terminated via use of clock_set_time.

alarm_type[in scalar] The alarm type value supplied to the clock_alarm 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.

wake_time[in structure] The time when the alarm message was sent.

DESCRIPTION

A clock_alarm_reply function is called as the result of a message from the kernel indicating that a previously requested alarm time ( clock_alarm ) has arrived.

RETURN VALUES

Only generic errors apply.

Functions: host_get_clock_service, clock_get_attributes, clock_get_time, clock_sleep, clock_alarm, clock_reply_server, clock_set_time.

Data Structures: tvalspec.