dbus/dbus-dataslot.h

   1 /* -*- mode: C; c-file-style: "gnu" -*- */
   2 /* dbus-dataslot.h  storing data on objects
   3  *
   4  * Copyright (C) 2003 Red Hat, Inc.
   5  *
   6  * Licensed under the Academic Free License version 2.1
   7  *
   8  * This program is free software; you can redistribute it and/or modify
   9  * it under the terms of the GNU General Public License as published by
  10  * the Free Software Foundation; either version 2 of the License, or
  11  * (at your option) any later version.
  12  *
  13  * This program is distributed in the hope that it will be useful,
  14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  16  * GNU General Public License for more details.
  17  *
  18  * You should have received a copy of the GNU General Public License
  19  * along with this program; if not, write to the Free Software
  20  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  21  *
  22  */
  23 #ifndef DBUS_DATASLOT_H
  24 #define DBUS_DATASLOT_H
  25
  26 #include <dbus/dbus-internals.h>
  27
  28 DBUS_BEGIN_DECLS
  29
  30 typedef struct DBusDataSlotAllocator DBusDataSlotAllocator;
  31 typedef struct DBusDataSlotList DBusDataSlotList;
  32
  33 /** Opaque typedef for DBusDataSlot */
  34 typedef struct DBusDataSlot DBusDataSlot;
  35 /** DBusDataSlot is used to store application data on the connection */
  36 struct DBusDataSlot
  37 {
  38   void *data;                      /**< The application data */
  39   DBusFreeFunction free_data_func; /**< Free the application data */
  40 };
  41
  42 typedef struct DBusAllocatedSlot DBusAllocatedSlot;
  43
  44 /** An allocated slot for storing data
  45  */
  46 struct DBusAllocatedSlot
  47 {
  48   dbus_int32_t slot_id;  /**< ID of this slot */
  49   int          refcount; /**< Number of uses of the slot */
  50 };
  51
  52 /**
  53  * An allocator that tracks a set of slot IDs.
  54  */
  55 struct DBusDataSlotAllocator
  56 {
  57   DBusAllocatedSlot *allocated_slots; /**< Allocated slots */
  58   int  n_allocated_slots; /**< number of slots malloc'd */
  59   int  n_used_slots;      /**< number of slots used */
  60   DBusMutex *lock;        /**< thread lock */
  61 };
  62
  63 /**
  64  * Data structure that stores the actual user data set at a given
  65  * slot.
  66  */
  67 struct DBusDataSlotList
  68 {
  69   DBusDataSlot *slots;   /**< Data slots */
  70   int           n_slots; /**< Slots we have storage for in data_slots */
  71 };
  72
  73 dbus_bool_t _dbus_data_slot_allocator_init  (DBusDataSlotAllocator  *allocator);
  74 dbus_bool_t _dbus_data_slot_allocator_alloc (DBusDataSlotAllocator  *allocator,
  75                                              DBusMutex              *mutex,
  76                                              int                    *slot_id_p);
  77 void        _dbus_data_slot_allocator_free  (DBusDataSlotAllocator  *allocator,
  78                                              int                    *slot_id_p);
  79 void        _dbus_data_slot_list_init       (DBusDataSlotList       *list);
  80 dbus_bool_t _dbus_data_slot_list_set        (DBusDataSlotAllocator  *allocator,
  81                                              DBusDataSlotList       *list,
  82                                              int                     slot,
  83                                              void                   *data,
  84                                              DBusFreeFunction        free_data_func,
  85                                              DBusFreeFunction       *old_free_func,
  86                                              void                  **old_data);
  87 void*       _dbus_data_slot_list_get        (DBusDataSlotAllocator  *allocator,
  88                                              DBusDataSlotList       *list,
  89                                              int                     slot);
  90 void        _dbus_data_slot_list_clear      (DBusDataSlotList       *list);
  91 void        _dbus_data_slot_list_free       (DBusDataSlotList       *list);
  92
  93
  94 DBUS_END_DECLS
  95
  96 #endif /* DBUS_DATASLOT_H */