D-Bus  1.13.16
dbus-dataslot.h
1 /* -*- mode: C; c-file-style: "gnu"; indent-tabs-mode: nil; -*- */
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., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
21  *
22  */
23 #ifndef DBUS_DATASLOT_H
24 #define DBUS_DATASLOT_H
25 
26 #include <dbus/dbus-internals.h>
27 
29 
31 typedef struct DBusDataSlotList DBusDataSlotList;
32 
34 typedef struct DBusDataSlot DBusDataSlot;
37 {
38  void *data;
40 };
41 
43 
47 {
48  dbus_int32_t slot_id;
49  int refcount;
50 };
51 
56 {
60  DBusGlobalLock lock;
61 };
62 
63 #define _DBUS_DATA_SLOT_ALLOCATOR_INIT(x) { NULL, 0, 0, x }
64 
70 {
72  int n_slots;
73 };
74 
76  DBusGlobalLock lock);
78  int *slot_id_p);
80  int *slot_id_p);
83  DBusDataSlotList *list,
84  int slot,
85  void *data,
86  DBusFreeFunction free_data_func,
87  DBusFreeFunction *old_free_func,
88  void **old_data);
90  DBusDataSlotList *list,
91  int slot);
94 
95 
97 
98 #endif /* DBUS_DATASLOT_H */
_dbus_data_slot_list_clear
void _dbus_data_slot_list_clear(DBusDataSlotList *list)
Frees all data slots contained in the list, calling application-provided free functions if they exist...
Definition: dbus-dataslot.c:318
DBusDataSlotAllocator::n_used_slots
int n_used_slots
number of slots used
Definition: dbus-dataslot.h:59
_dbus_data_slot_list_get
void * _dbus_data_slot_list_get(DBusDataSlotAllocator *allocator, DBusDataSlotList *list, int slot)
Retrieves data previously set with _dbus_data_slot_list_set_data().
Definition: dbus-dataslot.c:286
DBusDataSlot::free_data_func
DBusFreeFunction free_data_func
Free the application data.
Definition: dbus-dataslot.h:39
DBusFreeFunction
void(* DBusFreeFunction)(void *memory)
Definition: dbus-memory.h:63
DBusAllocatedSlot::slot_id
dbus_int32_t slot_id
ID of this slot.
Definition: dbus-dataslot.h:48
DBUS_END_DECLS
#define DBUS_END_DECLS
DBusDataSlotList::slots
DBusDataSlot * slots
Data slots.
Definition: dbus-dataslot.h:71
_dbus_data_slot_list_set
dbus_bool_t _dbus_data_slot_list_set(DBusDataSlotAllocator *allocator, DBusDataSlotList *list, int slot, void *data, DBusFreeFunction free_data_func, DBusFreeFunction *old_free_func, void **old_data)
Stores a pointer in the data slot list, along with an optional function to be used for freeing the da...
Definition: dbus-dataslot.c:222
DBUS_BEGIN_DECLS
#define DBUS_BEGIN_DECLS
DBusDataSlot
DBusDataSlot is used to store application data on the connection.
Definition: dbus-dataslot.h:36
_dbus_data_slot_list_init
void _dbus_data_slot_list_init(DBusDataSlotList *list)
Initializes a slot list.
Definition: dbus-dataslot.c:198
_dbus_data_slot_allocator_alloc
dbus_bool_t _dbus_data_slot_allocator_alloc(DBusDataSlotAllocator *allocator, dbus_int32_t *slot_id_p)
Allocates an integer ID to be used for storing data in a DBusDataSlotList.
Definition: dbus-dataslot.c:70
_dbus_data_slot_list_free
void _dbus_data_slot_list_free(DBusDataSlotList *list)
Frees the data slot list and all data slots contained in it, calling application-provided free functi...
Definition: dbus-dataslot.c:341
DBusDataSlotAllocator::n_allocated_slots
int n_allocated_slots
number of slots malloc'd
Definition: dbus-dataslot.h:58
DBusDataSlot::data
void * data
The application data.
Definition: dbus-dataslot.h:38
DBusDataSlotAllocator::allocated_slots
DBusAllocatedSlot * allocated_slots
Allocated slots.
Definition: dbus-dataslot.h:57
DBusDataSlotAllocator::lock
DBusGlobalLock lock
index of thread lock
Definition: dbus-dataslot.h:60
DBusAllocatedSlot::refcount
int refcount
Number of uses of the slot.
Definition: dbus-dataslot.h:49
_dbus_data_slot_allocator_init
dbus_bool_t _dbus_data_slot_allocator_init(DBusDataSlotAllocator *allocator, DBusGlobalLock lock)
Initializes a data slot allocator object, used to assign integer IDs for data slots.
Definition: dbus-dataslot.c:47
DBusDataSlotAllocator
An allocator that tracks a set of slot IDs.
Definition: dbus-dataslot.h:55
DBusDataSlotList::n_slots
int n_slots
Slots we have storage for in data_slots.
Definition: dbus-dataslot.h:72
_dbus_data_slot_allocator_free
void _dbus_data_slot_allocator_free(DBusDataSlotAllocator *allocator, dbus_int32_t *slot_id_p)
Deallocates an ID previously allocated with _dbus_data_slot_allocator_alloc().
Definition: dbus-dataslot.c:155
DBusAllocatedSlot
An allocated slot for storing data.
Definition: dbus-dataslot.h:46
DBusDataSlotList
Data structure that stores the actual user data set at a given slot.
Definition: dbus-dataslot.h:69
dbus_bool_t
dbus_uint32_t dbus_bool_t
Definition: dbus-types.h:35