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

Object Hierarchy


  GObject
   +----AlarmdObject
         +----AlarmdEvent
               +----AlarmdEventRecurring

Properties


  "action"               AlarmdAction          : Read / Write
  "cookie"               glong                 : Read / Write
  "queue"                AlarmdQueue           : Read / Write
  "snooze"               guint                 : Read / Write
  "snooze-interval"      guint                 : Read / Write
  "time"                 gint64                : Read / Write

Signals


"acknowledge"
            void        user_function      (AlarmdEvent *event,
                                            gpointer     user_data)      : Run last / No recursion / Action / No hooks
"cancel"    void        user_function      (AlarmdEvent *event,
                                            gpointer     user_data)      : Run last / No recursion / Action / No hooks
"dequeue"   void        user_function      (AlarmdEvent *event,
                                            gpointer     user_data)      : Run first / No recursion / Action / No hooks
"fire"      void        user_function      (AlarmdEvent *event,
                                            gboolean     delayed,
                                            gpointer     user_data)      : Run last / No recursion / Action / No hooks
"queue"     void        user_function      (AlarmdEvent *event,
                                            gpointer     arg1,
                                            gpointer     user_data)      : Run last / No recursion / Action / No hooks
"snooze"    void        user_function      (AlarmdEvent *event,
                                            gpointer     user_data)      : Run last / No recursion / Action / No hooks

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

Property Details

The "action" property

  "action"               AlarmdAction          : Read / Write

Action done when event is due.

The "cookie" property

  "cookie"               glong                 : Read / Write

Unique ID for the event.

Allowed values: >= 0

Default value: 0

The "queue" property

  "queue"                AlarmdQueue           : Read / Write

The queue that has the event.

The "snooze" property

  "snooze"               guint                 : Read / Write

Amount of time the event has been snoozed.

Default value: 0

The "snooze-interval" property

  "snooze-interval"      guint                 : Read / Write

Amount of time the event is postponed when snoozed.

Default value: 0

The "time" property

  "time"                 gint64                : Read / Write

Time when event is due.

Allowed values: >= 0

Default value: 0

Signal Details

The "acknowledge" signal

void        user_function                  (AlarmdEvent *event,
                                            gpointer     user_data)      : Run last / No recursion / Action / No hooks

Whenever an event is acknowledged, this signal is emitted.

event : The AlarmdEvent that received the signal.
user_data : user data set when the signal handler was connected.

The "cancel" signal

void        user_function                  (AlarmdEvent *event,
                                            gpointer     user_data)      : Run last / No recursion / Action / No hooks

Whenever an AlarmdEvent should be removed from queue, a AlarmdEvent::cancel signal is emitted.

event : The AlarmdEvent that is being cancelled.
user_data : user data set when the signal handler was connected.

The "dequeue" signal

void        user_function                  (AlarmdEvent *event,
                                            gpointer     user_data)      : Run first / No recursion / Action / No hooks

Whenever an AlarmdEvent is taken off a timer, a AlarmdEvent::dequeue signal is emitted.

event : The AlarmdEvent that is taken off the timer.
user_data : user data set when the signal handler was connected.

The "fire" signal

void        user_function                  (AlarmdEvent *event,
                                            gboolean     delayed,
                                            gpointer     user_data)      : Run last / No recursion / Action / No hooks

Whenever an AlarmdEvent is due, a AlarmdEvent::fire signal is emitted.

event : The AlarmdEvent that should be fired.
delayed : TRUE if the event is fired delayed.
user_data : user data set when the signal handler was connected.

The "queue" signal

void        user_function                  (AlarmdEvent *event,
                                            gpointer     arg1,
                                            gpointer     user_data)      : Run last / No recursion / Action / No hooks

Whenever an AlarmdEvent is put on a timer, a AlarmdEvent::queue signal is emitted.

event : The AlarmdEvent that is put on a timer.
user_data : user data set when the signal handler was connected.

The "snooze" signal

void        user_function                  (AlarmdEvent *event,
                                            gpointer     user_data)      : Run last / No recursion / Action / No hooks

Whenever an AlarmdEvent is snoozed, a AlarmdEvent::snooze signal is emitted.

event : The AlarmdEvent that is being snoozed.
user_data : user data set when the signal handler was connected.

See Also

AlarmdEventRecurring, AlarmdQueue