Sophie

Sophie

distrib > Mandriva > 2007.0 > x86_64 > media > main-release > by-pkgid > 926d2d1e3111287cee1b0a4fad4fb4f6 > files > 212

lib64dbus-1_3-devel-0.92-6mdv2007.0.x86_64.rpm

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title>DBusTransport implementations for UNIX</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
</head><body>
<!-- Generated by Doxygen 1.2.15 -->
<center>
<a class="qindex" href="index.html">Main Page</a> &nbsp; <a class="qindex" href="modules.html">Modules</a> &nbsp; <a class="qindex" href="annotated.html">Data Structures</a> &nbsp; <a class="qindex" href="files.html">File List</a> &nbsp; <a class="qindex" href="functions.html">Data Fields</a> &nbsp; <a class="qindex" href="pages.html">Related Pages</a> &nbsp; </center>
<hr><h1>DBusTransport implementations for UNIX<br>
<small>
[<a class="el" href="group__DBusInternals.html">D-BUS internal implementation details</a>]</small>
</h1>Implementation details of <a class="el" href="structDBusTransport.html">DBusTransport</a> on UNIX. 
<a href="#_details">More...</a><table border=0 cellpadding=0 cellspacing=0>
<tr><td colspan=2><br><h2>Data Structures</h2></td></tr>
<tr><td nowrap align=right valign=top>struct &nbsp;</td><td valign=bottom><a class="el" href="structDBusTransportUnix.html">DBusTransportUnix</a></td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em>Implementation details of DBusTransportUnix.</em> <a href="structDBusTransportUnix.html#_details">More...</a><em></em></font><br><br></td></tr>
<tr><td colspan=2><br><h2>Typedefs</h2></td></tr>
<tr><td nowrap align=right valign=top><a name="a0" doxytag="DBusTransportUnix::DBusTransportUnix"></a>
typedef DBusTransportUnix&nbsp;</td><td valign=bottom><a class="el" href="group__DBusTransportUnix.html#a0">DBusTransportUnix</a></td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em>Opaque object representing a Unix file descriptor transport.</em></font><br><br></td></tr>
<tr><td colspan=2><br><h2>Functions</h2></td></tr>
<tr><td nowrap align=right valign=top><a class="el" href="structDBusTransport.html">DBusTransport</a> *&nbsp;</td><td valign=bottom><a class="el" href="group__DBusTransportUnix.html#a19">_dbus_transport_new_for_fd</a> (int <a class="el" href="structDBusTransportUnix.html#m1">fd</a>, <a class="el" href="group__DBusTypes.html#a2">dbus_bool_t</a> server, const <a class="el" href="structDBusString.html">DBusString</a> *address)</td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em>Creates a new transport for the given file descriptor.</em> <a href="#a19">More...</a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top><a class="el" href="structDBusTransport.html">DBusTransport</a> *&nbsp;</td><td valign=bottom><a class="el" href="group__DBusTransportUnix.html#a20">_dbus_transport_new_for_domain_socket</a> (const char *path, <a class="el" href="group__DBusTypes.html#a2">dbus_bool_t</a> abstract, <a class="el" href="structDBusError.html">DBusError</a> *error)</td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em>Creates a new transport for the given Unix domain socket path.</em> <a href="#a20">More...</a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top><a class="el" href="structDBusTransport.html">DBusTransport</a> *&nbsp;</td><td valign=bottom><a class="el" href="group__DBusTransportUnix.html#a21">_dbus_transport_new_for_tcp_socket</a> (const char *host, <a class="el" href="group__DBusTypes.html#a4">dbus_int32_t</a> port, <a class="el" href="structDBusError.html">DBusError</a> *error)</td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em>Creates a new transport for the given hostname and port.</em> <a href="#a21">More...</a><em></em></font><br><br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
Implementation details of <a class="el" href="structDBusTransport.html">DBusTransport</a> on UNIX.
<p>

<p>
 <hr><h2>Function Documentation</h2>
