luc14n0/glib
1
0
Fork 0
mirror of https://gitlab.gnome.org/GNOME/glib.git synced 2024-12-28 00:16:15 +01:00
Code Issues Packages Projects Releases Wiki Activity

Merge branch 'mcatanzaro/peer-certificate' into 'master'

Browse Source 
gtlsconnection: Improve documentation of peer-certificate[-errors]

See merge request GNOME/glib!1528
This commit is contained in:
Philip Withnall 2020-06-11 11:32:26 +00:00
commit d8b8cad5a1
2 changed files with 14 additions and 16 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
gio/gdtlsconnection.c
View File

@ -195,9 +195,8 @@ g_dtls_connection_default_init (GDtlsConnectionInterface *iface)
* GDtlsConnection:peer-certificate: (nullable) * GDtlsConnection:peer-certificate: (nullable)
* *
* The connection's peer's certificate, after the TLS handshake has * The connection's peer's certificate, after the TLS handshake has
* completed and the certificate has been accepted. Note in * completed or failed. Note in particular that this is not yet set
* particular that this is not yet set during the emission of * during the emission of #GDtlsConnection::accept-certificate.
* #GDtlsConnection::accept-certificate.
* *
* (You can watch for a #GObject::notify signal on this property to * (You can watch for a #GObject::notify signal on this property to
* detect when a handshake has occurred.) * detect when a handshake has occurred.)
@ -214,7 +213,7 @@ g_dtls_connection_default_init (GDtlsConnectionInterface *iface)
/** /**
* GDtlsConnection:peer-certificate-errors: * GDtlsConnection:peer-certificate-errors:
* *
* The errors noticed-and-ignored while verifying * The errors noticed while verifying
* #GDtlsConnection:peer-certificate. Normally this should be 0, but * #GDtlsConnection:peer-certificate. Normally this should be 0, but
* it may not be if #GDtlsClientConnection:validation-flags is not * it may not be if #GDtlsClientConnection:validation-flags is not
* %G_TLS_CERTIFICATE_VALIDATE_ALL, or if * %G_TLS_CERTIFICATE_VALIDATE_ALL, or if
@ -494,8 +493,8 @@ g_dtls_connection_get_interaction (GDtlsConnection *conn)
* g_dtls_connection_get_peer_certificate: * g_dtls_connection_get_peer_certificate:
* @conn: a #GDtlsConnection * @conn: a #GDtlsConnection
* *
* Gets @conn's peer's certificate after the handshake has completed. * Gets @conn's peer's certificate after the handshake has completed
* (It is not set during the emission of * or failed. (It is not set during the emission of
* #GDtlsConnection::accept-certificate.) * #GDtlsConnection::accept-certificate.)
* *
* Returns: (transfer none) (nullable): @conn's peer's certificate, or %NULL * Returns: (transfer none) (nullable): @conn's peer's certificate, or %NULL
@ -521,8 +520,8 @@ g_dtls_connection_get_peer_certificate (GDtlsConnection *conn)
* @conn: a #GDtlsConnection * @conn: a #GDtlsConnection
* *
* Gets the errors associated with validating @conn's peer's * Gets the errors associated with validating @conn's peer's
* certificate, after the handshake has completed. (It is not set * certificate, after the handshake has completed or failed. (It is
* during the emission of #GDtlsConnection::accept-certificate.) * not set during the emission of #GDtlsConnection::accept-certificate.)
* *
* Returns: @conn's peer's certificate errors * Returns: @conn's peer's certificate errors
* *

15
gio/gtlsconnection.c
View File

@ -228,9 +228,8 @@ g_tls_connection_class_init (GTlsConnectionClass *klass)
* GTlsConnection:peer-certificate: (nullable) * GTlsConnection:peer-certificate: (nullable)
* *
* The connection's peer's certificate, after the TLS handshake has * The connection's peer's certificate, after the TLS handshake has
* completed and the certificate has been accepted. Note in * completed or failed. Note in particular that this is not yet set
* particular that this is not yet set during the emission of * during the emission of #GTlsConnection::accept-certificate.
* #GTlsConnection::accept-certificate.
* *
* (You can watch for a #GObject::notify signal on this property to * (You can watch for a #GObject::notify signal on this property to
* detect when a handshake has occurred.) * detect when a handshake has occurred.)
@ -247,7 +246,7 @@ g_tls_connection_class_init (GTlsConnectionClass *klass)
/** /**
* GTlsConnection:peer-certificate-errors: * GTlsConnection:peer-certificate-errors:
* *
* The errors noticed-and-ignored while verifying * The errors noticed while verifying
* #GTlsConnection:peer-certificate. Normally this should be 0, but * #GTlsConnection:peer-certificate. Normally this should be 0, but
* it may not be if #GTlsClientConnection:validation-flags is not * it may not be if #GTlsClientConnection:validation-flags is not
* %G_TLS_CERTIFICATE_VALIDATE_ALL, or if * %G_TLS_CERTIFICATE_VALIDATE_ALL, or if
@ -611,8 +610,8 @@ g_tls_connection_get_interaction (GTlsConnection *conn)
* g_tls_connection_get_peer_certificate: * g_tls_connection_get_peer_certificate:
* @conn: a #GTlsConnection * @conn: a #GTlsConnection
* *
* Gets @conn's peer's certificate after the handshake has completed. * Gets @conn's peer's certificate after the handshake has completed
* (It is not set during the emission of * or failed. (It is not set during the emission of
* #GTlsConnection::accept-certificate.) * #GTlsConnection::accept-certificate.)
* *
* Returns: (transfer none) (nullable): @conn's peer's certificate, or %NULL * Returns: (transfer none) (nullable): @conn's peer's certificate, or %NULL
@ -638,8 +637,8 @@ g_tls_connection_get_peer_certificate (GTlsConnection *conn)
* @conn: a #GTlsConnection * @conn: a #GTlsConnection
* *
* Gets the errors associated with validating @conn's peer's * Gets the errors associated with validating @conn's peer's
* certificate, after the handshake has completed. (It is not set * certificate, after the handshake has completed or failed. (It is
* during the emission of #GTlsConnection::accept-certificate.) * not set during the emission of #GTlsConnection::accept-certificate.)
* *
* Returns: @conn's peer's certificate errors * Returns: @conn's peer's certificate errors
* *