comparison src/proxy.h @ 11211:03a244acce57

[gaim-migrate @ 13342] (14:28:27) Christopher O'Brien (siege): ArdentlyGnarly, gaim_proxy_connect's docs lie (14:28:36) Christopher O'Brien (siege): it doesn't return a fd (14:28:52) Christopher O'Brien (siege): it returns a status code ... (14:37:58) rlaager: siege, ArdentlyGnarly: We should correct the docs for gaim_proxy_connect... how does this sound? "@return zero for success, any other value for failure" ... (14:39:22) Jonathan Clark (ArdentlyGnarly): we really don't know whether or not the call was successful at the time it returns (14:39:55) Jonathan Clark (ArdentlyGnarly): we get that information when things get back around to the callback passed to gaim_proxy_connect (14:42:08) Jonathan Clark (ArdentlyGnarly): perhaps: @return zero indicates connection is pending, any other value for failure committer: Tailor Script <[e-mail]>

11210:5ba038e1b21f

 * @param host    The destination host.
 * @param port    The destination port.
 * @param func    The input handler function.
 * @param data    User-defined data.
 *
 * @return The socket handle.
 */
int gaim_proxy_connect(GaimAccount *account, const char *host, int port,
					   GaimInputFunction func, gpointer data);

/**

 * @param host    The destination host.
 * @param port    The destination port.
 * @param func    The input handler function.
 * @param data    User-defined data.
 *
 * @return The socket handle.
 */
int gaim_proxy_connect_socks5(GaimProxyInfo *gpi, const char *host, int port,
					   GaimInputFunction func, gpointer data);

/*@}*/

11211:03a244acce57

 * @param host    The destination host.
 * @param port    The destination port.
 * @param func    The input handler function.
 * @param data    User-defined data.
 *
 * @return Zero indicates the connection is pending. Any other value indicates failure.
 */
int gaim_proxy_connect(GaimAccount *account, const char *host, int port,
					   GaimInputFunction func, gpointer data);

/**

 * @param host    The destination host.
 * @param port    The destination port.
 * @param func    The input handler function.
 * @param data    User-defined data.
 *
 * @return Zero indicates the connection is pending. Any other value indicates failure.
 */
int gaim_proxy_connect_socks5(GaimProxyInfo *gpi, const char *host, int port,
					   GaimInputFunction func, gpointer data);

/*@}*/