<a name="a20" doxytag="dbus-transport-unix.c::_dbus_transport_new_for_domain_socket"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
  <tr>
    <td class="md">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" nowrap valign="top"> <a class="el" href="structDBusTransport.html">DBusTransport</a>* _dbus_transport_new_for_domain_socket </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="md" nowrap valign="top">const char *&nbsp;</td>
          <td class="mdname" nowrap>&nbsp; <em>path</em>, </td>
        </tr>
        <tr>
          <td></td>
          <td></td>
          <td class="md" nowrap><a class="el" href="group__DBusTypes.html#a2">dbus_bool_t</a>&nbsp;</td>
          <td class="mdname" nowrap>&nbsp; <em>abstract</em>, </td>
        </tr>
        <tr>
          <td></td>
          <td></td>
          <td class="md" nowrap><a class="el" href="structDBusError.html">DBusError</a> *&nbsp;</td>
          <td class="mdname" nowrap>&nbsp; <em>error</em></td>
        </tr>
        <tr>
          <td></td>
          <td class="md">)&nbsp;</td>
          <td class="md" colspan="2"></td>
        </tr>

      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Creates a new transport for the given Unix domain socket path.
<p>
This creates a client-side of a transport.
<p>

<p>
<dl compact><dt><b>
<a class="el" href="todo.html#_todo000070">Todo: </a></b><dd>
once we add a way to escape paths in a dbus address, this function needs to do escaping.</dl><dl compact><dt><b>
Parameters: </b><dd>
<table border=0 cellspacing=2 cellpadding=0>
<tr><td valign=top><em>path</em>&nbsp;</td><td>
the path to the domain socket. </td></tr>
<tr><td valign=top><em>abstract</em>&nbsp;</td><td>
<a class="el" href="group__DBusMacros.html#a2">TRUE</a> to use abstract socket namespace </td></tr>
<tr><td valign=top><em>error</em>&nbsp;</td><td>
address where an error can be returned. </td></tr>
</table>
</dl><dl compact><dt><b>
Returns: </b><dd>
a new transport, or <a class="el" href="group__DBusMacros.html#a4">NULL</a> on failure. </dl>
<p>
Definition at line <a class="el" href="dbus-transport-unix_8c-source.html#l01035">1035</a> of file <a class="el" href="dbus-transport-unix_8c-source.html">dbus-transport-unix.c</a>.    </td>
  </tr>
</table>
<a name="a19" doxytag="dbus-transport-unix.c::_dbus_transport_new_for_fd"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
  <tr>
    <td class="md">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" nowrap valign="top"> <a class="el" href="structDBusTransport.html">DBusTransport</a>* _dbus_transport_new_for_fd </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="md" nowrap valign="top">int&nbsp;</td>
          <td class="mdname" nowrap>&nbsp; <em>fd</em>, </td>
        </tr>
        <tr>
          <td></td>
          <td></td>
          <td class="md" nowrap><a class="el" href="group__DBusTypes.html#a2">dbus_bool_t</a>&nbsp;</td>
          <td class="mdname" nowrap>&nbsp; <em>server</em>, </td>
        </tr>
        <tr>
          <td></td>
          <td></td>
          <td class="md" nowrap>const <a class="el" href="structDBusString.html">DBusString</a> *&nbsp;</td>
          <td class="mdname" nowrap>&nbsp; <em>address</em></td>
        </tr>
        <tr>
          <td></td>
          <td class="md">)&nbsp;</td>
          <td class="md" colspan="2"></td>
        </tr>

      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Creates a new transport for the given file descriptor.
