| <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> |
| <html> |
| <head> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <title>GTcpWrapperConnection: GIO Reference Manual</title> |
| <meta name="generator" content="DocBook XSL Stylesheets V1.79.1"> |
| <link rel="home" href="index.html" title="GIO Reference Manual"> |
| <link rel="up" href="highlevel-socket.html" title="High-level network functionallity"> |
| <link rel="prev" href="GTcpConnection.html" title="GTcpConnection"> |
| <link rel="next" href="GSocketListener.html" title="GSocketListener"> |
| <meta name="generator" content="GTK-Doc V1.25.1 (XML mode)"> |
| <link rel="stylesheet" href="style.css" type="text/css"> |
| </head> |
| <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> |
| <table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="5"><tr valign="middle"> |
| <td width="100%" align="left" class="shortcuts"> |
| <a href="#" class="shortcut">Top</a><span id="nav_description"> <span class="dim">|</span> |
| <a href="#GTcpWrapperConnection.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span> |
| <a href="#GTcpWrapperConnection.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_properties"> <span class="dim">|</span> |
| <a href="#GTcpWrapperConnection.properties" class="shortcut">Properties</a></span> |
| </td> |
| <td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td> |
| <td><a accesskey="u" href="highlevel-socket.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td> |
| <td><a accesskey="p" href="GTcpConnection.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td> |
| <td><a accesskey="n" href="GSocketListener.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td> |
| </tr></table> |
| <div class="refentry"> |
| <a name="GTcpWrapperConnection"></a><div class="titlepage"></div> |
| <div class="refnamediv"><table width="100%"><tr> |
| <td valign="top"> |
| <h2><span class="refentrytitle"><a name="GTcpWrapperConnection.top_of_page"></a>GTcpWrapperConnection</span></h2> |
| <p>GTcpWrapperConnection — Wrapper for non-GSocketConnection-based, |
| GSocket-based GIOStreams</p> |
| </td> |
| <td class="gallery_image" valign="top" align="right"></td> |
| </tr></table></div> |
| <div class="refsect1"> |
| <a name="GTcpWrapperConnection.functions"></a><h2>Functions</h2> |
| <div class="informaltable"><table class="informaltable" width="100%" border="0"> |
| <colgroup> |
| <col width="150px" class="functions_return"> |
| <col class="functions_name"> |
| </colgroup> |
| <tbody> |
| <tr> |
| <td class="function_type"> |
| <a class="link" href="GSocketConnection.html" title="GSocketConnection"><span class="returnvalue">GSocketConnection</span></a> * |
| </td> |
| <td class="function_name"> |
| <a class="link" href="GTcpWrapperConnection.html#g-tcp-wrapper-connection-new" title="g_tcp_wrapper_connection_new ()">g_tcp_wrapper_connection_new</a> <span class="c_punctuation">()</span> |
| </td> |
| </tr> |
| <tr> |
| <td class="function_type"> |
| <a class="link" href="GIOStream.html" title="GIOStream"><span class="returnvalue">GIOStream</span></a> * |
| </td> |
| <td class="function_name"> |
| <a class="link" href="GTcpWrapperConnection.html#g-tcp-wrapper-connection-get-base-io-stream" title="g_tcp_wrapper_connection_get_base_io_stream ()">g_tcp_wrapper_connection_get_base_io_stream</a> <span class="c_punctuation">()</span> |
| </td> |
| </tr> |
| </tbody> |
| </table></div> |
| </div> |
| <div class="refsect1"> |
| <a name="GTcpWrapperConnection.properties"></a><h2>Properties</h2> |
| <div class="informaltable"><table class="informaltable" border="0"> |
| <colgroup> |
| <col width="150px" class="properties_type"> |
| <col width="300px" class="properties_name"> |
| <col width="200px" class="properties_flags"> |
| </colgroup> |
| <tbody><tr> |
| <td class="property_type"> |
| <a class="link" href="GIOStream.html" title="GIOStream"><span class="type">GIOStream</span></a> *</td> |
| <td class="property_name"><a class="link" href="GTcpWrapperConnection.html#GTcpWrapperConnection--base-io-stream" title="The “base-io-stream” property">base-io-stream</a></td> |
| <td class="property_flags">Read / Write / Construct Only</td> |
| </tr></tbody> |
| </table></div> |
| </div> |
| <div class="refsect1"> |
| <a name="GTcpWrapperConnection.other"></a><h2>Types and Values</h2> |
| <div class="informaltable"><table class="informaltable" width="100%" border="0"> |
| <colgroup> |
| <col width="150px" class="name"> |
| <col class="description"> |
| </colgroup> |
| <tbody><tr> |
| <td class="datatype_keyword"> </td> |
| <td class="function_name"><a class="link" href="GTcpWrapperConnection.html#GTcpWrapperConnection-struct" title="GTcpWrapperConnection">GTcpWrapperConnection</a></td> |
| </tr></tbody> |
| </table></div> |
| </div> |
| <div class="refsect1"> |
| <a name="GTcpWrapperConnection.object-hierarchy"></a><h2>Object Hierarchy</h2> |
| <pre class="screen"> <a href="../gobject-The-Base-Object-Type.html#GObject-struct">GObject</a> |
| <span class="lineart">╰──</span> <a class="link" href="GIOStream.html" title="GIOStream">GIOStream</a> |
| <span class="lineart">╰──</span> <a class="link" href="GSocketConnection.html" title="GSocketConnection">GSocketConnection</a> |
| <span class="lineart">╰──</span> <a class="link" href="GTcpConnection.html" title="GTcpConnection">GTcpConnection</a> |
| <span class="lineart">╰──</span> GTcpWrapperConnection |
| </pre> |
| </div> |
| <div class="refsect1"> |
| <a name="GTcpWrapperConnection.includes"></a><h2>Includes</h2> |
| <pre class="synopsis">#include <gio/gio.h> |
| </pre> |
| </div> |
| <div class="refsect1"> |
| <a name="GTcpWrapperConnection.description"></a><h2>Description</h2> |
| <p>A <a class="link" href="GTcpWrapperConnection.html" title="GTcpWrapperConnection"><span class="type">GTcpWrapperConnection</span></a> can be used to wrap a <a class="link" href="GIOStream.html" title="GIOStream"><span class="type">GIOStream</span></a> that is |
| based on a <a class="link" href="GSocket.html" title="GSocket"><span class="type">GSocket</span></a>, but which is not actually a |
| <a class="link" href="GSocketConnection.html" title="GSocketConnection"><span class="type">GSocketConnection</span></a>. This is used by <a class="link" href="GSocketClient.html" title="GSocketClient"><span class="type">GSocketClient</span></a> so that it can |
| always return a <a class="link" href="GSocketConnection.html" title="GSocketConnection"><span class="type">GSocketConnection</span></a>, even when the connection it has |
| actually created is not directly a <a class="link" href="GSocketConnection.html" title="GSocketConnection"><span class="type">GSocketConnection</span></a>.</p> |
| </div> |
| <div class="refsect1"> |
| <a name="GTcpWrapperConnection.functions_details"></a><h2>Functions</h2> |
| <div class="refsect2"> |
| <a name="g-tcp-wrapper-connection-new"></a><h3>g_tcp_wrapper_connection_new ()</h3> |
| <pre class="programlisting"><a class="link" href="GSocketConnection.html" title="GSocketConnection"><span class="returnvalue">GSocketConnection</span></a> * |
| g_tcp_wrapper_connection_new (<em class="parameter"><code><a class="link" href="GIOStream.html" title="GIOStream"><span class="type">GIOStream</span></a> *base_io_stream</code></em>, |
| <em class="parameter"><code><a class="link" href="GSocket.html" title="GSocket"><span class="type">GSocket</span></a> *socket</code></em>);</pre> |
| <p>Wraps <em class="parameter"><code>base_io_stream</code></em> |
| and <em class="parameter"><code>socket</code></em> |
| together as a <a class="link" href="GSocketConnection.html" title="GSocketConnection"><span class="type">GSocketConnection</span></a>.</p> |
| <div class="refsect3"> |
| <a name="g-tcp-wrapper-connection-new.parameters"></a><h4>Parameters</h4> |
| <div class="informaltable"><table class="informaltable" width="100%" border="0"> |
| <colgroup> |
| <col width="150px" class="parameters_name"> |
| <col class="parameters_description"> |
| <col width="200px" class="parameters_annotations"> |
| </colgroup> |
| <tbody> |
| <tr> |
| <td class="parameter_name"><p>base_io_stream</p></td> |
| <td class="parameter_description"><p>the <a class="link" href="GIOStream.html" title="GIOStream"><span class="type">GIOStream</span></a> to wrap</p></td> |
| <td class="parameter_annotations"> </td> |
| </tr> |
| <tr> |
| <td class="parameter_name"><p>socket</p></td> |
| <td class="parameter_description"><p>the <a class="link" href="GSocket.html" title="GSocket"><span class="type">GSocket</span></a> associated with <em class="parameter"><code>base_io_stream</code></em> |
| </p></td> |
| <td class="parameter_annotations"> </td> |
| </tr> |
| </tbody> |
| </table></div> |
| </div> |
| <div class="refsect3"> |
| <a name="g-tcp-wrapper-connection-new.returns"></a><h4>Returns</h4> |
| <p> the new <a class="link" href="GSocketConnection.html" title="GSocketConnection"><span class="type">GSocketConnection</span></a>.</p> |
| </div> |
| <p class="since">Since: <a class="link" href="api-index-2-28.html#api-index-2.28">2.28</a></p> |
| </div> |
| <hr> |
| <div class="refsect2"> |
| <a name="g-tcp-wrapper-connection-get-base-io-stream"></a><h3>g_tcp_wrapper_connection_get_base_io_stream ()</h3> |
| <pre class="programlisting"><a class="link" href="GIOStream.html" title="GIOStream"><span class="returnvalue">GIOStream</span></a> * |
| g_tcp_wrapper_connection_get_base_io_stream |
| (<em class="parameter"><code><a class="link" href="GTcpWrapperConnection.html" title="GTcpWrapperConnection"><span class="type">GTcpWrapperConnection</span></a> *conn</code></em>);</pre> |
| <p>Get's <em class="parameter"><code>conn</code></em> |
| 's base <a class="link" href="GIOStream.html" title="GIOStream"><span class="type">GIOStream</span></a></p> |
| <div class="refsect3"> |
| <a name="g-tcp-wrapper-connection-get-base-io-stream.parameters"></a><h4>Parameters</h4> |
| <div class="informaltable"><table class="informaltable" width="100%" border="0"> |
| <colgroup> |
| <col width="150px" class="parameters_name"> |
| <col class="parameters_description"> |
| <col width="200px" class="parameters_annotations"> |
| </colgroup> |
| <tbody><tr> |
| <td class="parameter_name"><p>conn</p></td> |
| <td class="parameter_description"><p>a <a class="link" href="GTcpWrapperConnection.html" title="GTcpWrapperConnection"><span class="type">GTcpWrapperConnection</span></a></p></td> |
| <td class="parameter_annotations"> </td> |
| </tr></tbody> |
| </table></div> |
| </div> |
| <div class="refsect3"> |
| <a name="g-tcp-wrapper-connection-get-base-io-stream.returns"></a><h4>Returns</h4> |
| <p> <em class="parameter"><code>conn</code></em> |
| 's base <a class="link" href="GIOStream.html" title="GIOStream"><span class="type">GIOStream</span></a>. </p> |
| <p><span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span></p> |
| </div> |
| </div> |
| </div> |
| <div class="refsect1"> |
| <a name="GTcpWrapperConnection.other_details"></a><h2>Types and Values</h2> |
| <div class="refsect2"> |
| <a name="GTcpWrapperConnection-struct"></a><h3>GTcpWrapperConnection</h3> |
| <pre class="programlisting">typedef struct _GTcpWrapperConnection GTcpWrapperConnection;</pre> |
| <p><a class="link" href="GTcpWrapperConnection.html" title="GTcpWrapperConnection"><span class="type">GTcpWrapperConnection</span></a> is an opaque data structure and can only be accessed |
| using the following functions.</p> |
| </div> |
| </div> |
| <div class="refsect1"> |
| <a name="GTcpWrapperConnection.property-details"></a><h2>Property Details</h2> |
| <div class="refsect2"> |
| <a name="GTcpWrapperConnection--base-io-stream"></a><h3>The <code class="literal">“base-io-stream”</code> property</h3> |
| <pre class="programlisting"> “base-io-stream” <a class="link" href="GIOStream.html" title="GIOStream"><span class="type">GIOStream</span></a> *</pre> |
| <p>The wrapped GIOStream.</p> |
| <p>Flags: Read / Write / Construct Only</p> |
| </div> |
| </div> |
| <div class="refsect1"> |
| <a name="GTcpWrapperConnection.see-also"></a><h2>See Also</h2> |
| <p><a class="link" href="GSocketConnection.html" title="GSocketConnection"><span class="type">GSocketConnection</span></a>.</p> |
| </div> |
| </div> |
| <div class="footer"> |
| <hr>Generated by GTK-Doc V1.25.1</div> |
| </body> |
| </html> |