Main Page | Data Structures | File List | Data Fields | Globals

queue.h File Reference

#include "event.h"
#include "object.h"

Include dependency graph for queue.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Defines

#define ALARMD_TYPE_QUEUE   (alarmd_queue_get_type())
 This file is part of alarmd.
#define ALARMD_QUEUE(object)   (G_TYPE_CHECK_INSTANCE_CAST((object), ALARMD_TYPE_QUEUE, AlarmdQueue))
#define ALARMD_QUEUE_CLASS(klass)   (G_TYPE_CHECK_CLASS_CAST((klass), ALARMD_TYPE_QUEUE, AlarmdQueueClass))
#define ALARMD_IS_QUEUE(object)   (G_TYPE_CHECK_INSTANCE_TYPE((object), ALARMD_TYPE_QUEUE))
#define ALARMD_IS_QUEUE_CLASS(klass)   (G_TYPE_CHECK_CLASS_TYPE((klass), ALARMD_TYPE_QUEUE))
#define ALARMD_QUEUE_GET_CLASS(object)   (G_TYPE_INSTANCE_GET_CLASS((object), ALARMD_TYPE_QUEUE, AlarmdQueueClass))

Typedefs

typedef _AlarmdQueue AlarmdQueue
typedef _AlarmdQueueClass AlarmdQueueClass

Functions

GType alarmd_queue_get_type (void)
 SECTION:queue : Object type to handle the event queue.
AlarmdQueuealarmd_queue_new (void)
 alarmd_queue_new:
gulong alarmd_queue_add_event (AlarmdQueue *queue, AlarmdEvent *event)
 alarmd_queue_add_event: : A AlarmdQueue the should be added into.
gboolean alarmd_queue_remove_event (AlarmdQueue *queue, gulong event_id)
 alarmd_queue_remove_event: : The #AlamrmdQueue from where the event should be removed from.
glong * alarmd_queue_query_events (AlarmdQueue *queue, gint64 start_time, gint64 end_time, gint32 flag_mask, gint32 flags, guint *n_events)
 alarmd_queue_query_events: : The AlarmdQueue that should be queried.
AlarmdEventalarmd_queue_get_event (AlarmdQueue *queue, gulong event_id)
 alarmd_queue_get_event: : The AlarmdQueue that contains the event.


Define Documentation

#define ALARMD_IS_QUEUE object   )     (G_TYPE_CHECK_INSTANCE_TYPE((object), ALARMD_TYPE_QUEUE))
 

Definition at line 31 of file queue.h.

#define ALARMD_IS_QUEUE_CLASS klass   )     (G_TYPE_CHECK_CLASS_TYPE((klass), ALARMD_TYPE_QUEUE))
 

Definition at line 32 of file queue.h.

#define ALARMD_QUEUE object   )     (G_TYPE_CHECK_INSTANCE_CAST((object), ALARMD_TYPE_QUEUE, AlarmdQueue))
 

Definition at line 29 of file queue.h.

Referenced by _alarmd_queue_set_property(), and _dbus_message_in().

#define ALARMD_QUEUE_CLASS klass   )     (G_TYPE_CHECK_CLASS_CAST((klass), ALARMD_TYPE_QUEUE, AlarmdQueueClass))
 

Definition at line 30 of file queue.h.

#define ALARMD_QUEUE_GET_CLASS object   )     (G_TYPE_INSTANCE_GET_CLASS((object), ALARMD_TYPE_QUEUE, AlarmdQueueClass))
 

Definition at line 33 of file queue.h.

Referenced by alarmd_queue_add_event(), alarmd_queue_get_event(), alarmd_queue_query_events(), and alarmd_queue_remove_event().

#define ALARMD_TYPE_QUEUE   (alarmd_queue_get_type())
 

This file is part of alarmd.

Contact Person: David Weinehall <david.weinehall@nokia.com>

Copyright (C) 2006 Nokia Corporation alarmd and libalarm are free software; you can redistribute them and/or modify them under the terms of the GNU Lesser General Public License version 2.1 as published by the Free Software Foundation.

