| Current File : //usr/share/doc/dbus/api/dbus-dataslot_8h_source.html |
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<title>D-Bus: dbus-dataslot.h Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td style="padding-left: 0.5em;">
<div id="projectname">D-Bus
 <span id="projectnumber">1.8.20</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- Generated by Doxygen 1.7.6.1 -->
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="pages.html"><span>Related Pages</span></a></li>
<li><a href="modules.html"><span>Modules</span></a></li>
<li><a href="annotated.html"><span>Data Structures</span></a></li>
<li class="current"><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="files.html"><span>File List</span></a></li>
</ul>
</div>
</div>
<div class="header">
<div class="headertitle">
<div class="title">dbus-dataslot.h</div> </div>
</div><!--header-->
<div class="contents">
<div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">/* -*- mode: C; c-file-style: "gnu"; indent-tabs-mode: nil; -*- */</span>
<a name="l00002"></a>00002 <span class="comment">/* dbus-dataslot.h storing data on objects</span>
<a name="l00003"></a>00003 <span class="comment"> *</span>
<a name="l00004"></a>00004 <span class="comment"> * Copyright (C) 2003 Red Hat, Inc.</span>
<a name="l00005"></a>00005 <span class="comment"> *</span>
<a name="l00006"></a>00006 <span class="comment"> * Licensed under the Academic Free License version 2.1</span>
<a name="l00007"></a>00007 <span class="comment"> * </span>
<a name="l00008"></a>00008 <span class="comment"> * This program is free software; you can redistribute it and/or modify</span>
<a name="l00009"></a>00009 <span class="comment"> * it under the terms of the GNU General Public License as published by</span>
<a name="l00010"></a>00010 <span class="comment"> * the Free Software Foundation; either version 2 of the License, or</span>
<a name="l00011"></a>00011 <span class="comment"> * (at your option) any later version.</span>
<a name="l00012"></a>00012 <span class="comment"> *</span>
<a name="l00013"></a>00013 <span class="comment"> * This program is distributed in the hope that it will be useful,</span>
<a name="l00014"></a>00014 <span class="comment"> * but WITHOUT ANY WARRANTY; without even the implied warranty of</span>
<a name="l00015"></a>00015 <span class="comment"> * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the</span>
<a name="l00016"></a>00016 <span class="comment"> * GNU General Public License for more details.</span>
<a name="l00017"></a>00017 <span class="comment"> * </span>
<a name="l00018"></a>00018 <span class="comment"> * You should have received a copy of the GNU General Public License</span>
<a name="l00019"></a>00019 <span class="comment"> * along with this program; if not, write to the Free Software</span>
<a name="l00020"></a>00020 <span class="comment"> * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA</span>
<a name="l00021"></a>00021 <span class="comment"> *</span>
<a name="l00022"></a>00022 <span class="comment"> */</span>
<a name="l00023"></a>00023 <span class="preprocessor">#ifndef DBUS_DATASLOT_H</span>
<a name="l00024"></a>00024 <span class="preprocessor"></span><span class="preprocessor">#define DBUS_DATASLOT_H</span>
<a name="l00025"></a>00025 <span class="preprocessor"></span>
<a name="l00026"></a>00026 <span class="preprocessor">#include <dbus/dbus-internals.h></span>
<a name="l00027"></a>00027
<a name="l00028"></a>00028 <a class="code" href="group__DBusMacros.html#ga875146b01015e9ced22b25d76d549ab2" title="Macro used prior to declaring functions in the D-Bus header files.">DBUS_BEGIN_DECLS</a>
<a name="l00029"></a>00029
<a name="l00030"></a>00030 <span class="keyword">typedef</span> <span class="keyword">struct </span><a class="code" href="structDBusDataSlotAllocator.html" title="An allocator that tracks a set of slot IDs.">DBusDataSlotAllocator</a> <a class="code" href="structDBusDataSlotAllocator.html" title="An allocator that tracks a set of slot IDs.">DBusDataSlotAllocator</a>;
<a name="l00031"></a>00031 <span class="keyword">typedef</span> <span class="keyword">struct </span><a class="code" href="structDBusDataSlotList.html" title="Data structure that stores the actual user data set at a given slot.">DBusDataSlotList</a> <a class="code" href="structDBusDataSlotList.html" title="Data structure that stores the actual user data set at a given slot.">DBusDataSlotList</a>;
<a name="l00032"></a>00032
<a name="l00034"></a>00034 <span class="keyword">typedef</span> <span class="keyword">struct </span><a class="code" href="structDBusDataSlot.html" title="DBusDataSlot is used to store application data on the connection.">DBusDataSlot</a> <a class="code" href="structDBusDataSlot.html" title="DBusDataSlot is used to store application data on the connection.">DBusDataSlot</a>;
<a name="l00036"></a><a class="code" href="structDBusDataSlot.html">00036</a> <span class="keyword">struct </span><a class="code" href="structDBusDataSlot.html" title="DBusDataSlot is used to store application data on the connection.">DBusDataSlot</a>
<a name="l00037"></a>00037 {
<a name="l00038"></a><a class="code" href="structDBusDataSlot.html#a883c8c8946f13b6f5f3cf99f230159fd">00038</a> <span class="keywordtype">void</span> *<a class="code" href="structDBusDataSlot.html#a883c8c8946f13b6f5f3cf99f230159fd" title="The application data.">data</a>;
<a name="l00039"></a><a class="code" href="structDBusDataSlot.html#ab899f58869942556fb1b381ca3f3e2b2">00039</a> <a class="code" href="group__DBusMemory.html#ga061bcded226d76c7d7de35beaa165cb5" title="The type of a function which frees a block of memory.">DBusFreeFunction</a> <a class="code" href="structDBusDataSlot.html#ab899f58869942556fb1b381ca3f3e2b2" title="Free the application data.">free_data_func</a>;
<a name="l00040"></a>00040 };
<a name="l00041"></a>00041
<a name="l00042"></a>00042 <span class="keyword">typedef</span> <span class="keyword">struct </span><a class="code" href="structDBusAllocatedSlot.html" title="An allocated slot for storing data.">DBusAllocatedSlot</a> <a class="code" href="structDBusAllocatedSlot.html" title="An allocated slot for storing data.">DBusAllocatedSlot</a>;
<a name="l00043"></a>00043
<a name="l00046"></a><a class="code" href="structDBusAllocatedSlot.html">00046</a> <span class="keyword">struct </span><a class="code" href="structDBusAllocatedSlot.html" title="An allocated slot for storing data.">DBusAllocatedSlot</a>
<a name="l00047"></a>00047 {
<a name="l00048"></a><a class="code" href="structDBusAllocatedSlot.html#a849e5f8d951d159c45172ce825fb3a1e">00048</a> <a class="code" href="group__DBusTypes.html#gab18afa60e9b17b6e322735bda3d863d8" title="A 32-bit signed integer on all platforms.">dbus_int32_t</a> <a class="code" href="structDBusAllocatedSlot.html#a849e5f8d951d159c45172ce825fb3a1e" title="ID of this slot.">slot_id</a>;
<a name="l00049"></a><a class="code" href="structDBusAllocatedSlot.html#a554eaffc3334a90a86f618eaa713410c">00049</a> <span class="keywordtype">int</span> <a class="code" href="structDBusAllocatedSlot.html#a554eaffc3334a90a86f618eaa713410c" title="Number of uses of the slot.">refcount</a>;
<a name="l00050"></a>00050 };
<a name="l00051"></a>00051
<a name="l00055"></a><a class="code" href="structDBusDataSlotAllocator.html">00055</a> <span class="keyword">struct </span><a class="code" href="structDBusDataSlotAllocator.html" title="An allocator that tracks a set of slot IDs.">DBusDataSlotAllocator</a>
<a name="l00056"></a>00056 {
<a name="l00057"></a><a class="code" href="structDBusDataSlotAllocator.html#a290fc1a48efc181da4e54dae572306b5">00057</a> <a class="code" href="structDBusAllocatedSlot.html" title="An allocated slot for storing data.">DBusAllocatedSlot</a> *<a class="code" href="structDBusDataSlotAllocator.html#a290fc1a48efc181da4e54dae572306b5" title="Allocated slots.">allocated_slots</a>;
<a name="l00058"></a><a class="code" href="structDBusDataSlotAllocator.html#a57702eaf2d6558cc15f12205aca90dda">00058</a> <span class="keywordtype">int</span> <a class="code" href="structDBusDataSlotAllocator.html#a57702eaf2d6558cc15f12205aca90dda" title="number of slots malloc'd">n_allocated_slots</a>;
<a name="l00059"></a><a class="code" href="structDBusDataSlotAllocator.html#ad68b0989a821eb266983052f8a402a4a">00059</a> <span class="keywordtype">int</span> <a class="code" href="structDBusDataSlotAllocator.html#ad68b0989a821eb266983052f8a402a4a" title="number of slots used">n_used_slots</a>;
<a name="l00060"></a><a class="code" href="structDBusDataSlotAllocator.html#a5908a6f2e17e5feec5b77a2cfbc81dbd">00060</a> DBusGlobalLock <a class="code" href="structDBusDataSlotAllocator.html#a5908a6f2e17e5feec5b77a2cfbc81dbd" title="index of thread lock">lock</a>;
<a name="l00061"></a>00061 };
<a name="l00062"></a>00062
<a name="l00063"></a>00063 <span class="preprocessor">#define _DBUS_DATA_SLOT_ALLOCATOR_INIT(x) { NULL, 0, 0, x }</span>
<a name="l00064"></a>00064 <span class="preprocessor"></span>
<a name="l00069"></a><a class="code" href="structDBusDataSlotList.html">00069</a> <span class="keyword">struct </span><a class="code" href="structDBusDataSlotList.html" title="Data structure that stores the actual user data set at a given slot.">DBusDataSlotList</a>
<a name="l00070"></a>00070 {
<a name="l00071"></a><a class="code" href="structDBusDataSlotList.html#a4dd0fc6cc10b9c48dd53f34335abd08e">00071</a> <a class="code" href="structDBusDataSlot.html" title="DBusDataSlot is used to store application data on the connection.">DBusDataSlot</a> *<a class="code" href="structDBusDataSlotList.html#a4dd0fc6cc10b9c48dd53f34335abd08e" title="Data slots.">slots</a>;
<a name="l00072"></a><a class="code" href="structDBusDataSlotList.html#a2d6cb7670a940bc886c99cb892b44502">00072</a> <span class="keywordtype">int</span> <a class="code" href="structDBusDataSlotList.html#a2d6cb7670a940bc886c99cb892b44502" title="Slots we have storage for in data_slots.">n_slots</a>;
<a name="l00073"></a>00073 };
<a name="l00074"></a>00074
<a name="l00075"></a>00075 <a class="code" href="group__DBusTypes.html#ga39c9cb0f3a2a8ad6f55cc4855d035349" title="A boolean, valid values are TRUE and FALSE.">dbus_bool_t</a> <a class="code" href="group__DBusDataSlot.html#ga49236838eb414100f691a22ad5210cb5" title="Initializes a data slot allocator object, used to assign integer IDs for data slots.">_dbus_data_slot_allocator_init</a> (<a class="code" href="structDBusDataSlotAllocator.html" title="An allocator that tracks a set of slot IDs.">DBusDataSlotAllocator</a> *allocator,
<a name="l00076"></a>00076 DBusGlobalLock lock);
<a name="l00077"></a>00077 <a class="code" href="group__DBusTypes.html#ga39c9cb0f3a2a8ad6f55cc4855d035349" title="A boolean, valid values are TRUE and FALSE.">dbus_bool_t</a> <a class="code" href="group__DBusDataSlot.html#gaf61f2bd0148bace4f67a2d6d97b26ea9" title="Allocates an integer ID to be used for storing data in a DBusDataSlotList.">_dbus_data_slot_allocator_alloc</a> (<a class="code" href="structDBusDataSlotAllocator.html" title="An allocator that tracks a set of slot IDs.">DBusDataSlotAllocator</a> *allocator,
<a name="l00078"></a>00078 <span class="keywordtype">int</span> *slot_id_p);
<a name="l00079"></a>00079 <span class="keywordtype">void</span> <a class="code" href="group__DBusDataSlot.html#ga059c50a24cd9fc984e918e6159841633" title="Deallocates an ID previously allocated with _dbus_data_slot_allocator_alloc().">_dbus_data_slot_allocator_free</a> (<a class="code" href="structDBusDataSlotAllocator.html" title="An allocator that tracks a set of slot IDs.">DBusDataSlotAllocator</a> *allocator,
<a name="l00080"></a>00080 <span class="keywordtype">int</span> *slot_id_p);
<a name="l00081"></a>00081 <span class="keywordtype">void</span> <a class="code" href="group__DBusDataSlot.html#ga6de49b3a1210202215d40a5a19806992" title="Initializes a slot list.">_dbus_data_slot_list_init</a> (<a class="code" href="structDBusDataSlotList.html" title="Data structure that stores the actual user data set at a given slot.">DBusDataSlotList</a> *list);
<a name="l00082"></a>00082 <a class="code" href="group__DBusTypes.html#ga39c9cb0f3a2a8ad6f55cc4855d035349" title="A boolean, valid values are TRUE and FALSE.">dbus_bool_t</a> <a class="code" href="group__DBusDataSlot.html#gad2952f9f686d96e7114fc49ab7452e1a" title="Stores a pointer in the data slot list, along with an optional function to be used for freeing the da...">_dbus_data_slot_list_set</a> (<a class="code" href="structDBusDataSlotAllocator.html" title="An allocator that tracks a set of slot IDs.">DBusDataSlotAllocator</a> *allocator,
<a name="l00083"></a>00083 <a class="code" href="structDBusDataSlotList.html" title="Data structure that stores the actual user data set at a given slot.">DBusDataSlotList</a> *list,
<a name="l00084"></a>00084 <span class="keywordtype">int</span> slot,
<a name="l00085"></a>00085 <span class="keywordtype">void</span> *data,
<a name="l00086"></a>00086 <a class="code" href="group__DBusMemory.html#ga061bcded226d76c7d7de35beaa165cb5" title="The type of a function which frees a block of memory.">DBusFreeFunction</a> free_data_func,
<a name="l00087"></a>00087 <a class="code" href="group__DBusMemory.html#ga061bcded226d76c7d7de35beaa165cb5" title="The type of a function which frees a block of memory.">DBusFreeFunction</a> *old_free_func,
<a name="l00088"></a>00088 <span class="keywordtype">void</span> **old_data);
<a name="l00089"></a>00089 <span class="keywordtype">void</span>* <a class="code" href="group__DBusDataSlot.html#ga43f741229f0c38788442601e2750ec66" title="Retrieves data previously set with _dbus_data_slot_list_set_data().">_dbus_data_slot_list_get</a> (<a class="code" href="structDBusDataSlotAllocator.html" title="An allocator that tracks a set of slot IDs.">DBusDataSlotAllocator</a> *allocator,
<a name="l00090"></a>00090 <a class="code" href="structDBusDataSlotList.html" title="Data structure that stores the actual user data set at a given slot.">DBusDataSlotList</a> *list,
<a name="l00091"></a>00091 <span class="keywordtype">int</span> slot);
<a name="l00092"></a>00092 <span class="keywordtype">void</span> <a class="code" href="group__DBusDataSlot.html#ga3c96d2ca263ba397b4da2956a49ae282" title="Frees all data slots contained in the list, calling application-provided free functions if they exist...">_dbus_data_slot_list_clear</a> (<a class="code" href="structDBusDataSlotList.html" title="Data structure that stores the actual user data set at a given slot.">DBusDataSlotList</a> *list);
<a name="l00093"></a>00093 <span class="keywordtype">void</span> <a class="code" href="group__DBusDataSlot.html#gabc399733376c462c3010271a2d431e73" title="Frees the data slot list and all data slots contained in it, calling application-provided free functi...">_dbus_data_slot_list_free</a> (<a class="code" href="structDBusDataSlotList.html" title="Data structure that stores the actual user data set at a given slot.">DBusDataSlotList</a> *list);
<a name="l00094"></a>00094
<a name="l00095"></a>00095
<a name="l00096"></a>00096 <a class="code" href="group__DBusMacros.html#gae4a9263a43f8220f6e1c0fd07cf6e59a" title="Macro used after declaring functions in the D-Bus header files.">DBUS_END_DECLS</a>
<a name="l00097"></a>00097
<a name="l00098"></a>00098 <span class="preprocessor">#endif </span><span class="comment">/* DBUS_DATASLOT_H */</span>
</pre></div></div><!-- contents -->
<hr class="footer"/><address class="footer"><small>
Generated on Thu Mar 3 2016 17:50:30 for D-Bus by  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.7.6.1
</small></address>
</body>
</html>