From 136055024e8043911cfe4436f8a3e1cac9a3623b Mon Sep 17 00:00:00 2001 From: Dmitry Podgorny Date: Wed, 14 Sep 2016 17:49:10 +0300 Subject: [PATCH] conn: update documentation for xmpp_connect_raw() --- src/conn.c | 14 ++++++++------ 1 file changed, 8 insertions(+), 6 deletions(-) diff --git a/src/conn.c b/src/conn.c index 8b5fdca..ffac5d3 100644 --- a/src/conn.c +++ b/src/conn.c @@ -528,17 +528,19 @@ int xmpp_connect_component(xmpp_conn_t * const conn, const char * const server, /** Initiate a raw connection to the XMPP server. * Arguments and behaviour of the function are similar to - * xmpp_connect_client(), but it skips authentication process. Instead, - * the user's callback is called with event XMPP_CONN_RAW_CONNECT as soon - * as tcp connection is established. + * xmpp_connect_client(), but it skips authentication process. In opposite to + * xmpp_connect_client() during connection process two events are generated + * instead of one. User's callback is called with event XMPP_CONN_RAW_CONNECT + * when the TCP connection with the server is established. At this point user + * might want to open an XMPP stream with xmpp_conn_open_stream() or establish + * TLS session with xmpp_conn_tls_start(). Event XMPP_CONN_CONNECT is generated + * when the XMPP stream is opened successfully and user may send stanzas over + * the connection. * * This function doesn't use password nor node part of a jid. Therefore, * the only required configuration is a domain (or full jid) passed via * xmpp_conn_set_jid(). * - * Next step should be xmpp_conn_open_stream(). In case of legacy SSL, - * user might want to call xmpp_conn_tls_start() before opening the stream. - * * @see xmpp_connect_client() * * @return XMPP_EOK (0) on success a number less than 0 on failure