alarmd and libalarm are distributed in the hope that they will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details.

You should have received a copy of the GNU Lesser General Public License along with this software; if not, write to the Free Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA

Definition at line 28 of file queue.h.

Referenced by _alarmd_queue_finalize(), alarmd_event_class_init(), and alarmd_queue_new().


Typedef Documentation

typedef struct _AlarmdQueue AlarmdQueue
 

Definition at line 35 of file queue.h.

typedef struct _AlarmdQueueClass AlarmdQueueClass
 

Definition at line 41 of file queue.h.


Function Documentation

gulong alarmd_queue_add_event AlarmdQueue queue,
AlarmdEvent event
 

alarmd_queue_add_event: : A AlarmdQueue the should be added into.

: A AlarmdEvent that should be added to the queue.

Adds the to the to be launched at apecified time. Returns: Unique identifier for the event.

Definition at line 128 of file queue.c.

References ALARMD_QUEUE_GET_CLASS, ENTER_FUNC, and LEAVE_FUNC.

Referenced by _dbus_message_in(), and init_queue().

AlarmdEvent* alarmd_queue_get_event AlarmdQueue queue,
gulong  event_id
 

alarmd_queue_get_event: : The AlarmdQueue that contains the event.

: The identifier for the AlarmdEvent.

Finds and returns the wanted event from the queue. The event is still on the queue. Returns: The AlarmdEvent with the wanted identifier or NULL if not found.

Definition at line 146 of file queue.c.

References ALARMD_QUEUE_GET_CLASS, ENTER_FUNC, and LEAVE_FUNC.

Referenced by _dbus_message_in(), and _real_write_data().

GType alarmd_queue_get_type void   ) 
 

SECTION:queue : Object type to handle the event queue.

: AlarmdEvent

The AlarmdQueue handles the AlarmdEvent objects. It has timer plugins that handle the events; one that can power up the device and one that cannot. If only one timer is available, it is used for all events.

Definition at line 91 of file queue.c.

References alarmd_queue_class_init(), alarmd_queue_init(), and ALARMD_TYPE_OBJECT.

AlarmdQueue* alarmd_queue_new void   ) 
 

alarmd_queue_new:

Creates new alarmd queue. Returns: Newly created AlarmdQueue

Definition at line 119 of file queue.c.

References ALARMD_TYPE_QUEUE, ENTER_FUNC, and LEAVE_FUNC.

Referenced by init_queue().

glong* alarmd_queue_query_events AlarmdQueue queue,
gint64  start_time,
gint64  end_time,
gint32  flag_mask,
gint32  flags,
guint *  n_events
 

alarmd_queue_query_events: : The AlarmdQueue that should be queried.

: Events that launch avter this time should be returned. : Events that launch before this time should be returned. : Bitfield that specifies whchi fields should be checked. : The values wanted for the flags specified in . : Pointer to an integer that should contain the number of events found.

Queries events that occurr between adn with flags chosen with that have values specified in . Returns: Array of identifiers for the found events.

Definition at line 155 of file queue.c.

References ALARMD_QUEUE_GET_CLASS, ENTER_FUNC, and LEAVE_FUNC.

Referenced by _dbus_message_in(), and _real_write_data().

gboolean alarmd_queue_remove_event AlarmdQueue queue,
gulong  event_id
 

alarmd_queue_remove_event: : The #AlamrmdQueue from where the event should be removed from.

: The identifier for the AlarmdEvent.

Removes the event specified by the identifier from the . Returns: TRUE if the event was found and removed, FALSE otherwise.

Definition at line 137 of file queue.c.

References ALARMD_QUEUE_GET_CLASS, ENTER_FUNC, and LEAVE_FUNC.

Referenced by _alarmd_event_set_property(), and _dbus_message_in().


Generated on Thu Dec 21 18:23:31 2006 for Alarmd by  doxygen 1.4.2