luc14n0/glib
1
0
Fork 0
mirror of https://gitlab.gnome.org/GNOME/glib.git synced 2025-02-02 17:26:17 +01:00
Code Issues Packages Projects Releases Wiki Activity

GSocketClient: convert docs to markdown

Browse Source
This commit is contained in:
Matthias Clasen 2014-01-31 22:42:21 -05:00
parent ba307a0c52
commit d7b9f20990
1 changed files with 34 additions and 74 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

108
gio/gsocketclient.c
View File

@ -774,80 +774,40 @@ g_socket_client_class_init (GSocketClientClass *class)
* information about a network connection in the UI. The meanings of * information about a network connection in the UI. The meanings of
* the different @event values are as follows: * the different @event values are as follows:
* *
* <variablelist> * - %G_SOCKET_CLIENT_RESOLVING: @client is about to look up @connectable
* <varlistentry> * in DNS. @connection will be %NULL.
* <term>%G_SOCKET_CLIENT_RESOLVING:</term> *
* <listitem><para> * - %G_SOCKET_CLIENT_RESOLVED: @client has successfully resolved
* @client is about to look up @connectable in DNS. * @connectable in DNS. @connection will be %NULL.
* @connection will be %NULL. *
* </para></listitem> * - %G_SOCKET_CLIENT_CONNECTING: @client is about to make a connection
* </varlistentry> * to a remote host; either a proxy server or the destination server
* <varlistentry> * itself. @connection is the #GSocketConnection, which is not yet
* <term>%G_SOCKET_CLIENT_RESOLVED:</term> * connected. Since GLib 2.40, you can access the remote
* <listitem><para> * address via g_socket_connection_get_remote_address().
* @client has successfully resolved @connectable in DNS. *
* @connection will be %NULL. * - %G_SOCKET_CLIENT_CONNECTED: @client has successfully connected
* </para></listitem> * to a remote host. @connection is the connected #GSocketConnection.
* </varlistentry> *
* <varlistentry> * - %G_SOCKET_CLIENT_PROXY_NEGOTIATING: @client is about to negotiate
* <term>%G_SOCKET_CLIENT_CONNECTING:</term> * with a proxy to get it to connect to @connectable. @connection is
* <listitem><para> * the #GSocketConnection to the proxy server.
* @client is about to make a connection to a remote host; *
* either a proxy server or the destination server itself. * - %G_SOCKET_CLIENT_PROXY_NEGOTIATED: @client has negotiated a
* @connection is the #GSocketConnection, which is not yet * connection to @connectable through a proxy server. @connection is
* connected. Since GLib 2.40, you can access the remote * the stream returned from g_proxy_connect(), which may or may not
* address via g_socket_connection_get_remote_address(). * be a #GSocketConnection.
* </para></listitem> *
* </varlistentry> * - %G_SOCKET_CLIENT_TLS_HANDSHAKING: @client is about to begin a TLS
* <varlistentry> * handshake. @connection is a #GTlsClientConnection.
* <term>%G_SOCKET_CLIENT_CONNECTED:</term> *
* <listitem><para> * - %G_SOCKET_CLIENT_TLS_HANDSHAKED: @client has successfully completed
* @client has successfully connected to a remote host. * the TLS handshake. @connection is a #GTlsClientConnection.
* @connection is the connected #GSocketConnection. *
* </para></listitem> * - %G_SOCKET_CLIENT_COMPLETE: @client has either successfully connected
* </varlistentry> * to @connectable (in which case @connection is the #GSocketConnection
* <varlistentry> * that it will be returning to the caller) or has failed (in which
* <term>%G_SOCKET_CLIENT_PROXY_NEGOTIATING:</term> * case @connection is %NULL and the client is about to return an error).
* <listitem><para>
* @client is about to negotiate with a proxy to get it to
* connect to @connectable. @connection is the
* #GSocketConnection to the proxy server.
* </para></listitem>
* </varlistentry>
* <varlistentry>
* <term>%G_SOCKET_CLIENT_PROXY_NEGOTIATED:</term>
* <listitem><para>
* @client has negotiated a connection to @connectable through
* a proxy server. @connection is the stream returned from
* g_proxy_connect(), which may or may not be a
* #GSocketConnection.
* </para></listitem>
* </varlistentry>
* <varlistentry>
* <term>%G_SOCKET_CLIENT_TLS_HANDSHAKING:</term>
* <listitem><para>
* @client is about to begin a TLS handshake. @connection is a
* #GTlsClientConnection.
* </para></listitem>
* </varlistentry>
* <varlistentry>
* <term>%G_SOCKET_CLIENT_TLS_HANDSHAKED:</term>
* <listitem><para>
* @client has successfully completed the TLS handshake.
* @connection is a #GTlsClientConnection.
* </para></listitem>
* </varlistentry>
* <varlistentry>
* <term>%G_SOCKET_CLIENT_COMPLETE:</term>
* <listitem><para>
* @client has either successfully connected to @connectable
* (in which case @connection is the #GSocketConnection that
* it will be returning to the caller) or has failed (in which
* case @connection is %NULL and the client is about to return
* an error).
* </para></listitem>
* </varlistentry>
* </variablelist>
* *
* Each event except %G_SOCKET_CLIENT_COMPLETE may be emitted * Each event except %G_SOCKET_CLIENT_COMPLETE may be emitted
* multiple times (or not at all) for a given connectable (in * multiple times (or not at all) for a given connectable (in