comparison src/connection.h @ 10742:4228b6d78506

[gaim-migrate @ 12344] Combine gaim_connection_destroy and gaim_connection_disconnect committer: Tailor Script <tailor@pidgin.im>
author Mark Doliner <mark@kingant.net>
date Sun, 27 Mar 2005 00:20:43 +0000
parents 94cc67130789
children ca69d597a5e2
comparison
equal deleted inserted replaced
10741:2f5d99f963eb 10742:4228b6d78506
112 /** @name Connection API */ 112 /** @name Connection API */
113 /**************************************************************************/ 113 /**************************************************************************/
114 /*@{*/ 114 /*@{*/
115 115
116 /** 116 /**
117 * This function should only be called by gaim_connection_connect() 117 * This function should only be called by gaim_account_connect()
118 * in account.c. If you're trying to sign on an account, use that 118 * in account.c. If you're trying to sign on an account, use that
119 * function instead. 119 * function instead.
120 * 120 *
121 * Creates a connection to the specified account and either connects 121 * Creates a connection to the specified account and either connects
122 * or attempts to register a new account. If you are logging in, 122 * or attempts to register a new account. If you are logging in,
132 */ 132 */
133 void gaim_connection_new(GaimAccount *account, gboolean regist, 133 void gaim_connection_new(GaimAccount *account, gboolean regist,
134 const char *password); 134 const char *password);
135 135
136 /** 136 /**
137 * This function should only be called by gaim_connection_connect() 137 * This function should only be called by gaim_account_disconnect()
138 * in account.c. If you're trying to sign on an account, use that 138 * in account.c. If you're trying to sign on an account, use that
139 * function instead. 139 * function instead.
140 * 140 *
141 * Disconnects and destroys a GaimConnection. 141 * Disconnects and destroys a GaimConnection.
142 * 142 *
143 * @param gc The gaim connection to destroy. 143 * @param gc The gaim connection to destroy.
144 */ 144 */
145 void gaim_connection_destroy(GaimConnection *gc); 145 void gaim_connection_destroy(GaimConnection *gc);
146
147 /**
148 * This function should only be called by gaim_connection_disconnect()
149 * in account.c. If you're trying to sign out an account, use that
150 * function instead.
151 *
152 * Logs out of this connection.
153 *
154 * @param gc The connection to log out.
155 *
156 * @see gaim_connection_connect()
157 */
158 void gaim_connection_disconnect(GaimConnection *gc);
159 146
160 /** 147 /**
161 * Sets the connection state. 148 * Sets the connection state.
162 * 149 *
163 * @param gc The connection. 150 * @param gc The connection.