docs/reference/gio/html/GTcpConnection.html

   1 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
   2 <html>
   3 <head>
   4 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
   5 <title>GTcpConnection</title>
   6 <meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
   7 <link rel="home" href="index.html" title="GIO Reference Manual">
   8 <link rel="up" href="highlevel-socket.html" title="High-level network functionallity">
   9 <link rel="prev" href="GUnixConnection.html" title="GUnixConnection">
  10 <link rel="next" href="GTcpWrapperConnection.html" title="GTcpWrapperConnection">
  11 <meta name="generator" content="GTK-Doc V1.18 (XML mode)">
  12 <link rel="stylesheet" href="style.css" type="text/css">
  13 </head>
  14 <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
  15 <table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
  16 <tr valign="middle">
  17 <td><a accesskey="p" href="GUnixConnection.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
  18 <td><a accesskey="u" href="highlevel-socket.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
  19 <td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
  20 <th width="100%" align="center">GIO Reference Manual</th>
  21 <td><a accesskey="n" href="GTcpWrapperConnection.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
  22 </tr>
  23 <tr><td colspan="5" class="shortcuts">
  24 <a href="#GTcpConnection.synopsis" class="shortcut">Top</a>
  25                    |
  26                   <a href="#GTcpConnection.description" class="shortcut">Description</a>
  27                    |
  28                   <a href="#GTcpConnection.object-hierarchy" class="shortcut">Object Hierarchy</a>
  29                    |
  30                   <a href="#GTcpConnection.properties" class="shortcut">Properties</a>
  31 </td></tr>
  32 </table>
  33 <div class="refentry">
  34 <a name="GTcpConnection"></a><div class="titlepage"></div>
  35 <div class="refnamediv"><table width="100%"><tr>
  36 <td valign="top">
  37 <h2><span class="refentrytitle"><a name="GTcpConnection.top_of_page"></a>GTcpConnection</span></h2>
  38 <p>GTcpConnection — A TCP GSocketConnection</p>
  39 </td>
  40 <td valign="top" align="right"></td>
  41 </tr></table></div>
  42 <div class="refsynopsisdiv">
  43 <a name="GTcpConnection.synopsis"></a><h2>Synopsis</h2>
  44 <pre class="synopsis">                    <a class="link" href="GTcpConnection.html#GTcpConnection-struct" title="GTcpConnection">GTcpConnection</a>;
  45 <span class="returnvalue">void</span>                <a class="link" href="GTcpConnection.html#g-tcp-connection-set-graceful-disconnect" title="g_tcp_connection_set_graceful_disconnect ()">g_tcp_connection_set_graceful_disconnect</a>
  46                                                         (<em class="parameter"><code><a class="link" href="GTcpConnection.html" title="GTcpConnection"><span class="type">GTcpConnection</span></a> *connection</code></em>,
  47                                                          <em class="parameter"><code><a href="./../glib/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> graceful_disconnect</code></em>);
  48 <a href="./../glib/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            <a class="link" href="GTcpConnection.html#g-tcp-connection-get-graceful-disconnect" title="g_tcp_connection_get_graceful_disconnect ()">g_tcp_connection_get_graceful_disconnect</a>
  49                                                         (<em class="parameter"><code><a class="link" href="GTcpConnection.html" title="GTcpConnection"><span class="type">GTcpConnection</span></a> *connection</code></em>);
  50 </pre>
  51 </div>
  52 <div class="refsect1">
  53 <a name="GTcpConnection.object-hierarchy"></a><h2>Object Hierarchy</h2>
  54 <pre class="synopsis">
  55   <a href="./../gobject/gobject/gobject-The-Base-Object-Type.html#GObject">GObject</a>
  56    +----<a class="link" href="GIOStream.html" title="GIOStream">GIOStream</a>
  57          +----<a class="link" href="GSocketConnection.html" title="GSocketConnection">GSocketConnection</a>
  58                +----GTcpConnection
  59                      +----<a class="link" href="GTcpWrapperConnection.html" title="GTcpWrapperConnection">GTcpWrapperConnection</a>
  60 </pre>
  61 </div>
  62 <div class="refsect1">
  63 <a name="GTcpConnection.properties"></a><h2>Properties</h2>
  64 <pre class="synopsis">
  65   "<a class="link" href="GTcpConnection.html#GTcpConnection--graceful-disconnect" title='The "graceful-disconnect" property'>graceful-disconnect</a>"      <a href="./../glib/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a>              : Read / Write
  66 </pre>
  67 </div>
  68 <div class="refsect1">
  69 <a name="GTcpConnection.description"></a><h2>Description</h2>
  70 <p>
  71 This is the subclass of <a class="link" href="GSocketConnection.html" title="GSocketConnection"><span class="type">GSocketConnection</span></a> that is created
  72 for TCP/IP sockets.
  73 </p>
  74 </div>
  75 <div class="refsect1">
  76 <a name="GTcpConnection.details"></a><h2>Details</h2>
  77 <div class="refsect2">
  78 <a name="GTcpConnection-struct"></a><h3>GTcpConnection</h3>
  79 <pre class="programlisting">typedef struct _GTcpConnection GTcpConnection;</pre>
  80 <p>
  81 A <a class="link" href="GSocketConnection.html" title="GSocketConnection"><span class="type">GSocketConnection</span></a> for TCP/IP connections.
  82 </p>
  83 <p class="since">Since 2.22</p>
  84 </div>
  85 <hr>
  86 <div class="refsect2">
  87 <a name="g-tcp-connection-set-graceful-disconnect"></a><h3>g_tcp_connection_set_graceful_disconnect ()</h3>
  88 <pre class="programlisting"><span class="returnvalue">void</span>                g_tcp_connection_set_graceful_disconnect
  89                                                         (<em class="parameter"><code><a class="link" href="GTcpConnection.html" title="GTcpConnection"><span class="type">GTcpConnection</span></a> *connection</code></em>,
  90                                                          <em class="parameter"><code><a href="./../glib/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> graceful_disconnect</code></em>);</pre>
  91 <p>
  92 This enabled graceful disconnects on close. A graceful disconnect
  93 means that we signal the receiving end that the connection is terminated
  94 and wait for it to close the connection before closing the connection.
  95 </p>
  96 <p>
  97 A graceful disconnect means that we can be sure that we successfully sent
  98 all the outstanding data to the other end, or get an error reported.
  99 However, it also means we have to wait for all the data to reach the
 100 other side and for it to acknowledge this by closing the socket, which may
 101 take a while. For this reason it is disabled by default.
 102 </p>
 103 <div class="variablelist"><table border="0">
 104 <col align="left" valign="top">
 105 <tbody>
 106 <tr>
 107 <td><p><span class="term"><em class="parameter"><code>connection</code></em> :</span></p></td>
 108 <td>a <a class="link" href="GTcpConnection.html" title="GTcpConnection"><span class="type">GTcpConnection</span></a>
 109 </td>
 110 </tr>
 111 <tr>
 112 <td><p><span class="term"><em class="parameter"><code>graceful_disconnect</code></em> :</span></p></td>
 113 <td>Whether to do graceful disconnects or not</td>
 114 </tr>
 115 </tbody>
 116 </table></div>
 117 <p class="since">Since 2.22</p>
 118 </div>
 119 <hr>
 120 <div class="refsect2">
 121 <a name="g-tcp-connection-get-graceful-disconnect"></a><h3>g_tcp_connection_get_graceful_disconnect ()</h3>
 122 <pre class="programlisting"><a href="./../glib/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            g_tcp_connection_get_graceful_disconnect
 123                                                         (<em class="parameter"><code><a class="link" href="GTcpConnection.html" title="GTcpConnection"><span class="type">GTcpConnection</span></a> *connection</code></em>);</pre>
 124 <p>
 125 Checks if graceful disconnects are used. See
 126 <a class="link" href="GTcpConnection.html#g-tcp-connection-set-graceful-disconnect" title="g_tcp_connection_set_graceful_disconnect ()"><code class="function">g_tcp_connection_set_graceful_disconnect()</code></a>.
 127 </p>
 128 <div class="variablelist"><table border="0">
 129 <col align="left" valign="top">
 130 <tbody>
 131 <tr>
 132 <td><p><span class="term"><em class="parameter"><code>connection</code></em> :</span></p></td>
 133 <td>a <a class="link" href="GTcpConnection.html" title="GTcpConnection"><span class="type">GTcpConnection</span></a>
 134 </td>
 135 </tr>
 136 <tr>
 137 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 138 <td>
 139 <a href="./../glib/glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if graceful disconnect is used on close, <a href="./../glib/glib/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> otherwise</td>
 140 </tr>
 141 </tbody>
 142 </table></div>
 143 <p class="since">Since 2.22</p>
 144 </div>
 145 </div>
 146 <div class="refsect1">
 147 <a name="GTcpConnection.property-details"></a><h2>Property Details</h2>
 148 <div class="refsect2">
 149 <a name="GTcpConnection--graceful-disconnect"></a><h3>The <code class="literal">"graceful-disconnect"</code> property</h3>
 150 <pre class="programlisting">  "graceful-disconnect"      <a href="./../glib/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a>              : Read / Write</pre>
 151 <p>Whether or not close does a graceful disconnect.</p>
 152 <p>Default value: FALSE</p>
 153 </div>
 154 </div>
 155 <div class="refsect1">
 156 <a name="GTcpConnection.see-also"></a><h2>See Also</h2>
 157 <a class="link" href="GSocketConnection.html" title="GSocketConnection"><span class="type">GSocketConnection</span></a>.
 158 </div>
 159 </div>
 160 <div class="footer">
 161 <hr>
 162           Generated by GTK-Doc V1.18</div>
 163 </body>
 164 </html>