changeset 17233:3bccbafea8c1

- Completed SslConnection fields docs - Noted lack of code in purple_ssl_init
author William Ehlhardt <williamehlhardt@gmail.com>
date Thu, 24 May 2007 21:45:27 +0000
parents bf516a0c430e
children 752d16a0de51
files libpurple/sslconn.c libpurple/sslconn.h
diffstat 2 files changed, 7 insertions(+), 2 deletions(-) [+]
line wrap: on
line diff
--- a/libpurple/sslconn.c	Thu May 24 06:44:57 2007 +0000
+++ b/libpurple/sslconn.c	Thu May 24 21:45:27 2007 +0000
@@ -246,6 +246,8 @@
 void
 purple_ssl_init(void)
 {
+	/* This doesn't do anything at the moment. All the actual init work
+	 * is handled by purple_ssl_is_supported upon demand. */
 }
 
 void
--- a/libpurple/sslconn.h	Thu May 24 06:44:57 2007 +0000
+++ b/libpurple/sslconn.h	Thu May 24 21:45:27 2007 +0000
@@ -52,16 +52,19 @@
 	void *connect_cb_data;
 	/** Callback triggered once the SSL handshake is complete */
 	PurpleSslInputFunction connect_cb;
-	/** TODO: Document me! */
+	/** Callback triggered if there is an error during connection */
 	PurpleSslErrorFunction error_cb;
 	/** Data passed to PurpleSslConnection::recv_cb() */
-	/* TODO: Is this stuff even used?? */
 	void *recv_cb_data;
+	/** User-defined callback executed when the SSL connection receives data */
 	PurpleSslInputFunction recv_cb;
 
 	/** File descriptor used to refer to the socket */
 	int fd;
+	/** Glib event source ID; used to refer to the received data callback 
+	 * in the glib eventloop */
 	int inpa;
+	/** Data related to the underlying TCP connection */
 	PurpleProxyConnectData *connect_data;
 
 	/** Internal connection data managed by the SSL backend (GnuTLS/LibNSS/whatever) */