D-Bus: dbus-mempool.h Source File

D-Bus 1.12.6

dbus-mempool.h
1 /* -*- mode: C; c-file-style: "gnu"; indent-tabs-mode: nil; -*- */
2 /* dbus-mempool.h Memory pools
3 *
4 * Copyright (C) 2002 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
24 #ifndef DBUS_MEMPOOL_H
25 #define DBUS_MEMPOOL_H
26
27 #include <dbus/dbus-internals.h>
28 #include <dbus/dbus-memory.h>
29 #include <dbus/dbus-types.h>
30
31 DBUS_BEGIN_DECLS
32
33 typedef struct DBusMemPool DBusMemPool;
34
35 DBUS_PRIVATE_EXPORT
36 DBusMemPool* _dbus_mem_pool_new (int element_size,
37 dbus_bool_t zero_elements);
38 DBUS_PRIVATE_EXPORT
39 void _dbus_mem_pool_free (DBusMemPool *pool);
40 DBUS_PRIVATE_EXPORT
41 void* _dbus_mem_pool_alloc (DBusMemPool *pool);
42 DBUS_PRIVATE_EXPORT
43 dbus_bool_t _dbus_mem_pool_dealloc (DBusMemPool *pool,
44 void *element);
45
46 /* if DBUS_ENABLE_STATS */
47 void _dbus_mem_pool_get_stats (DBusMemPool *pool,
48 dbus_uint32_t *in_use_p,
49 dbus_uint32_t *in_free_list_p,
50 dbus_uint32_t *allocated_p);
51
52 DBUS_END_DECLS
53
54 #endif /* DBUS_MEMPOOL_H */
dbus_uint32_t
unsigned int dbus_uint32_t
A 32-bit unsigned integer on all platforms.
Definition: dbus-arch-deps.h:43
_dbus_mem_pool_alloc
DBUS_PRIVATE_EXPORT void * _dbus_mem_pool_alloc(DBusMemPool *pool)
Allocates an object from the memory pool.
Definition: dbus-mempool.c:214
DBUS_BEGIN_DECLS
#define DBUS_BEGIN_DECLS
Macro used prior to declaring functions in the D-Bus header files.
_dbus_mem_pool_dealloc
DBUS_PRIVATE_EXPORT dbus_bool_t _dbus_mem_pool_dealloc(DBusMemPool *pool, void *element)
Deallocates an object previously created with _dbus_mem_pool_alloc().
Definition: dbus-mempool.c:347
dbus_bool_t
dbus_uint32_t dbus_bool_t
A boolean, valid values are TRUE and FALSE.
Definition: dbus-types.h:35
_dbus_mem_pool_free
DBUS_PRIVATE_EXPORT void _dbus_mem_pool_free(DBusMemPool *pool)
Frees a memory pool (and all elements allocated from it).
Definition: dbus-mempool.c:187
DBusMemPool
Internals fields of DBusMemPool.
Definition: dbus-mempool.c:98
DBusMemPool::zero_elements
unsigned int zero_elements
whether to zero-init allocated elements
Definition: dbus-mempool.c:102
DBusMemPool::element_size
int element_size
size of a single object in the pool
Definition: dbus-mempool.c:100
_dbus_mem_pool_new
DBUS_PRIVATE_EXPORT DBusMemPool * _dbus_mem_pool_new(int element_size, dbus_bool_t zero_elements)
Creates a new memory pool, or returns NULL on failure.
Definition: dbus-mempool.c:138
DBUS_END_DECLS
#define DBUS_END_DECLS
Macro used after declaring functions in the D-Bus header files.