| Current File : //usr/share/doc/dbus/api/group__DBusAddress.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: Address parsing</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><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
</div>
<div class="header">
<div class="summary">
<a href="#typedef-members">Typedefs</a> |
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">Address parsing</div> </div>
<div class="ingroups"><a class="el" href="group__DBus.html">D-Bus low-level public API</a></div></div><!--header-->
<div class="contents">
<p>Parsing addresses of D-Bus servers.
<a href="#details">More...</a></p>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="typedef-members"></a>
Typedefs</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga6875129b8255f5d177335d117e30effd"></a><!-- doxytag: member="DBusAddress::DBusAddressEntry" ref="ga6875129b8255f5d177335d117e30effd" args="" -->
typedef struct <a class="el" href="structDBusAddressEntry.html">DBusAddressEntry</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__DBusAddress.html#ga6875129b8255f5d177335d117e30effd">DBusAddressEntry</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Opaque type representing one of the semicolon-separated items in an address. <br/></td></tr>
<tr><td colspan="2"><h2><a name="func-members"></a>
Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__DBusAddress.html#ga37a7009b07cf991ff07f3e86d71bf352">dbus_address_entries_free</a> (<a class="el" href="structDBusAddressEntry.html">DBusAddressEntry</a> **entries)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Frees a <a class="el" href="group__DBusMacros.html#ga070d2ce7b6bb7e5c05602aa8c308d0c4" title="A null pointer, defined appropriately for C or C++.">NULL</a>-terminated array of address entries. <a href="#ga37a7009b07cf991ff07f3e86d71bf352"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__DBusAddress.html#ga7e6b2572d6e637826acada01377b5487">dbus_address_entry_get_method</a> (<a class="el" href="structDBusAddressEntry.html">DBusAddressEntry</a> *entry)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the method string of an address entry. <a href="#ga7e6b2572d6e637826acada01377b5487"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__DBusAddress.html#gae6f014689b49099e835b1f97d032034e">dbus_address_entry_get_value</a> (<a class="el" href="structDBusAddressEntry.html">DBusAddressEntry</a> *entry, const char *key)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns a value from a key of an entry. <a href="#gae6f014689b49099e835b1f97d032034e"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__DBusTypes.html#ga39c9cb0f3a2a8ad6f55cc4855d035349">dbus_bool_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__DBusAddress.html#ga3cbf5947262b79601598276c720e2098">dbus_parse_address</a> (const char *address, <a class="el" href="structDBusAddressEntry.html">DBusAddressEntry</a> ***entry, int *array_len, <a class="el" href="structDBusError.html">DBusError</a> *error)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Parses an address string of the form: <a href="#ga3cbf5947262b79601598276c720e2098"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">char * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__DBusAddress.html#ga818e79423595cd2a306ec1b4dc1ab7f5">dbus_address_escape_value</a> (const char *value)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Escapes the given string as a value in a key=value pair for a D-Bus address. <a href="#ga818e79423595cd2a306ec1b4dc1ab7f5"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">char * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__DBusAddress.html#ga80d4e20206f8f1e9bbd2607e9f4bbb44">dbus_address_unescape_value</a> (const char *value, <a class="el" href="structDBusError.html">DBusError</a> *error)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Unescapes the given string as a value in a key=value pair for a D-Bus address. <a href="#ga80d4e20206f8f1e9bbd2607e9f4bbb44"></a><br/></td></tr>
</table>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<p>Parsing addresses of D-Bus servers. </p>
<hr/><h2>Function Documentation</h2>
<a class="anchor" id="ga37a7009b07cf991ff07f3e86d71bf352"></a><!-- doxytag: member="dbus-address.c::dbus_address_entries_free" ref="ga37a7009b07cf991ff07f3e86d71bf352" args="(DBusAddressEntry **entries)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">DBUS_EXPORT void <a class="el" href="group__DBusAddress.html#ga37a7009b07cf991ff07f3e86d71bf352">dbus_address_entries_free</a> </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structDBusAddressEntry.html">DBusAddressEntry</a> ** </td>
<td class="paramname"><em>entries</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Frees a <a class="el" href="group__DBusMacros.html#ga070d2ce7b6bb7e5c05602aa8c308d0c4" title="A null pointer, defined appropriately for C or C++.">NULL</a>-terminated array of address entries. </p>
<dl class="params"><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">entries</td><td>the array. </td></tr>
</table>
</dd>
</dl>
<p>Definition at line <a class="el" href="dbus-address_8c_source.html#l00189">189</a> of file <a class="el" href="dbus-address_8c_source.html">dbus-address.c</a>.</p>
<p>References <a class="el" href="dbus-memory_8c_source.html#l00701">dbus_free()</a>, and <a class="el" href="group__DBusMacros.html#ga070d2ce7b6bb7e5c05602aa8c308d0c4">NULL</a>.</p>
<p>Referenced by <a class="el" href="dbus-server_8c_source.html#l00549">dbus_server_listen()</a>.</p>
</div>
</div>
<a class="anchor" id="ga7e6b2572d6e637826acada01377b5487"></a><!-- doxytag: member="dbus-address.c::dbus_address_entry_get_method" ref="ga7e6b2572d6e637826acada01377b5487" args="(DBusAddressEntry *entry)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">DBUS_EXPORT const char * <a class="el" href="group__DBusAddress.html#ga7e6b2572d6e637826acada01377b5487">dbus_address_entry_get_method</a> </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structDBusAddressEntry.html">DBusAddressEntry</a> * </td>
<td class="paramname"><em>entry</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns the method string of an address entry. </p>
<p>For example, given the address entry "tcp:host=example.com" it would return the string "tcp"</p>
<dl class="params"><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">entry</td><td>the entry. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>a string describing the method. This string must not be freed. </dd></dl>
<p>Definition at line <a class="el" href="dbus-address_8c_source.html#l00227">227</a> of file <a class="el" href="dbus-address_8c_source.html">dbus-address.c</a>.</p>
<p>References <a class="el" href="dbus-string_8c_source.html#l00451">_dbus_string_get_const_data()</a>, and <a class="el" href="dbus-address_8c_source.html#l00045">DBusAddressEntry::method</a>.</p>
<p>Referenced by <a class="el" href="dbus-server-unix_8c_source.html#l00054">_dbus_server_listen_platform_specific()</a>, <a class="el" href="dbus-server-socket_8c_source.html#l00526">_dbus_server_listen_socket()</a>, <a class="el" href="dbus-transport-unix_8c_source.html#l00225">_dbus_transport_open_platform_specific()</a>, <a class="el" href="dbus-transport-socket_8c_source.html#l01410">_dbus_transport_open_socket()</a>, and <a class="el" href="dbus-server_8c_source.html#l00549">dbus_server_listen()</a>.</p>
</div>
</div>
<a class="anchor" id="gae6f014689b49099e835b1f97d032034e"></a><!-- doxytag: member="dbus-address.c::dbus_address_entry_get_value" ref="gae6f014689b49099e835b1f97d032034e" args="(DBusAddressEntry *entry, const char *key)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">DBUS_EXPORT const char * <a class="el" href="group__DBusAddress.html#gae6f014689b49099e835b1f97d032034e">dbus_address_entry_get_value</a> </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structDBusAddressEntry.html">DBusAddressEntry</a> * </td>
<td class="paramname"><em>entry</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>key</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns a value from a key of an entry. </p>
<p>For example, given the address "tcp:host=example.com,port=8073" if you asked for the key "host" you would get the value "example.com"</p>
<p>The returned value is already unescaped.</p>
<dl class="params"><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">entry</td><td>the entry. </td></tr>
<tr><td class="paramname">key</td><td>the key. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>the key value. This string must not be freed. </dd></dl>
<p>Definition at line <a class="el" href="dbus-address_8c_source.html#l00244">244</a> of file <a class="el" href="dbus-address_8c_source.html">dbus-address.c</a>.</p>
<p>References <a class="el" href="dbus-list_8c_source.html#l00567">_dbus_list_get_first_link()</a>, <a class="el" href="dbus-list_8h_source.html#l00090">_dbus_list_get_next_link</a>, <a class="el" href="dbus-string_8c_source.html#l02134">_dbus_string_equal_c_str()</a>, <a class="el" href="dbus-string_8c_source.html#l00451">_dbus_string_get_const_data()</a>, <a class="el" href="dbus-list_8h_source.html#l00038">DBusList::data</a>, <a class="el" href="dbus-address_8c_source.html#l00047">DBusAddressEntry::keys</a>, <a class="el" href="group__DBusMacros.html#ga070d2ce7b6bb7e5c05602aa8c308d0c4">NULL</a>, and <a class="el" href="dbus-address_8c_source.html#l00048">DBusAddressEntry::values</a>.</p>
<p>Referenced by <a class="el" href="dbus-server-unix_8c_source.html#l00054">_dbus_server_listen_platform_specific()</a>, <a class="el" href="dbus-server-socket_8c_source.html#l00526">_dbus_server_listen_socket()</a>, <a class="el" href="dbus-transport_8c_source.html#l00367">_dbus_transport_open()</a>, <a class="el" href="dbus-transport-unix_8c_source.html#l00225">_dbus_transport_open_platform_specific()</a>, and <a class="el" href="dbus-transport-socket_8c_source.html#l01410">_dbus_transport_open_socket()</a>.</p>
</div>
</div>
<a class="anchor" id="ga818e79423595cd2a306ec1b4dc1ab7f5"></a><!-- doxytag: member="dbus-address.c::dbus_address_escape_value" ref="ga818e79423595cd2a306ec1b4dc1ab7f5" args="(const char *value)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">DBUS_EXPORT char * <a class="el" href="group__DBusAddress.html#ga818e79423595cd2a306ec1b4dc1ab7f5">dbus_address_escape_value</a> </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>value</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Escapes the given string as a value in a key=value pair for a D-Bus address. </p>
<dl class="params"><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">value</td><td>the unescaped value </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>newly-allocated escaped value or <a class="el" href="group__DBusMacros.html#ga070d2ce7b6bb7e5c05602aa8c308d0c4" title="A null pointer, defined appropriately for C or C++.">NULL</a> if no memory </dd></dl>
<p>Definition at line <a class="el" href="dbus-address_8c_source.html#l00583">583</a> of file <a class="el" href="dbus-address_8c_source.html">dbus-address.c</a>.</p>
<p>References <a class="el" href="dbus-address_8c_source.html#l00104">_dbus_address_append_escaped()</a>, <a class="el" href="dbus-string_8c_source.html#l00242">_dbus_string_free()</a>, <a class="el" href="dbus-string_8c_source.html#l00175">_dbus_string_init()</a>, <a class="el" href="dbus-string_8c_source.html#l00190">_dbus_string_init_const()</a>, <a class="el" href="dbus-string_8c_source.html#l00624">_dbus_string_steal_data()</a>, and <a class="el" href="group__DBusMacros.html#ga070d2ce7b6bb7e5c05602aa8c308d0c4">NULL</a>.</p>
</div>
</div>
<a class="anchor" id="ga80d4e20206f8f1e9bbd2607e9f4bbb44"></a><!-- doxytag: member="dbus-address.c::dbus_address_unescape_value" ref="ga80d4e20206f8f1e9bbd2607e9f4bbb44" args="(const char *value, DBusError *error)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">DBUS_EXPORT char * <a class="el" href="group__DBusAddress.html#ga80d4e20206f8f1e9bbd2607e9f4bbb44">dbus_address_unescape_value</a> </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>value</em>, </td>
</tr>
<tr>
<td class="paramkey"></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></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Unescapes the given string as a value in a key=value pair for a D-Bus address. </p>
<p>Note that <a class="el" href="group__DBusAddress.html#gae6f014689b49099e835b1f97d032034e" title="Returns a value from a key of an entry.">dbus_address_entry_get_value()</a> returns an already-unescaped value.</p>
<dl class="params"><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">value</td><td>the escaped value </td></tr>
<tr><td class="paramname">error</td><td>error to set if the unescaping fails </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>newly-allocated unescaped value or <a class="el" href="group__DBusMacros.html#ga070d2ce7b6bb7e5c05602aa8c308d0c4" title="A null pointer, defined appropriately for C or C++.">NULL</a> if no memory </dd></dl>
<p>Definition at line <a class="el" href="dbus-address_8c_source.html#l00617">617</a> of file <a class="el" href="dbus-address_8c_source.html">dbus-address.c</a>.</p>
<p>References <a class="el" href="dbus-string_8c_source.html#l00242">_dbus_string_free()</a>, <a class="el" href="dbus-string_8c_source.html#l00722">_dbus_string_get_length()</a>, <a class="el" href="dbus-string_8c_source.html#l00175">_dbus_string_init()</a>, <a class="el" href="dbus-string_8c_source.html#l00190">_dbus_string_init_const()</a>, <a class="el" href="dbus-string_8c_source.html#l00624">_dbus_string_steal_data()</a>, <a class="el" href="dbus-errors_8c_source.html#l00329">dbus_error_is_set()</a>, and <a class="el" href="group__DBusMacros.html#ga070d2ce7b6bb7e5c05602aa8c308d0c4">NULL</a>.</p>
</div>
</div>
<a class="anchor" id="ga3cbf5947262b79601598276c720e2098"></a><!-- doxytag: member="dbus-address.c::dbus_parse_address" ref="ga3cbf5947262b79601598276c720e2098" args="(const char *address, DBusAddressEntry ***entry, int *array_len, DBusError *error)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">DBUS_EXPORT <a class="el" href="group__DBusTypes.html#ga39c9cb0f3a2a8ad6f55cc4855d035349">dbus_bool_t</a> <a class="el" href="group__DBusAddress.html#ga3cbf5947262b79601598276c720e2098">dbus_parse_address</a> </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>address</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="structDBusAddressEntry.html">DBusAddressEntry</a> *** </td>
<td class="paramname"><em>entry</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int * </td>
<td class="paramname"><em>array_len</em>, </td>
</tr>
<tr>
<td class="paramkey"></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></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Parses an address string of the form: </p>
<p>method:key=value,key=value;method:key=value</p>
<p>See the D-Bus specification for complete docs on the format.</p>
<p>When connecting to an address, the first address entries in the semicolon-separated list should be tried first.</p>
<dl class="params"><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">address</td><td>the address. </td></tr>
<tr><td class="paramname">entry</td><td>return location to an array of entries. </td></tr>
<tr><td class="paramname">array_len</td><td>return location for array length. </td></tr>
<tr><td class="paramname">error</td><td>address where an error can be returned. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd><a class="el" href="group__DBusMacros.html#gaa8cecfc5c5c054d2875c03e77b7be15d" title="Expands to "1".">TRUE</a> on success, <a class="el" href="group__DBusMacros.html#gaa93f0eb578d23995850d61f7d61c55c1" title="Expands to "0".">FALSE</a> otherwise. </dd></dl>
<p>Definition at line <a class="el" href="dbus-address_8c_source.html#l00363">363</a> of file <a class="el" href="dbus-address_8c_source.html">dbus-address.c</a>.</p>
<p>References <a class="el" href="dbus-list_8c_source.html#l00270">_dbus_list_append()</a>, <a class="el" href="dbus-list_8c_source.html#l00542">_dbus_list_clear()</a>, <a class="el" href="dbus-list_8c_source.html#l00567">_dbus_list_get_first_link()</a>, <a class="el" href="dbus-list_8c_source.html#l00730">_dbus_list_get_length()</a>, <a class="el" href="dbus-list_8h_source.html#l00090">_dbus_list_get_next_link</a>, <a class="el" href="dbus-string_8c_source.html#l01357">_dbus_string_copy_len()</a>, <a class="el" href="dbus-string_8c_source.html#l01586">_dbus_string_find()</a>, <a class="el" href="dbus-string_8c_source.html#l01679">_dbus_string_find_to()</a>, <a class="el" href="dbus-string_8c_source.html#l00242">_dbus_string_free()</a>, <a class="el" href="dbus-string_8c_source.html#l00722">_dbus_string_get_length()</a>, <a class="el" href="dbus-string_8c_source.html#l00175">_dbus_string_init()</a>, <a class="el" href="dbus-string_8c_source.html#l00190">_dbus_string_init_const()</a>, <a class="el" href="dbus-list_8h_source.html#l00038">DBusList::data</a>, <a class="el" href="dbus-protocol_8h_source.html#l00362">DBUS_ERROR_BAD_ADDRESS</a>, <a class="el" href="dbus-errors_8c_source.html#l00329">dbus_error_is_set()</a>, <a class="el" href="dbus-protocol_8h_source.html#l00352">DBUS_ERROR_NO_MEMORY</a>, <a class="el" href="dbus-memory_8c_source.html#l00701">dbus_free()</a>, <a class="el" href="dbus-memory_8h_source.html#l00058">dbus_new</a>, <a class="el" href="dbus-memory_8h_source.html#l00059">dbus_new0</a>, <a class="el" href="dbus-errors_8c_source.html#l00354">dbus_set_error()</a>, <a class="el" href="group__DBusMacros.html#gaa93f0eb578d23995850d61f7d61c55c1">FALSE</a>, <a class="el" href="dbus-address_8c_source.html#l00047">DBusAddressEntry::keys</a>, <a class="el" href="dbus-address_8c_source.html#l00045">DBusAddressEntry::method</a>, <a class="el" href="group__DBusMacros.html#ga070d2ce7b6bb7e5c05602aa8c308d0c4">NULL</a>, <a class="el" href="group__DBusMacros.html#gaa8cecfc5c5c054d2875c03e77b7be15d">TRUE</a>, and <a class="el" href="dbus-address_8c_source.html#l00048">DBusAddressEntry::values</a>.</p>
<p>Referenced by <a class="el" href="dbus-server_8c_source.html#l00549">dbus_server_listen()</a>.</p>
</div>
</div>
</div><!-- contents -->
<hr class="footer"/><address class="footer"><small>
Generated on Thu Mar 3 2016 17:50:32 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>