|
Server : Apache/2.2.17 (Unix) mod_ssl/2.2.17 OpenSSL/0.9.8e-fips-rhel5 DAV/2 PHP/5.2.17 System : Linux localhost 2.6.18-419.el5 #1 SMP Fri Feb 24 22:47:42 UTC 2017 x86_64 User : nobody ( 99) PHP Version : 5.2.17 Disable Function : NONE Directory : /usr/share/devhelp/books/dbus/api/ |
Upload File : |
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title>D-Bus: dbus-marshal-header.h Source File</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
<link href="tabs.css" rel="stylesheet" type="text/css">
</head><body>
<!-- Generated by Doxygen 1.4.7 -->
<div class="tabs">
<ul>
<li><a href="index.html"><span>Main Page</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 id="current"><a href="files.html"><span>Files</span></a></li>
<li><a href="pages.html"><span>Related Pages</span></a></li>
</ul></div>
<h1>dbus-marshal-header.h</h1><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-marshal-header.h Managing marshaling/demarshaling of message headers</span>
<a name="l00003"></a>00003 <span class="comment"> *</span>
<a name="l00004"></a>00004 <span class="comment"> * Copyright (C) 2005 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., 59 Temple Place, Suite 330, Boston, MA 02111-1307 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
<a name="l00024"></a>00024 <span class="preprocessor">#ifndef DBUS_MARSHAL_HEADER_H</span>
<a name="l00025"></a>00025 <span class="preprocessor"></span><span class="preprocessor">#define DBUS_MARSHAL_HEADER_H</span>
<a name="l00026"></a>00026 <span class="preprocessor"></span>
<a name="l00027"></a>00027 <span class="preprocessor">#include <config.h></span>
<a name="l00028"></a>00028 <span class="preprocessor">#include <dbus/dbus-marshal-basic.h></span>
<a name="l00029"></a>00029 <span class="preprocessor">#include <dbus/dbus-marshal-validate.h></span>
<a name="l00030"></a>00030
<a name="l00031"></a>00031 <span class="preprocessor">#ifndef PACKAGE</span>
<a name="l00032"></a>00032 <span class="preprocessor"></span><span class="preprocessor">#error "config.h not included here"</span>
<a name="l00033"></a>00033 <span class="preprocessor"></span><span class="preprocessor">#endif</span>
<a name="l00034"></a>00034 <span class="preprocessor"></span>
<a name="l00035"></a>00035 <span class="keyword">typedef</span> <span class="keyword">struct </span><a class="code" href="structDBusHeader.html">DBusHeader</a> DBusHeader;
<a name="l00036"></a>00036 <span class="keyword">typedef</span> <span class="keyword">struct </span><a class="code" href="structDBusHeaderField.html">DBusHeaderField</a> DBusHeaderField;
<a name="l00037"></a>00037
<a name="l00038"></a>00038 <span class="preprocessor">#define _DBUS_HEADER_FIELD_VALUE_UNKNOWN -1</span>
<a name="l00039"></a>00039 <span class="preprocessor"></span><span class="preprocessor">#define _DBUS_HEADER_FIELD_VALUE_NONEXISTENT -2</span>
<a name="l00040"></a>00040 <span class="preprocessor"></span>
<a name="l00044"></a><a class="code" href="structDBusHeaderField.html">00044</a> <span class="keyword">struct </span>DBusHeaderField
<a name="l00045"></a>00045 {
<a name="l00046"></a><a class="code" href="structDBusHeaderField.html#a9616d127de7488f6d9dc18c4d0c2133">00046</a> <span class="keywordtype">int</span> <a class="code" href="structDBusHeaderField.html#a9616d127de7488f6d9dc18c4d0c2133">value_pos</a>;
<a name="l00047"></a>00047 };
<a name="l00048"></a>00048
<a name="l00052"></a><a class="code" href="structDBusHeader.html">00052</a> <span class="keyword">struct </span>DBusHeader
<a name="l00053"></a>00053 {
<a name="l00054"></a><a class="code" href="structDBusHeader.html#67df8bff43c10e2d4f6ae36b56ee5814">00054</a> <a class="code" href="structDBusString.html">DBusString</a> <a class="code" href="structDBusHeader.html#67df8bff43c10e2d4f6ae36b56ee5814">data</a>;
<a name="l00059"></a><a class="code" href="structDBusHeader.html#c58a309593d0dc7e8d5a02f3b3442384">00059</a> DBusHeaderField <a class="code" href="structDBusHeader.html#c58a309593d0dc7e8d5a02f3b3442384">fields</a>[<a class="code" href="group__DBusProtocol.html#g94f09d2b35473c8ffa6d3190b5f97c5c">DBUS_HEADER_FIELD_LAST</a> + 1];
<a name="l00063"></a><a class="code" href="structDBusHeader.html#a22a8d00f061310e12716f656b4d9b8f">00063</a> <a class="code" href="group__DBusTypes.html#gf513803b030613a669cc7ef199f90a8b">dbus_uint32_t</a> <a class="code" href="structDBusHeader.html#a22a8d00f061310e12716f656b4d9b8f">padding</a> : 3;
<a name="l00064"></a><a class="code" href="structDBusHeader.html#bb64abdf3c7f3fbf77c511ccf1f07aa1">00064</a> <a class="code" href="group__DBusTypes.html#gf513803b030613a669cc7ef199f90a8b">dbus_uint32_t</a> <a class="code" href="structDBusHeader.html#bb64abdf3c7f3fbf77c511ccf1f07aa1">byte_order</a> : 8;
<a name="l00065"></a>00065 };
<a name="l00066"></a>00066
<a name="l00067"></a>00067 <a class="code" href="group__DBusTypes.html#g39c9cb0f3a2a8ad6f55cc4855d035349">dbus_bool_t</a> <a class="code" href="group__DBusMarshal.html#gf939f7ccf175ff3056f76b7673b20ccb">_dbus_header_init</a> (DBusHeader *header,
<a name="l00068"></a>00068 <span class="keywordtype">int</span> byte_order);
<a name="l00069"></a>00069 <span class="keywordtype">void</span> <a class="code" href="group__DBusMarshal.html#gb90a814a27aeeace7e02c4ed130539cf">_dbus_header_free</a> (DBusHeader *header);
<a name="l00070"></a>00070 <span class="keywordtype">void</span> <a class="code" href="group__DBusMarshal.html#gcb9244bf214bcb53d851d2ce640b3931">_dbus_header_reinit</a> (DBusHeader *header,
<a name="l00071"></a>00071 <span class="keywordtype">int</span> byte_order);
<a name="l00072"></a>00072 <a class="code" href="group__DBusTypes.html#g39c9cb0f3a2a8ad6f55cc4855d035349">dbus_bool_t</a> <a class="code" href="group__DBusMarshal.html#gcabc7d2698ec08845d1af23f3409a7a9">_dbus_header_create</a> (DBusHeader *header,
<a name="l00073"></a>00073 <span class="keywordtype">int</span> type,
<a name="l00074"></a>00074 <span class="keyword">const</span> <span class="keywordtype">char</span> *destination,
<a name="l00075"></a>00075 <span class="keyword">const</span> <span class="keywordtype">char</span> *path,
<a name="l00076"></a>00076 <span class="keyword">const</span> <span class="keywordtype">char</span> *interface,
<a name="l00077"></a>00077 <span class="keyword">const</span> <span class="keywordtype">char</span> *member,
<a name="l00078"></a>00078 <span class="keyword">const</span> <span class="keywordtype">char</span> *error_name);
<a name="l00079"></a>00079 <a class="code" href="group__DBusTypes.html#g39c9cb0f3a2a8ad6f55cc4855d035349">dbus_bool_t</a> <a class="code" href="group__DBusMarshal.html#g0d5aad82f8bf5a314dcf3f70930e254b">_dbus_header_copy</a> (<span class="keyword">const</span> DBusHeader *header,
<a name="l00080"></a>00080 DBusHeader *dest);
<a name="l00081"></a>00081 <span class="keywordtype">int</span> <a class="code" href="group__DBusMarshal.html#g4427247494fc5c988498c5a87d42092d">_dbus_header_get_message_type</a> (DBusHeader *header);
<a name="l00082"></a>00082 <span class="keywordtype">void</span> <a class="code" href="group__DBusMarshal.html#gd92e0b1992cf96a4da642a4a54a5d26d">_dbus_header_set_serial</a> (DBusHeader *header,
<a name="l00083"></a>00083 <a class="code" href="group__DBusTypes.html#gf513803b030613a669cc7ef199f90a8b">dbus_uint32_t</a> serial);
<a name="l00084"></a>00084 <a class="code" href="group__DBusTypes.html#gf513803b030613a669cc7ef199f90a8b">dbus_uint32_t</a> <a class="code" href="group__DBusMarshal.html#g7ec7222423db42935aae4a24499ee0fb">_dbus_header_get_serial</a> (DBusHeader *header);
<a name="l00085"></a>00085 <span class="keywordtype">void</span> <a class="code" href="group__DBusMarshal.html#g0cff04252f97f6a25552c368199897f5">_dbus_header_update_lengths</a> (DBusHeader *header,
<a name="l00086"></a>00086 <span class="keywordtype">int</span> body_len);
<a name="l00087"></a>00087 <a class="code" href="group__DBusTypes.html#g39c9cb0f3a2a8ad6f55cc4855d035349">dbus_bool_t</a> <a class="code" href="group__DBusMarshal.html#g4349de00b7754a337526e36fda133464">_dbus_header_set_field_basic</a> (DBusHeader *header,
<a name="l00088"></a>00088 <span class="keywordtype">int</span> field,
<a name="l00089"></a>00089 <span class="keywordtype">int</span> type,
<a name="l00090"></a>00090 <span class="keyword">const</span> <span class="keywordtype">void</span> *value);
<a name="l00091"></a>00091 <a class="code" href="group__DBusTypes.html#g39c9cb0f3a2a8ad6f55cc4855d035349">dbus_bool_t</a> <a class="code" href="group__DBusMarshal.html#g499973a18dcb17d854eaf14101a66736">_dbus_header_get_field_basic</a> (DBusHeader *header,
<a name="l00092"></a>00092 <span class="keywordtype">int</span> field,
<a name="l00093"></a>00093 <span class="keywordtype">int</span> type,
<a name="l00094"></a>00094 <span class="keywordtype">void</span> *value);
<a name="l00095"></a>00095 <a class="code" href="group__DBusTypes.html#g39c9cb0f3a2a8ad6f55cc4855d035349">dbus_bool_t</a> <a class="code" href="group__DBusMarshal.html#gf4661ba8e7067f349ba03c9f5776bbb0">_dbus_header_get_field_raw</a> (DBusHeader *header,
<a name="l00096"></a>00096 <span class="keywordtype">int</span> field,
<a name="l00097"></a>00097 <span class="keyword">const</span> <a class="code" href="structDBusString.html">DBusString</a> **str,
<a name="l00098"></a>00098 <span class="keywordtype">int</span> *pos);
<a name="l00099"></a>00099 <a class="code" href="group__DBusTypes.html#g39c9cb0f3a2a8ad6f55cc4855d035349">dbus_bool_t</a> <a class="code" href="group__DBusMarshal.html#g7814248f4d74d109d29dc00487cd9b0c">_dbus_header_delete_field</a> (DBusHeader *header,
<a name="l00100"></a>00100 <span class="keywordtype">int</span> field);
<a name="l00101"></a>00101 <span class="keywordtype">void</span> <a class="code" href="group__DBusMarshal.html#gd2073f8f2f2ba3b710aa929dced34cc3">_dbus_header_toggle_flag</a> (DBusHeader *header,
<a name="l00102"></a>00102 <a class="code" href="group__DBusTypes.html#gf513803b030613a669cc7ef199f90a8b">dbus_uint32_t</a> flag,
<a name="l00103"></a>00103 <a class="code" href="group__DBusTypes.html#g39c9cb0f3a2a8ad6f55cc4855d035349">dbus_bool_t</a> value);
<a name="l00104"></a>00104 <a class="code" href="group__DBusTypes.html#g39c9cb0f3a2a8ad6f55cc4855d035349">dbus_bool_t</a> <a class="code" href="group__DBusMarshal.html#g56619efed3088554b8760edd246b4157">_dbus_header_get_flag</a> (DBusHeader *header,
<a name="l00105"></a>00105 <a class="code" href="group__DBusTypes.html#gf513803b030613a669cc7ef199f90a8b">dbus_uint32_t</a> flag);
<a name="l00106"></a>00106 <a class="code" href="group__DBusTypes.html#g39c9cb0f3a2a8ad6f55cc4855d035349">dbus_bool_t</a> _dbus_header_ensure_signature (DBusHeader *header,
<a name="l00107"></a>00107 <a class="code" href="structDBusString.html">DBusString</a> **type_str,
<a name="l00108"></a>00108 <span class="keywordtype">int</span> *type_pos);
<a name="l00109"></a>00109 <a class="code" href="group__DBusTypes.html#g39c9cb0f3a2a8ad6f55cc4855d035349">dbus_bool_t</a> <a class="code" href="group__DBusMarshal.html#g674d74081baf6e7531e0d4a286724210">_dbus_header_have_message_untrusted</a> (<span class="keywordtype">int</span> max_message_length,
<a name="l00110"></a>00110 <a class="code" href="group__DBusMarshal.html#g0c4521d30d6650a33673a4d7f9cc007c">DBusValidity</a> *validity,
<a name="l00111"></a>00111 <span class="keywordtype">int</span> *byte_order,
<a name="l00112"></a>00112 <span class="keywordtype">int</span> *fields_array_len,
<a name="l00113"></a>00113 <span class="keywordtype">int</span> *header_len,
<a name="l00114"></a>00114 <span class="keywordtype">int</span> *body_len,
<a name="l00115"></a>00115 <span class="keyword">const</span> <a class="code" href="structDBusString.html">DBusString</a> *str,
<a name="l00116"></a>00116 <span class="keywordtype">int</span> start,
<a name="l00117"></a>00117 <span class="keywordtype">int</span> len);
<a name="l00118"></a>00118 <a class="code" href="group__DBusTypes.html#g39c9cb0f3a2a8ad6f55cc4855d035349">dbus_bool_t</a> <a class="code" href="group__DBusMarshal.html#g0c3a3f95d9a53b91a0cd0b260196685b">_dbus_header_load</a> (DBusHeader *header,
<a name="l00119"></a>00119 <a class="code" href="group__DBusMarshal.html#gf9dce059725fa793c44b219460cbbe6d">DBusValidationMode</a> mode,
<a name="l00120"></a>00120 <a class="code" href="group__DBusMarshal.html#g0c4521d30d6650a33673a4d7f9cc007c">DBusValidity</a> *validity,
<a name="l00121"></a>00121 <span class="keywordtype">int</span> byte_order,
<a name="l00122"></a>00122 <span class="keywordtype">int</span> fields_array_len,
<a name="l00123"></a>00123 <span class="keywordtype">int</span> header_len,
<a name="l00124"></a>00124 <span class="keywordtype">int</span> body_len,
<a name="l00125"></a>00125 <span class="keyword">const</span> <a class="code" href="structDBusString.html">DBusString</a> *str,
<a name="l00126"></a>00126 <span class="keywordtype">int</span> start,
<a name="l00127"></a>00127 <span class="keywordtype">int</span> len);
<a name="l00128"></a>00128 <span class="keywordtype">void</span> <a class="code" href="group__DBusMarshal.html#ge5277c7b7bfb7b85e421baceac0398c8">_dbus_header_byteswap</a> (DBusHeader *header,
<a name="l00129"></a>00129 <span class="keywordtype">int</span> new_order);
<a name="l00130"></a>00130
<a name="l00131"></a>00131
<a name="l00132"></a>00132
<a name="l00133"></a>00133 <span class="preprocessor">#endif </span><span class="comment">/* DBUS_MARSHAL_HEADER_H */</span>
</pre></div><hr size="1"><address style="align: right;"><small>Generated on Mon Dec 14 22:26:11 2009 for D-Bus by
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.4.7 </small></address>
</body>
</html>