alarm_recur_t Struct Reference

Date and time based recurrence defination. More...

Data Fields
uint64_t	mask_min
uint32_t	mask_hour
uint32_t	mask_mday
uint32_t	mask_wday
uint32_t	mask_mon
uint32_t	special

---

Detailed Description

Date and time based recurrence defination.

Recurrence time can be specified by masks for:

• hours
• minutes

Recurrence date can be specified by masks for:

• month
• day of the month
• day of the week

Additionally the following special cases are supported:

• biweekly
• monthly
• yearly.

Note: the bit masks are struct tm compatible, that is

• mask_xxx |= 1u << tm->tm_xxx;

yields expected result.

Setting a bit in a mask allows the value to be used as a recurrence point.

See also:

• alarmrecurflags

• alarm_recur_create()
• alarm_recur_delete()

• alarm_recur_align()
• alarm_recur_next()

• alarm_recur_init_from_tm()

• alarm_recur_ctor()
• alarm_recur_dtor()
• alarm_recur_delete_cb()

---

Field Documentation

uint64_t alarm_recur_t::mask_min

Bitmask for allowed minute values.

Range: (1ull << 0) ... (1ull << 59).

See alarmrecurflags, ALARM_RECUR_MIN_xxx

Note that this is a 64 bit value.

uint32_t alarm_recur_t::mask_hour

Bitmask for allowed hour values.

Range: (1ul << 0) ... (1ul << 23)

See alarmrecurflags, ALARM_RECUR_HOUR_xxx

uint32_t alarm_recur_t::mask_mday

Bitmask for allowed day of month values.

Range: (1ul << 1) ... (1ul << 31)

See alarmrecurflags, ALARM_RECUR_MDAY_xxx

uint32_t alarm_recur_t::mask_wday

Bitmask for allowed day of week values.

Range: (1ul << 0) ... (1ul << 6) for Sunday ... Monday.

See alarmrecurflags, ALARM_RECUR_WDAY_xxx

uint32_t alarm_recur_t::mask_mon

Bitmask for allowed month values.

Range: (1ul << 0) ... (1ul << 11) for January ... December.

See alarmrecurflags, ALARM_RECUR_MON_xxx

uint32_t alarm_recur_t::special

Code for special cases.

See alarmrecurflags, ALARM_RECUR_SPECIAL_xxx

Note: The special rules are applied first to advance from the previous trigger time. Then the masks are used to adjust the result.

---

The documentation for this struct was generated from the following file:

• src/libalarm.h