| Current File : //usr/share/doc/dbus/api/group__DBusTransportUnix.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: DBusTransport implementations for UNIX</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="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">DBusTransport implementations for UNIX</div> </div>
<div class="ingroups"><a class="el" href="group__DBusInternals.html">D-Bus secret internal implementation details</a></div></div><!--header-->
<div class="contents">
<p>Implementation details of <a class="el" href="structDBusTransport.html" title="Object representing a transport such as a socket.">DBusTransport</a> on UNIX.
<a href="#details">More...</a></p>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="func-members"></a>
Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="structDBusTransport.html">DBusTransport</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__DBusTransportUnix.html#gada3df30a229b4d29ccf30af83bd88fcc">_dbus_transport_new_for_domain_socket</a> (const char *path, <a class="el" href="group__DBusTypes.html#ga39c9cb0f3a2a8ad6f55cc4855d035349">dbus_bool_t</a> abstract, <a class="el" href="structDBusError.html">DBusError</a> *error)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Creates a new transport for the given Unix domain socket path. <a href="#gada3df30a229b4d29ccf30af83bd88fcc"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">DBusTransportOpenResult </td><td class="memItemRight" valign="bottom"><a class="el" href="group__DBusTransportUnix.html#gafd694944860033155276df9162bdf72e">_dbus_transport_open_platform_specific</a> (<a class="el" href="structDBusAddressEntry.html">DBusAddressEntry</a> *entry, <a class="el" href="structDBusTransport.html">DBusTransport</a> **transport_p, <a class="el" href="structDBusError.html">DBusError</a> *error)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Opens platform specific transport types. <a href="#gafd694944860033155276df9162bdf72e"></a><br/></td></tr>
</table>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<p>Implementation details of <a class="el" href="structDBusTransport.html" title="Object representing a transport such as a socket.">DBusTransport</a> on UNIX. </p>
<hr/><h2>Function Documentation</h2>
<a class="anchor" id="gada3df30a229b4d29ccf30af83bd88fcc"></a><!-- doxytag: member="dbus-transport-unix.c::_dbus_transport_new_for_domain_socket" ref="gada3df30a229b4d29ccf30af83bd88fcc" args="(const char *path, dbus_bool_t abstract, DBusError *error)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="structDBusTransport.html">DBusTransport</a>* <a class="el" href="group__DBusTransportUnix.html#gada3df30a229b4d29ccf30af83bd88fcc">_dbus_transport_new_for_domain_socket</a> </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>path</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="group__DBusTypes.html#ga39c9cb0f3a2a8ad6f55cc4855d035349">dbus_bool_t</a> </td>
<td class="paramname"><em>abstract</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>Creates a new transport for the given Unix domain socket path. </p>
<p>This creates a client-side of a transport.</p>
<dl class="todo"><dt><b><a class="el" href="todo.html#_todo000066">Todo:</a></b></dt><dd>once we add a way to escape paths in a dbus address, this function needs to do escaping.</dd></dl>
<dl class="params"><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">path</td><td>the path to the domain socket. </td></tr>
<tr><td class="paramname">abstract</td><td><a class="el" href="group__DBusMacros.html#gaa8cecfc5c5c054d2875c03e77b7be15d" title="Expands to "1".">TRUE</a> to use abstract socket namespace </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 new transport, or <a class="el" href="group__DBusMacros.html#ga070d2ce7b6bb7e5c05602aa8c308d0c4" title="A null pointer, defined appropriately for C or C++.">NULL</a> on failure. </dd></dl>
<p>Definition at line <a class="el" href="dbus-transport-unix_8c_source.html#l00058">58</a> of file <a class="el" href="dbus-transport-unix_8c_source.html">dbus-transport-unix.c</a>.</p>
<p>References <a class="el" href="dbus-sysdeps-unix_8c_source.html#l00202">_dbus_close_socket()</a>, <a class="el" href="dbus-sysdeps-unix_8c_source.html#l00831">_dbus_connect_unix_socket()</a>, <a class="el" href="dbus-string_8c_source.html#l00918">_dbus_string_append()</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-transport-socket_8c_source.html#l01256">_dbus_transport_new_for_socket()</a>, <a class="el" href="dbus-protocol_8h_source.html#l00352">DBUS_ERROR_NO_MEMORY</a>, <a class="el" href="dbus-errors_8c_source.html#l00354">dbus_set_error()</a>, and <a class="el" href="group__DBusMacros.html#ga070d2ce7b6bb7e5c05602aa8c308d0c4">NULL</a>.</p>
<p>Referenced by <a class="el" href="dbus-transport-unix_8c_source.html#l00225">_dbus_transport_open_platform_specific()</a>.</p>
</div>
</div>
<a class="anchor" id="gafd694944860033155276df9162bdf72e"></a><!-- doxytag: member="dbus-transport-unix.c::_dbus_transport_open_platform_specific" ref="gafd694944860033155276df9162bdf72e" args="(DBusAddressEntry *entry, DBusTransport **transport_p, DBusError *error)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">DBusTransportOpenResult <a class="el" href="group__DBusTransportUnix.html#gafd694944860033155276df9162bdf72e">_dbus_transport_open_platform_specific</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"><a class="el" href="structDBusTransport.html">DBusTransport</a> ** </td>
<td class="paramname"><em>transport_p</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>Opens platform specific transport types. </p>
<dl class="params"><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">entry</td><td>the address entry to try opening </td></tr>
<tr><td class="paramname">transport_p</td><td>return location for the opened transport </td></tr>
<tr><td class="paramname">error</td><td>error to be set </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>result of the attempt </dd></dl>
<p>Definition at line <a class="el" href="dbus-transport-unix_8c_source.html#l00225">225</a> of file <a class="el" href="dbus-transport-unix_8c_source.html">dbus-transport-unix.c</a>.</p>
<p>References <a class="el" href="dbus-sysdeps-unix_8c_source.html#l03651">_dbus_lookup_launchd_socket()</a>, <a class="el" href="dbus-address_8c_source.html#l00065">_dbus_set_bad_address()</a>, <a class="el" href="dbus-internals_8c_source.html#l00527">_dbus_strdup()</a>, <a class="el" href="dbus-string_8c_source.html#l00242">_dbus_string_free()</a>, <a class="el" href="dbus-string_8c_source.html#l00451">_dbus_string_get_const_data()</a>, <a class="el" href="dbus-string_8c_source.html#l00175">_dbus_string_init()</a>, <a class="el" href="dbus-transport-unix_8c_source.html#l00058">_dbus_transport_new_for_domain_socket()</a>, <a class="el" href="dbus-address_8c_source.html#l00227">dbus_address_entry_get_method()</a>, <a class="el" href="dbus-address_8c_source.html#l00244">dbus_address_entry_get_value()</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#l00211">dbus_error_free()</a>, <a class="el" href="dbus-errors_8h_source.html#l00062">DBUS_ERROR_INIT</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#l00749">dbus_free_string_array()</a>, <a class="el" href="dbus-errors_8c_source.html#l00279">dbus_move_error()</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="group__DBusMacros.html#ga070d2ce7b6bb7e5c05602aa8c308d0c4">NULL</a>, and <a class="el" href="group__DBusMacros.html#gaa8cecfc5c5c054d2875c03e77b7be15d">TRUE</a>.</p>
</div>
</div>
</div><!-- contents -->
<hr class="footer"/><address class="footer"><small>
Generated on Thu Mar 3 2016 17:50:34 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>