devs/libstrophe-gh
2
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

conn: update documentation for xmpp_connect_raw()

Browse Source
This commit is contained in:
Dmitry Podgorny
2016-09-14 17:49:10 +03:00
parent 8d3f3d837a
commit 136055024e
1 changed files with 8 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

14
src/conn.c
View File

@@ -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. /** Initiate a raw connection to the XMPP server.
* Arguments and behaviour of the function are similar to * Arguments and behaviour of the function are similar to
* xmpp_connect_client(), but it skips authentication process. Instead, * xmpp_connect_client(), but it skips authentication process. In opposite to
* the user's callback is called with event XMPP_CONN_RAW_CONNECT as soon * xmpp_connect_client() during connection process two events are generated
* as tcp connection is established. * 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, * 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 * the only required configuration is a domain (or full jid) passed via
* xmpp_conn_set_jid(). * 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() * @see xmpp_connect_client()
* *
* @return XMPP_EOK (0) on success a number less than 0 on failure * @return XMPP_EOK (0) on success a number less than 0 on failure