[Spice-commits] src/spice-session.c

[Marc-André Lureau]

 src/spice-session.c |    6 +++++-
 1 file changed, 5 insertions(+), 1 deletion(-)

New commits:
commit 998b07746e0d37b87128b45aa8b4a74d070b2f3c
Author: Marc-André Lureau <marcandre.lureau at redhat.com>
Date:   Fri Aug 21 14:02:18 2015 +0200

    session: update spice_session_connect() doc
    
    Update the documentation about the return value, and how to watch for
    connection success.
    
    Releated to:
    https://bugzilla.redhat.com/show_bug.cgi?id=1253848

diff --git a/src/spice-session.c b/src/spice-session.c
index d768796..887b066 100644
--- a/src/spice-session.c
+++ b/src/spice-session.c
@@ -1547,7 +1547,11 @@ SpiceSession *spice_session_new_from_session(SpiceSession *session)
  * Open the session using the #SpiceSession:host and
  * #SpiceSession:port.
  *
- * Returns: %FALSE if the connection failed.
+ * Returns: %FALSE if the session state is invalid for connection
+ * request. %TRUE if the connection is initiated. To know whether the
+ * connection is established, you must watch for channels creation
+ * (#SpiceSession::channel-new) and the channels state
+ * (#SpiceChannel::channel-event).
  **/
 gboolean spice_session_connect(SpiceSession *session)
 {