|
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 : /proc/21573/root/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: Address parsing</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><a href="files.html"><span>Files</span></a></li>
<li><a href="pages.html"><span>Related Pages</span></a></li>
</ul></div>
<h1>Address parsing<br>
<small>
[<a class="el" href="group__DBusInternals.html">D-Bus secret internal implementation details</a>]</small>
</h1>Implementation of parsing addresses of D-Bus servers.
<a href="#_details">More...</a><table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Data Structures</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">struct </td><td class="memItemRight" valign="bottom"><a class="el" href="structDBusAddressEntry.html">DBusAddressEntry</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Internals of <a class="el" href="structDBusAddressEntry.html">DBusAddressEntry</a>. <a href="structDBusAddressEntry.html#_details">More...</a><br></td></tr>
<tr><td colspan="2"><br><h2>Defines</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__DBusAddressInternals.html#g0e46a8bc37d92810fe3d535019d3bad1">_DBUS_ADDRESS_OPTIONALLY_ESCAPED_BYTE</a>(b)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight"><a class="el" href="group__DBusMacros.html#ga8cecfc5c5c054d2875c03e77b7be15d">TRUE</a> if the byte need not be escaped when found in a dbus address. <a href="#g0e46a8bc37d92810fe3d535019d3bad1"></a><br></td></tr>
<tr><td colspan="2"><br><h2>Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__DBusAddressInternals.html#g5b6409826263c7d62570c56889f7ddb2">_dbus_set_bad_address</a> (<a class="el" href="structDBusError.html">DBusError</a> *error, const char *address_problem_type, const char *address_problem_field, const char *address_problem_other)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Sets <a class="el" href="group__DBusProtocol.html#g3fa04eb600edda4afc2dd9fe2e0f8b02">DBUS_ERROR_BAD_ADDRESS</a>. <a href="#g5b6409826263c7d62570c56889f7ddb2"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="group__DBusTypes.html#g39c9cb0f3a2a8ad6f55cc4855d035349">dbus_bool_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__DBusAddressInternals.html#g1ecc2f460303cd70c34e7667e8b12b37">_dbus_address_append_escaped</a> (<a class="el" href="structDBusString.html">DBusString</a> *escaped, const <a class="el" href="structDBusString.html">DBusString</a> *unescaped)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Appends an escaped version of one string to another string, using the D-Bus address escaping mechanism. <a href="#g1ecc2f460303cd70c34e7667e8b12b37"></a><br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
Implementation of parsing addresses of D-Bus servers.
<p>
<hr><h2>Define Documentation</h2>
<a class="anchor" name="g0e46a8bc37d92810fe3d535019d3bad1"></a><!-- doxytag: member="dbus-address.c::_DBUS_ADDRESS_OPTIONALLY_ESCAPED_BYTE" ref="g0e46a8bc37d92810fe3d535019d3bad1" args="(b)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define _DBUS_ADDRESS_OPTIONALLY_ESCAPED_BYTE </td>
<td>(</td>
<td class="paramtype">b </td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
<b>Value:</b><div class="fragment"><pre class="fragment">(((b) >= <span class="charliteral">'a'</span> && (b) <= <span class="charliteral">'z'</span>) || \
((b) >= <span class="charliteral">'A'</span> && (b) <= <span class="charliteral">'Z'</span>) || \
((b) >= <span class="charliteral">'0'</span> && (b) <= <span class="charliteral">'9'</span>) || \
(b) == <span class="charliteral">'-'</span> || \
(b) == <span class="charliteral">'_'</span> || \
(b) == <span class="charliteral">'/'</span> || \
(b) == <span class="charliteral">'\\'</span> || \
(b) == <span class="charliteral">'*'</span> || \
(b) == <span class="charliteral">'.'</span>)
</pre></div><a class="el" href="group__DBusMacros.html#ga8cecfc5c5c054d2875c03e77b7be15d">TRUE</a> if the byte need not be escaped when found in a dbus address.
<p>
All other bytes are required to be escaped in a valid address.
<p>
Definition at line <a class="el" href="dbus-address_8c-source.html#l00084">84</a> of file <a class="el" href="dbus-address_8c-source.html">dbus-address.c</a>.
<p>
Referenced by <a class="el" href="dbus-address_8c-source.html#l00104">_dbus_address_append_escaped()</a>.
</div>
</div><p>
<hr><h2>Function Documentation</h2>
<a class="anchor" name="g1ecc2f460303cd70c34e7667e8b12b37"></a><!-- doxytag: member="dbus-address.c::_dbus_address_append_escaped" ref="g1ecc2f460303cd70c34e7667e8b12b37" args="(DBusString *escaped, const DBusString *unescaped)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__DBusTypes.html#g39c9cb0f3a2a8ad6f55cc4855d035349">dbus_bool_t</a> _dbus_address_append_escaped </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structDBusString.html">DBusString</a> * </td>
<td class="paramname"> <em>escaped</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="structDBusString.html">DBusString</a> * </td>
<td class="paramname"> <em>unescaped</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Appends an escaped version of one string to another string, using the D-Bus address escaping mechanism.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>escaped</em> </td><td>the string to append to </td></tr>
<tr><td valign="top"></td><td valign="top"><em>unescaped</em> </td><td>the string to escape </td></tr>
</table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd><a class="el" href="group__DBusMacros.html#ga93f0eb578d23995850d61f7d61c55c1">FALSE</a> if no memory </dd></dl>
<p>
Definition at line <a class="el" href="dbus-address_8c-source.html#l00104">104</a> of file <a class="el" href="dbus-address_8c-source.html">dbus-address.c</a>.
<p>
References <a class="el" href="dbus-address_8c-source.html#l00084">_DBUS_ADDRESS_OPTIONALLY_ESCAPED_BYTE</a>, <a class="el" href="dbus-string_8c-source.html#l01273">_dbus_string_append_byte()</a>, <a class="el" href="dbus-string_8c-source.html#l02408">_dbus_string_append_byte_as_hex()</a>, <a class="el" href="dbus-string_8c-source.html#l00854">_dbus_string_set_length()</a>, <a class="el" href="group__DBusMacros.html#ga93f0eb578d23995850d61f7d61c55c1">FALSE</a>, and <a class="el" href="group__DBusMacros.html#ga8cecfc5c5c054d2875c03e77b7be15d">TRUE</a>.
<p>
Referenced by <a class="el" href="dbus-server-unix_8c-source.html#l00167">_dbus_server_new_for_domain_socket()</a>, <a class="el" href="dbus-server-socket_8c-source.html#l00369">_dbus_server_new_for_tcp_socket()</a>, and <a class="el" href="dbus-address_8c-source.html#l00583">dbus_address_escape_value()</a>.
</div>
</div><p>
<a class="anchor" name="g5b6409826263c7d62570c56889f7ddb2"></a><!-- doxytag: member="dbus-address.c::_dbus_set_bad_address" ref="g5b6409826263c7d62570c56889f7ddb2" args="(DBusError *error, const char *address_problem_type, const char *address_problem_field, const char *address_problem_other)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void _dbus_set_bad_address </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structDBusError.html">DBusError</a> * </td>
<td class="paramname"> <em>error</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>address_problem_type</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>address_problem_field</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>address_problem_other</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Sets <a class="el" href="group__DBusProtocol.html#g3fa04eb600edda4afc2dd9fe2e0f8b02">DBUS_ERROR_BAD_ADDRESS</a>.
<p>
If address_problem_type and address_problem_field are not <a class="el" href="group__DBusMacros.html#g070d2ce7b6bb7e5c05602aa8c308d0c4">NULL</a>, sets an error message about how the field is no good. Otherwise, sets address_problem_other as the error message.<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>error</em> </td><td>the error to set </td></tr>
<tr><td valign="top"></td><td valign="top"><em>address_problem_type</em> </td><td>the address type of the bad address or <a class="el" href="group__DBusMacros.html#g070d2ce7b6bb7e5c05602aa8c308d0c4">NULL</a> </td></tr>
<tr><td valign="top"></td><td valign="top"><em>address_problem_field</em> </td><td>the missing field of the bad address or <a class="el" href="group__DBusMacros.html#g070d2ce7b6bb7e5c05602aa8c308d0c4">NULL</a> </td></tr>
<tr><td valign="top"></td><td valign="top"><em>address_problem_other</em> </td><td>any other error message or <a class="el" href="group__DBusMacros.html#g070d2ce7b6bb7e5c05602aa8c308d0c4">NULL</a> </td></tr>
</table>
</dl>
<p>
Definition at line <a class="el" href="dbus-address_8c-source.html#l00065">65</a> of file <a class="el" href="dbus-address_8c-source.html">dbus-address.c</a>.
<p>
References <a class="el" href="dbus-protocol_8h-source.html#l00342">DBUS_ERROR_BAD_ADDRESS</a>, <a class="el" href="dbus-errors_8c-source.html#l00326">dbus_set_error()</a>, and <a class="el" href="group__DBusMacros.html#g070d2ce7b6bb7e5c05602aa8c308d0c4">NULL</a>.
<p>
Referenced by <a class="el" href="dbus-server-unix_8c-source.html#l00052">_dbus_server_listen_platform_specific()</a>, <a class="el" href="dbus-transport_8c-source.html#l00350">_dbus_transport_open()</a>, <a class="el" href="dbus-transport-unix_8c-source.html#l00120">_dbus_transport_open_platform_specific()</a>, and <a class="el" href="dbus-transport-socket_8c-source.html#l01293">_dbus_transport_open_socket()</a>.
</div>
</div><p>
<hr size="1"><address style="align: right;"><small>Generated on Mon Dec 14 22:26:13 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>