AlarmdEvent

AlarmdEvent — Base class for events.

Synopsis



            AlarmdEvent;
AlarmdEvent* alarmd_event_new               (void);
void        alarmd_event_fire               (AlarmdEvent *event,
                                             gboolean delayed);
void        alarmd_event_cancel             (AlarmdEvent *event);
void        alarmd_event_snooze             (AlarmdEvent *event);
void        alarmd_event_acknowledge        (AlarmdEvent *event);
void        alarmd_event_queue              (AlarmdEvent *event,
                                             TimerPlugin *plugin);
void        alarmd_event_dequeue            (AlarmdEvent *event);
time_t      alarmd_event_get_time           (AlarmdEvent *event);
gboolean    alarmd_event_need_power_up      (AlarmdEvent *event);
gint32      alarmd_event_get_flags          (AlarmdEvent *event);

Description

A simple event that waits in the queue for being put on a timer and finally getting fired. Launches the action in AlarmdEvent:action and after it has finished, removes self from the queue.

Details

AlarmdEvent

typedef struct {
	AlarmdObject parent_instance;
} AlarmdEvent;

alarmd_event_new ()

AlarmdEvent* alarmd_event_new               (void);

Creates new alarmd event.

Returns : Newly created AlarmdEvent

alarmd_event_fire ()

void        alarmd_event_fire               (AlarmdEvent *event,
                                             gboolean delayed);

Emits a AlarmdEvent::fire signal on the given event.

event : Event that should be fired.
delayed : TRUE if the event is fired delayed.

alarmd_event_cancel ()

void        alarmd_event_cancel             (AlarmdEvent *event);

Emits a AlarmdEvent::cancel signal on the given event.

event : Event that should be cancelled.

alarmd_event_snooze ()

void        alarmd_event_snooze             (AlarmdEvent *event);

Emits a AlarmdEvent::snooze signal on the given event.

event : Event that should be snoozed.

alarmd_event_acknowledge ()

void        alarmd_event_acknowledge        (AlarmdEvent *event);

Emits a AlarmdEvent::acknowledge signal on the given event.

event : Event that should be acknowledged.

alarmd_event_queue ()

void        alarmd_event_queue              (AlarmdEvent *event,
                                             TimerPlugin *plugin);

Emits a AlarmdEvent::queue signal on the given event.

event : Event that should be put on a timer.
plugin : The timer the event should be put on.

alarmd_event_dequeue ()

void        alarmd_event_dequeue            (AlarmdEvent *event);

Emits a AlarmdEvent::dequeue signal on the given event.

event : Event that should be taken off a timer.

alarmd_event_get_time ()

time_t      alarmd_event_get_time           (AlarmdEvent *event);

Gets the next time an event should be run.

event : AlarmdEvent to get the time from.
Returns : The time that the event should next be run.

alarmd_event_need_power_up ()

gboolean    alarmd_event_need_power_up      (AlarmdEvent *event);

Queries an event, if it needs the "power up" feature.

event : The AlarmdEvent that is being queried.
Returns : TRUE if the power up feature is needed.

alarmd_event_get_flags ()

gint32      alarmd_event_get_flags          (AlarmdEvent *event);

Queries an event for its flags.

event : The AlarmdEvent that is being queried.
Returns : The bitfield for the flags.

See Also

AlarmdEventRecurring, AlarmdQueue