| Current File : //usr/share/doc/dbus/api/dbus-message-internal_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-message-internal.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-message-internal.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-message-internal.h DBusMessage object internal interfaces</span>
<a name="l00003"></a>00003 <span class="comment"> *</span>
<a name="l00004"></a>00004 <span class="comment"> * Copyright (C) 2002 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_MESSAGE_INTERNAL_H</span>
<a name="l00024"></a>00024 <span class="preprocessor"></span><span class="preprocessor">#define DBUS_MESSAGE_INTERNAL_H</span>
<a name="l00025"></a>00025 <span class="preprocessor"></span>
<a name="l00026"></a>00026 <span class="preprocessor">#include <dbus/dbus-marshal-validate.h></span>
<a name="l00027"></a>00027 <span class="preprocessor">#include <dbus/dbus-message.h></span>
<a name="l00028"></a>00028 <span class="preprocessor">#include <dbus/dbus-resources.h></span>
<a name="l00029"></a>00029 <span class="preprocessor">#include <dbus/dbus-list.h></span>
<a name="l00030"></a>00030
<a name="l00031"></a>00031 <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="l00032"></a>00032
<a name="l00033"></a>00033 <span class="preprocessor">#ifdef DBUS_ENABLE_VERBOSE_MODE</span>
<a name="l00034"></a>00034 <span class="preprocessor"></span><span class="keywordtype">void</span> _dbus_message_trace_ref (<a class="code" href="structDBusMessage.html" title="Internals of DBusMessage.">DBusMessage</a> *message,
<a name="l00035"></a>00035 <span class="keywordtype">int</span> old_refcount,
<a name="l00036"></a>00036 <span class="keywordtype">int</span> new_refcount,
<a name="l00037"></a>00037 <span class="keyword">const</span> <span class="keywordtype">char</span> *why);
<a name="l00038"></a>00038 <span class="preprocessor">#else</span>
<a name="l00039"></a>00039 <span class="preprocessor"></span><span class="comment">/* this bypasses any "unused" warnings for the old and new refcount */</span>
<a name="l00040"></a>00040 <span class="preprocessor">#define _dbus_message_trace_ref(m, o, n, w) \</span>
<a name="l00041"></a>00041 <span class="preprocessor"> do \</span>
<a name="l00042"></a>00042 <span class="preprocessor"> {\</span>
<a name="l00043"></a>00043 <span class="preprocessor"> (void) (o); \</span>
<a name="l00044"></a>00044 <span class="preprocessor"> (void) (n); \</span>
<a name="l00045"></a>00045 <span class="preprocessor"> } while (0)</span>
<a name="l00046"></a>00046 <span class="preprocessor"></span><span class="preprocessor">#endif</span>
<a name="l00047"></a>00047 <span class="preprocessor"></span>
<a name="l00048"></a><a class="code" href="group__DBusMessageInternals.html#gab6a849ea8db3714da7a161b4f6a6f0fb">00048</a> <span class="keyword">typedef</span> <span class="keyword">struct </span><a class="code" href="structDBusMessageLoader.html" title="Implementation details of DBusMessageLoader.">DBusMessageLoader</a> <a class="code" href="structDBusMessageLoader.html" title="Implementation details of DBusMessageLoader.">DBusMessageLoader</a>;
<a name="l00049"></a>00049
<a name="l00050"></a>00050 <span class="keywordtype">void</span> <a class="code" href="group__DBusMessageInternals.html#ga617811b117ac5eb31151ffb7dabea7a8" title="Gets the data to be sent over the network for this message.">_dbus_message_get_network_data</a> (<a class="code" href="structDBusMessage.html" title="Internals of DBusMessage.">DBusMessage</a> *message,
<a name="l00051"></a>00051 <span class="keyword">const</span> <a class="code" href="structDBusString.html">DBusString</a> **header,
<a name="l00052"></a>00052 <span class="keyword">const</span> <a class="code" href="structDBusString.html">DBusString</a> **body);
<a name="l00053"></a>00053 <span class="keywordtype">void</span> <a class="code" href="group__DBusMessageInternals.html#ga577e9d5224c56b9cf2ca2691be2e838c" title="Gets the unix fds to be sent over the network for this message.">_dbus_message_get_unix_fds</a> (<a class="code" href="structDBusMessage.html" title="Internals of DBusMessage.">DBusMessage</a> *message,
<a name="l00054"></a>00054 <span class="keyword">const</span> <span class="keywordtype">int</span> **fds,
<a name="l00055"></a>00055 <span class="keywordtype">unsigned</span> *n_fds);
<a name="l00056"></a>00056
<a name="l00057"></a>00057 <span class="keywordtype">void</span> _dbus_message_lock (<a class="code" href="structDBusMessage.html" title="Internals of DBusMessage.">DBusMessage</a> *message);
<a name="l00058"></a>00058 <span class="keywordtype">void</span> _dbus_message_unlock (<a class="code" href="structDBusMessage.html" title="Internals of DBusMessage.">DBusMessage</a> *message);
<a name="l00059"></a>00059 <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__DBusMessageInternals.html#gad009d79879d654a009c83627726435d8" title="Adds a counter to be incremented immediately with the size/unix fds of this message, and decremented by the size/unix fds of this message when this message if finalized.">_dbus_message_add_counter</a> (<a class="code" href="structDBusMessage.html" title="Internals of DBusMessage.">DBusMessage</a> *message,
<a name="l00060"></a>00060 <a class="code" href="structDBusCounter.html" title="Internals of DBusCounter.">DBusCounter</a> *counter);
<a name="l00061"></a>00061 <span class="keywordtype">void</span> <a class="code" href="group__DBusMessageInternals.html#gafaed2adc00b2ec54b2827ecb778bbe7e" title="Adds a counter to be incremented immediately with the size/unix fds of this message, and decremented by the size/unix fds of this message when this message if finalized.">_dbus_message_add_counter_link</a> (<a class="code" href="structDBusMessage.html" title="Internals of DBusMessage.">DBusMessage</a> *message,
<a name="l00062"></a>00062 <a class="code" href="structDBusList.html" title="A node in a linked list.">DBusList</a> *link);
<a name="l00063"></a>00063 <span class="keywordtype">void</span> <a class="code" href="group__DBusMessageInternals.html#gac84be3fd98e49409c1245a87c7de6f7d" title="Removes a counter tracking the size/unix fds of this message, and decrements the counter by the size/...">_dbus_message_remove_counter</a> (<a class="code" href="structDBusMessage.html" title="Internals of DBusMessage.">DBusMessage</a> *message,
<a name="l00064"></a>00064 <a class="code" href="structDBusCounter.html" title="Internals of DBusCounter.">DBusCounter</a> *counter);
<a name="l00065"></a>00065
<a name="l00066"></a>00066 <a class="code" href="structDBusMessageLoader.html" title="Implementation details of DBusMessageLoader.">DBusMessageLoader</a>* <a class="code" href="group__DBusMessageInternals.html#ga66f1c10cf909ba09ed732bc125ff8671" title="Creates a new message loader.">_dbus_message_loader_new</a> (<span class="keywordtype">void</span>);
<a name="l00067"></a>00067 <a class="code" href="structDBusMessageLoader.html" title="Implementation details of DBusMessageLoader.">DBusMessageLoader</a>* <a class="code" href="group__DBusMessageInternals.html#gad39efb9ff20c7538f12e164a6920edc4" title="Increments the reference count of the loader.">_dbus_message_loader_ref</a> (<a class="code" href="structDBusMessageLoader.html" title="Implementation details of DBusMessageLoader.">DBusMessageLoader</a> *loader);
<a name="l00068"></a>00068 <span class="keywordtype">void</span> <a class="code" href="group__DBusMessageInternals.html#ga51299aab1f5e0b2408ab858d3377b20c" title="Decrements the reference count of the loader and finalizes the loader when the count reaches zero...">_dbus_message_loader_unref</a> (<a class="code" href="structDBusMessageLoader.html" title="Implementation details of DBusMessageLoader.">DBusMessageLoader</a> *loader);
<a name="l00069"></a>00069
<a name="l00070"></a>00070 <span class="keywordtype">void</span> <a class="code" href="group__DBusMessageInternals.html#gae77f064b8034189a955d5be982d2fbdb" title="Gets the buffer to use for reading data from the network.">_dbus_message_loader_get_buffer</a> (<a class="code" href="structDBusMessageLoader.html" title="Implementation details of DBusMessageLoader.">DBusMessageLoader</a> *loader,
<a name="l00071"></a>00071 <a class="code" href="structDBusString.html">DBusString</a> **buffer);
<a name="l00072"></a>00072 <span class="keywordtype">void</span> <a class="code" href="group__DBusMessageInternals.html#gaf5cb6398adb9fe39560fe6aef69ebb09" title="Returns a buffer obtained from _dbus_message_loader_get_buffer(), indicating to the loader how many b...">_dbus_message_loader_return_buffer</a> (<a class="code" href="structDBusMessageLoader.html" title="Implementation details of DBusMessageLoader.">DBusMessageLoader</a> *loader,
<a name="l00073"></a>00073 <a class="code" href="structDBusString.html">DBusString</a> *buffer);
<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__DBusMessageInternals.html#ga4ed7327f9dee98711ebd7c9e5b74dec0" title="Gets the buffer to use for reading unix fds from the network.">_dbus_message_loader_get_unix_fds</a> (<a class="code" href="structDBusMessageLoader.html" title="Implementation details of DBusMessageLoader.">DBusMessageLoader</a> *loader,
<a name="l00076"></a>00076 <span class="keywordtype">int</span> **fds,
<a name="l00077"></a>00077 <span class="keywordtype">unsigned</span> *max_n_fds);
<a name="l00078"></a>00078 <span class="keywordtype">void</span> <a class="code" href="group__DBusMessageInternals.html#ga2bf4dd7eda1a539454486e127b75d7c3" title="Returns a buffer obtained from _dbus_message_loader_get_unix_fds().">_dbus_message_loader_return_unix_fds</a> (<a class="code" href="structDBusMessageLoader.html" title="Implementation details of DBusMessageLoader.">DBusMessageLoader</a> *loader,
<a name="l00079"></a>00079 <span class="keywordtype">int</span> *fds,
<a name="l00080"></a>00080 <span class="keywordtype">unsigned</span> n_fds);
<a name="l00081"></a>00081
<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__DBusMessageInternals.html#gaf55885371a6d022ec94c79bd7138923f" title="Converts buffered data into messages, if we have enough data.">_dbus_message_loader_queue_messages</a> (<a class="code" href="structDBusMessageLoader.html" title="Implementation details of DBusMessageLoader.">DBusMessageLoader</a> *loader);
<a name="l00083"></a>00083 <a class="code" href="structDBusMessage.html" title="Internals of DBusMessage.">DBusMessage</a>* <a class="code" href="group__DBusMessageInternals.html#ga66674354acdd09ca6e11d600b34bdd5f" title="Peeks at first loaded message, returns NULL if no messages have been queued.">_dbus_message_loader_peek_message</a> (<a class="code" href="structDBusMessageLoader.html" title="Implementation details of DBusMessageLoader.">DBusMessageLoader</a> *loader);
<a name="l00084"></a>00084 <a class="code" href="structDBusMessage.html" title="Internals of DBusMessage.">DBusMessage</a>* <a class="code" href="group__DBusMessageInternals.html#ga9e5e75716d7263d9908d45a60b1b6bdc" title="Pops a loaded message (passing ownership of the message to the caller).">_dbus_message_loader_pop_message</a> (<a class="code" href="structDBusMessageLoader.html" title="Implementation details of DBusMessageLoader.">DBusMessageLoader</a> *loader);
<a name="l00085"></a>00085 <a class="code" href="structDBusList.html" title="A node in a linked list.">DBusList</a>* <a class="code" href="group__DBusMessageInternals.html#ga6ec3c1ad57340f717a47d79092122d04" title="Pops a loaded message inside a list link (passing ownership of the message and link to the caller)...">_dbus_message_loader_pop_message_link</a> (<a class="code" href="structDBusMessageLoader.html" title="Implementation details of DBusMessageLoader.">DBusMessageLoader</a> *loader);
<a name="l00086"></a>00086 <span class="keywordtype">void</span> <a class="code" href="group__DBusMessageInternals.html#ga71b290eb470a55217971fcd6851fc40c" title="Returns a popped message link, used to undo a pop.">_dbus_message_loader_putback_message_link</a> (<a class="code" href="structDBusMessageLoader.html" title="Implementation details of DBusMessageLoader.">DBusMessageLoader</a> *loader,
<a name="l00087"></a>00087 <a class="code" href="structDBusList.html" title="A node in a linked list.">DBusList</a> *link);
<a name="l00088"></a>00088
<a name="l00089"></a>00089 <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__DBusMessageInternals.html#ga38da52ac9344b00df530098bdd9a3842" title="Checks whether the loader is confused due to bad data.">_dbus_message_loader_get_is_corrupted</a> (<a class="code" href="structDBusMessageLoader.html" title="Implementation details of DBusMessageLoader.">DBusMessageLoader</a> *loader);
<a name="l00090"></a>00090 <a class="code" href="group__DBusMarshal.html#ga0c4521d30d6650a33673a4d7f9cc007c" title="This is primarily used in unit testing, so we can verify that each invalid message is invalid for the...">DBusValidity</a> <a class="code" href="group__DBusMessageInternals.html#gafb8c42ed5242274586607812ff6fba10" title="Checks what kind of bad data confused the loader.">_dbus_message_loader_get_corruption_reason</a> (<a class="code" href="structDBusMessageLoader.html" title="Implementation details of DBusMessageLoader.">DBusMessageLoader</a> *loader);
<a name="l00091"></a>00091
<a name="l00092"></a>00092 <span class="keywordtype">void</span> <a class="code" href="group__DBusMessageInternals.html#ga031623c6235f98801cab3e53f0a5f757" title="Sets the maximum size message we allow.">_dbus_message_loader_set_max_message_size</a> (<a class="code" href="structDBusMessageLoader.html" title="Implementation details of DBusMessageLoader.">DBusMessageLoader</a> *loader,
<a name="l00093"></a>00093 <span class="keywordtype">long</span> size);
<a name="l00094"></a>00094 <span class="keywordtype">long</span> <a class="code" href="group__DBusMessageInternals.html#gadd76a4b7191465f2dcb8e6b56b717961" title="Gets the maximum allowed message size in bytes.">_dbus_message_loader_get_max_message_size</a> (<a class="code" href="structDBusMessageLoader.html" title="Implementation details of DBusMessageLoader.">DBusMessageLoader</a> *loader);
<a name="l00095"></a>00095
<a name="l00096"></a>00096 <span class="keywordtype">void</span> <a class="code" href="group__DBusMessageInternals.html#gadd6c0fa721b4340df936363fbde912dc" title="Sets the maximum unix fds per message we allow.">_dbus_message_loader_set_max_message_unix_fds</a>(<a class="code" href="structDBusMessageLoader.html" title="Implementation details of DBusMessageLoader.">DBusMessageLoader</a> *loader,
<a name="l00097"></a>00097 <span class="keywordtype">long</span> n);
<a name="l00098"></a>00098 <span class="keywordtype">long</span> <a class="code" href="group__DBusMessageInternals.html#gaf65867d15c7d8adb91f430c483c180be" title="Gets the maximum allowed number of unix fds per message.">_dbus_message_loader_get_max_message_unix_fds</a>(<a class="code" href="structDBusMessageLoader.html" title="Implementation details of DBusMessageLoader.">DBusMessageLoader</a> *loader);
<a name="l00099"></a>00099 <span class="keywordtype">int</span> <a class="code" href="group__DBusMessageInternals.html#ga8e01aad6af940ec4051703f59330da37" title="Return how many file descriptors are pending in the loader.">_dbus_message_loader_get_pending_fds_count</a> (<a class="code" href="structDBusMessageLoader.html" title="Implementation details of DBusMessageLoader.">DBusMessageLoader</a> *loader);
<a name="l00100"></a>00100 <span class="keywordtype">void</span> <a class="code" href="group__DBusMessageInternals.html#ga658a91d8efc59934016fae6905bfc4bf" title="Register a function to be called whenever the number of pending file descriptors in the loader change...">_dbus_message_loader_set_pending_fds_function</a> (<a class="code" href="structDBusMessageLoader.html" title="Implementation details of DBusMessageLoader.">DBusMessageLoader</a> *loader,
<a name="l00101"></a>00101 <span class="keywordtype">void</span> (* callback) (<span class="keywordtype">void</span> *),
<a name="l00102"></a>00102 <span class="keywordtype">void</span> *<a class="code" href="structDBusMessageLoader.html#a33c22d4f64a32a72faefb1df94fcfed1" title="Buffered data.">data</a>);
<a name="l00103"></a>00103
<a name="l00104"></a>00104 <span class="keyword">typedef</span> <span class="keyword">struct </span>DBusInitialFDs DBusInitialFDs;
<a name="l00105"></a>00105 DBusInitialFDs *_dbus_check_fdleaks_enter (<span class="keywordtype">void</span>);
<a name="l00106"></a>00106 <span class="keywordtype">void</span> _dbus_check_fdleaks_leave (DBusInitialFDs *fds);
<a name="l00107"></a>00107
<a name="l00108"></a>00108 <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="l00109"></a>00109
<a name="l00110"></a>00110 <span class="preprocessor">#endif </span><span class="comment">/* DBUS_MESSAGE_INTERNAL_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>