<p>
The file descriptor must be nonblocking (use <a class="el" href="group__DBusInternalsUtils.html#a103">_dbus_set_fd_nonblocking</a>() to make it so). This function is shared by various transports that boil down to a full duplex file descriptor.<dl compact><dt><b>
Parameters: </b><dd>
<table border=0 cellspacing=2 cellpadding=0>
<tr><td valign=top><em>fd</em>&nbsp;</td><td>
the file descriptor. </td></tr>
<tr><td valign=top><em>server</em>&nbsp;</td><td>
<a class="el" href="group__DBusMacros.html#a2">TRUE</a> if this transport is on the server side of a connection </td></tr>
<tr><td valign=top><em>address</em>&nbsp;</td><td>
the transport's address </td></tr>
</table>
</dl><dl compact><dt><b>
Returns: </b><dd>
the new transport, or <a class="el" href="group__DBusMacros.html#a4">NULL</a> if no memory. </dl>
<p>
Definition at line <a class="el" href="dbus-transport-unix_8c-source.html#l00965">965</a> of file <a class="el" href="dbus-transport-unix_8c-source.html">dbus-transport-unix.c</a>.
<p>
References <a class="el" href="dbus-transport-unix_8c-source.html#l00049">base</a>, <a class="el" href="dbus-transport-unix_8c-source.html#l00064">encoded_incoming</a>, <a class="el" href="dbus-transport-unix_8c-source.html#l00061">encoded_outgoing</a>, <a class="el" href="dbus-transport-unix_8c-source.html#l00050">fd</a>, <a class="el" href="dbus-transport-unix_8c-source.html#l00054">max_bytes_read_per_iteration</a>, <a class="el" href="dbus-transport-unix_8c-source.html#l00055">max_bytes_written_per_iteration</a>, <a class="el" href="dbus-transport-unix_8c-source.html#l00057">message_bytes_written</a>, <a class="el" href="dbus-transport-unix_8c-source.html#l00051">read_watch</a>, and <a class="el" href="dbus-transport-unix_8c-source.html#l00052">write_watch</a>.    </td>
  </tr>
</table>
<a name="a21" doxytag="dbus-transport-unix.c::_dbus_transport_new_for_tcp_socket"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
  <tr>
    <td class="md">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" nowrap valign="top"> <a class="el" href="structDBusTransport.html">DBusTransport</a>* _dbus_transport_new_for_tcp_socket </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="md" nowrap valign="top">const char *&nbsp;</td>
          <td class="mdname" nowrap>&nbsp; <em>host</em>, </td>
        </tr>
        <tr>
          <td></td>
          <td></td>
          <td class="md" nowrap><a class="el" href="group__DBusTypes.html#a4">dbus_int32_t</a>&nbsp;</td>
          <td class="mdname" nowrap>&nbsp; <em>port</em>, </td>
        </tr>
        <tr>
          <td></td>
          <td></td>
          <td class="md" nowrap><a class="el" href="structDBusError.html">DBusError</a> *&nbsp;</td>
          <td class="mdname" nowrap>&nbsp; <em>error</em></td>
        </tr>
        <tr>
          <td></td>
          <td class="md">)&nbsp;</td>
          <td class="md" colspan="2"></td>
        </tr>

      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Creates a new transport for the given hostname and port.
<p>
<dl compact><dt><b>
Parameters: </b><dd>
<table border=0 cellspacing=2 cellpadding=0>
<tr><td valign=top><em>host</em>&nbsp;</td><td>
the host to connect to </td></tr>
<tr><td valign=top><em>port</em>&nbsp;</td><td>
the port to connect to </td></tr>
<tr><td valign=top><em>error</em>&nbsp;</td><td>
location to store reason for failure. </td></tr>
</table>
</dl><dl compact><dt><b>
Returns: </b><dd>
a new transport, or <a class="el" href="group__DBusMacros.html#a4">NULL</a> on failure. </dl>
<p>
Definition at line <a class="el" href="dbus-transport-unix_8c-source.html#l01102">1102</a> of file <a class="el" href="dbus-transport-unix_8c-source.html">dbus-transport-unix.c</a>.    </td>
  </tr>
</table>
<hr><address align="right"><small>Generated on Wed Jun 9 05:01:28 2004 for D-BUS by
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border=0 
width=110 height=53></a>1.2.15 </small></address>
</body>
</html>