docs/reference/gio/html/GTlsServerConnection.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>GTlsServerConnection: GIO Reference Manual</title>
   6 <meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
   7 <link rel="home" href="index.html" title="GIO Reference Manual">
   8 <link rel="up" href="tls.html" title="TLS (SSL) support">
   9 <link rel="prev" href="GTlsClientConnection.html" title="GTlsClientConnection">
  10 <link rel="next" href="GDtlsConnection.html" title="GDtlsConnection">
  11 <meta name="generator" content="GTK-Doc V1.25.1 (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="5"><tr valign="middle">
  16 <td width="100%" align="left" class="shortcuts">
  17 <a href="#" class="shortcut">Top</a><span id="nav_description">  <span class="dim">|</span>
  18                   <a href="#GTlsServerConnection.description" class="shortcut">Description</a></span><span id="nav_hierarchy">  <span class="dim">|</span>
  19                   <a href="#GTlsServerConnection.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_prerequisites">  <span class="dim">|</span>
  20                   <a href="#GTlsServerConnection.prerequisites" class="shortcut">Prerequisites</a></span><span id="nav_properties">  <span class="dim">|</span>
  21                   <a href="#GTlsServerConnection.properties" class="shortcut">Properties</a></span>
  22 </td>
  23 <td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
  24 <td><a accesskey="u" href="tls.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
  25 <td><a accesskey="p" href="GTlsClientConnection.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
  26 <td><a accesskey="n" href="GDtlsConnection.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
  27 </tr></table>
  28 <div class="refentry">
  29 <a name="GTlsServerConnection"></a><div class="titlepage"></div>
  30 <div class="refnamediv"><table width="100%"><tr>
  31 <td valign="top">
  32 <h2><span class="refentrytitle"><a name="GTlsServerConnection.top_of_page"></a>GTlsServerConnection</span></h2>
  33 <p>GTlsServerConnection — TLS server-side connection</p>
  34 </td>
  35 <td class="gallery_image" valign="top" align="right"></td>
  36 </tr></table></div>
  37 <div class="refsect1">
  38 <a name="GTlsServerConnection.functions"></a><h2>Functions</h2>
  39 <div class="informaltable"><table class="informaltable" width="100%" border="0">
  40 <colgroup>
  41 <col width="150px" class="functions_return">
  42 <col class="functions_name">
  43 </colgroup>
  44 <tbody><tr>
  45 <td class="function_type">
  46 <a class="link" href="GIOStream.html" title="GIOStream"><span class="returnvalue">GIOStream</span></a> *
  47 </td>
  48 <td class="function_name">
  49 <a class="link" href="GTlsServerConnection.html#g-tls-server-connection-new" title="g_tls_server_connection_new ()">g_tls_server_connection_new</a> <span class="c_punctuation">()</span>
  50 </td>
  51 </tr></tbody>
  52 </table></div>
  53 </div>
  54 <div class="refsect1">
  55 <a name="GTlsServerConnection.properties"></a><h2>Properties</h2>
  56 <div class="informaltable"><table class="informaltable" border="0">
  57 <colgroup>
  58 <col width="150px" class="properties_type">
  59 <col width="300px" class="properties_name">
  60 <col width="200px" class="properties_flags">
  61 </colgroup>
  62 <tbody><tr>
  63 <td class="property_type"><a class="link" href="gio-TLS-Overview.html#GTlsAuthenticationMode" title="enum GTlsAuthenticationMode"><span class="type">GTlsAuthenticationMode</span></a></td>
  64 <td class="property_name"><a class="link" href="GTlsServerConnection.html#GTlsServerConnection--authentication-mode" title="The “authentication-mode” property">authentication-mode</a></td>
  65 <td class="property_flags">Read / Write</td>
  66 </tr></tbody>
  67 </table></div>
  68 </div>
  69 <div class="refsect1">
  70 <a name="GTlsServerConnection.other"></a><h2>Types and Values</h2>
  71 <div class="informaltable"><table class="informaltable" width="100%" border="0">
  72 <colgroup>
  73 <col width="150px" class="name">
  74 <col class="description">
  75 </colgroup>
  76 <tbody>
  77 <tr>
  78 <td class="datatype_keyword"> </td>
  79 <td class="function_name"><a class="link" href="GTlsServerConnection.html#GTlsServerConnection-struct" title="GTlsServerConnection">GTlsServerConnection</a></td>
  80 </tr>
  81 <tr>
  82 <td class="datatype_keyword">struct</td>
  83 <td class="function_name"><a class="link" href="GTlsServerConnection.html#GTlsServerConnectionInterface" title="struct GTlsServerConnectionInterface">GTlsServerConnectionInterface</a></td>
  84 </tr>
  85 </tbody>
  86 </table></div>
  87 </div>
  88 <div class="refsect1">
  89 <a name="GTlsServerConnection.object-hierarchy"></a><h2>Object Hierarchy</h2>
  90 <pre class="screen">    <a href="https://developer.gnome.org/gobject/unstable/GTypeModule.html">GInterface</a>
  91     <span class="lineart">╰──</span> GTlsServerConnection
  92 </pre>
  93 </div>
  94 <div class="refsect1">
  95 <a name="GTlsServerConnection.prerequisites"></a><h2>Prerequisites</h2>
  96 <p>
  97 GTlsServerConnection requires
  98  <a class="link" href="GTlsConnection.html" title="GTlsConnection">GTlsConnection</a>.</p>
  99 </div>
 100 <div class="refsect1">
 101 <a name="GTlsServerConnection.includes"></a><h2>Includes</h2>
 102 <pre class="synopsis">#include &lt;gio/gio.h&gt;
 103 </pre>
 104 </div>
 105 <div class="refsect1">
 106 <a name="GTlsServerConnection.description"></a><h2>Description</h2>
 107 <p><a class="link" href="GTlsServerConnection.html" title="GTlsServerConnection"><span class="type">GTlsServerConnection</span></a> is the server-side subclass of <a class="link" href="GTlsConnection.html" title="GTlsConnection"><span class="type">GTlsConnection</span></a>,
 108 representing a server-side TLS connection.</p>
 109 </div>
 110 <div class="refsect1">
 111 <a name="GTlsServerConnection.functions_details"></a><h2>Functions</h2>
 112 <div class="refsect2">
 113 <a name="g-tls-server-connection-new"></a><h3>g_tls_server_connection_new ()</h3>
 114 <pre class="programlisting"><a class="link" href="GIOStream.html" title="GIOStream"><span class="returnvalue">GIOStream</span></a> *
 115 g_tls_server_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>,
 116                              <em class="parameter"><code><a class="link" href="GTlsCertificate.html" title="GTlsCertificate"><span class="type">GTlsCertificate</span></a> *certificate</code></em>,
 117                              <em class="parameter"><code><a href="../glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre>
 118 <p>Creates a new <a class="link" href="GTlsServerConnection.html" title="GTlsServerConnection"><span class="type">GTlsServerConnection</span></a> wrapping <em class="parameter"><code>base_io_stream</code></em>
 119  (which
 120 must have pollable input and output streams).</p>
 121 <p>See the documentation for <a class="link" href="GTlsConnection.html#GTlsConnection--base-io-stream" title="The “base-io-stream” property"><span class="type">“base-io-stream”</span></a> for restrictions
 122 on when application code can run operations on the <em class="parameter"><code>base_io_stream</code></em>
 123  after
 124 this function has returned.</p>
 125 <div class="refsect3">
 126 <a name="g-tls-server-connection-new.parameters"></a><h4>Parameters</h4>
 127 <div class="informaltable"><table class="informaltable" width="100%" border="0">
 128 <colgroup>
 129 <col width="150px" class="parameters_name">
 130 <col class="parameters_description">
 131 <col width="200px" class="parameters_annotations">
 132 </colgroup>
 133 <tbody>
 134 <tr>
 135 <td class="parameter_name"><p>base_io_stream</p></td>
 136 <td class="parameter_description"><p>the <a class="link" href="GIOStream.html" title="GIOStream"><span class="type">GIOStream</span></a> to wrap</p></td>
 137 <td class="parameter_annotations"> </td>
 138 </tr>
 139 <tr>
 140 <td class="parameter_name"><p>certificate</p></td>
 141 <td class="parameter_description"><p> the default server certificate, or <a href="../glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. </p></td>
 142 <td class="parameter_annotations"><span class="annotation">[<acronym title="NULL is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span></td>
 143 </tr>
 144 <tr>
 145 <td class="parameter_name"><p>error</p></td>
 146 <td class="parameter_description"><p><a href="../glib-Error-Reporting.html#GError"><span class="type">GError</span></a> for error reporting, or <a href="../glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> to ignore.</p></td>
 147 <td class="parameter_annotations"> </td>
 148 </tr>
 149 </tbody>
 150 </table></div>
 151 </div>
 152 <div class="refsect3">
 153 <a name="g-tls-server-connection-new.returns"></a><h4>Returns</h4>
 154 <p> the new
 155 <a class="link" href="GTlsServerConnection.html" title="GTlsServerConnection"><span class="type">GTlsServerConnection</span></a>, or <a href="../glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> on error. </p>
 156 <p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>][<acronym title="Override the parsed C type with given type."><span class="acronym">type</span></acronym> GTlsServerConnection]</span></p>
 157 </div>
 158 <p class="since">Since: <a class="link" href="api-index-2-28.html#api-index-2.28">2.28</a></p>
 159 </div>
 160 </div>
 161 <div class="refsect1">
 162 <a name="GTlsServerConnection.other_details"></a><h2>Types and Values</h2>
 163 <div class="refsect2">
 164 <a name="GTlsServerConnection-struct"></a><h3>GTlsServerConnection</h3>
 165 <pre class="programlisting">typedef struct _GTlsServerConnection GTlsServerConnection;</pre>
 166 <p>TLS server-side connection. This is the server-side implementation
 167 of a <a class="link" href="GTlsConnection.html" title="GTlsConnection"><span class="type">GTlsConnection</span></a>.</p>
 168 <p class="since">Since: <a class="link" href="api-index-2-28.html#api-index-2.28">2.28</a></p>
 169 </div>
 170 <hr>
 171 <div class="refsect2">
 172 <a name="GTlsServerConnectionInterface"></a><h3>struct GTlsServerConnectionInterface</h3>
 173 <pre class="programlisting">struct GTlsServerConnectionInterface {
 174   GTypeInterface g_iface;
 175 };
 176 </pre>
 177 <p>vtable for a <a class="link" href="GTlsServerConnection.html" title="GTlsServerConnection"><span class="type">GTlsServerConnection</span></a> implementation.</p>
 178 <div class="refsect3">
 179 <a name="GTlsServerConnectionInterface.members"></a><h4>Members</h4>
 180 <div class="informaltable"><table class="informaltable" width="100%" border="0">
 181 <colgroup>
 182 <col width="300px" class="struct_members_name">
 183 <col class="struct_members_description">
 184 <col width="200px" class="struct_members_annotations">
 185 </colgroup>
 186 <tbody></tbody>
 187 </table></div>
 188 </div>
 189 <p class="since">Since: <a class="link" href="api-index-2-26.html#api-index-2.26">2.26</a></p>
 190 </div>
 191 </div>
 192 <div class="refsect1">
 193 <a name="GTlsServerConnection.property-details"></a><h2>Property Details</h2>
 194 <div class="refsect2">
 195 <a name="GTlsServerConnection--authentication-mode"></a><h3>The <code class="literal">“authentication-mode”</code> property</h3>
 196 <pre class="programlisting">  “authentication-mode”      <a class="link" href="gio-TLS-Overview.html#GTlsAuthenticationMode" title="enum GTlsAuthenticationMode"><span class="type">GTlsAuthenticationMode</span></a></pre>
 197 <p>The <a class="link" href="gio-TLS-Overview.html#GTlsAuthenticationMode" title="enum GTlsAuthenticationMode"><span class="type">GTlsAuthenticationMode</span></a> for the server. This can be changed
 198 before calling <a class="link" href="GTlsConnection.html#g-tls-connection-handshake" title="g_tls_connection_handshake ()"><code class="function">g_tls_connection_handshake()</code></a> if you want to
 199 rehandshake with a different mode from the initial handshake.</p>
 200 <p>Flags: Read / Write</p>
 201 <p>Default value: G_TLS_AUTHENTICATION_NONE</p>
 202 <p class="since">Since: <a class="link" href="api-index-2-28.html#api-index-2.28">2.28</a></p>
 203 </div>
 204 </div>
 205 </div>
 206 <div class="footer">
 207 <hr>Generated by GTK-Doc V1.25.1</div>
 208 </body>
 209 </html>