comparison libpurple/sslconn.h @ 17289:bf516a0c430e

More documenting
author William Ehlhardt <williamehlhardt@gmail.com>
date Thu, 24 May 2007 06:44:57 +0000
parents a7887e79b723
children 3bccbafea8c1
comparison
equal deleted inserted replaced
17288:a7887e79b723 17289:bf516a0c430e
46 { 46 {
47 /** Hostname to which the SSL connection will be made */ 47 /** Hostname to which the SSL connection will be made */
48 char *host; 48 char *host;
49 /** Port to connect to */ 49 /** Port to connect to */
50 int port; 50 int port;
51 /** Data to pass to PurpleSslConnection::connect_cb() */
51 void *connect_cb_data; 52 void *connect_cb_data;
53 /** Callback triggered once the SSL handshake is complete */
52 PurpleSslInputFunction connect_cb; 54 PurpleSslInputFunction connect_cb;
55 /** TODO: Document me! */
53 PurpleSslErrorFunction error_cb; 56 PurpleSslErrorFunction error_cb;
57 /** Data passed to PurpleSslConnection::recv_cb() */
58 /* TODO: Is this stuff even used?? */
54 void *recv_cb_data; 59 void *recv_cb_data;
55 PurpleSslInputFunction recv_cb; 60 PurpleSslInputFunction recv_cb;
56 61
57 /** File descriptor used to refer to the socket */ 62 /** File descriptor used to refer to the socket */
58 int fd; 63 int fd;
64 }; 69 };
65 70
66 /** 71 /**
67 * SSL implementation operations structure. 72 * SSL implementation operations structure.
68 * 73 *
69 * Every SSL implementation must provide all of these and register it. 74 * Every SSL implementation must provide all of these and register it via purple_ssl_set_ops()
70 * These should not be called directly! Instead, use the purple_ssl_* functions. 75 * These should not be called directly! Instead, use the purple_ssl_* functions.
71 * @see purple_ssl_set_ops
72 */ 76 */
73 typedef struct 77 typedef struct
74 { 78 {
75 /** Initializes the SSL system provided. 79 /** Initializes the SSL system provided.
76 * @return TRUE if initialization succeeded 80 * @return TRUE if initialization succeeded