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

[Zeeshan Ali]

 gtk/spice-session.c |   10 +++++++++-
 1 file changed, 9 insertions(+), 1 deletion(-)

New commits:
commit eb793290b208e92b31b7f4d8ccde0a0b5caa508c
Author: Zeeshan Ali (Khattak) <zeeshanak at gnome.org>
Date:   Wed Nov 19 12:29:42 2014 +0000

    session: Improved docs for spice_session_connect()
    
    Make it clear that users of this function must provide additional
    sockets for individual channels.

diff --git a/gtk/spice-session.c b/gtk/spice-session.c
index 7971f3c..d7f014c 100644
--- a/gtk/spice-session.c
+++ b/gtk/spice-session.c
@@ -1434,8 +1434,16 @@ gboolean spice_session_connect(SpiceSession *session)
  * descriptor. This is useful if you create the fd yourself, for
  * example to setup a SSH tunnel.
  *
+ * Note however that additional sockets will be needed by all the channels
+ * created for @session so users of this API should hook into
+ * SpiceChannel::open-fd signal for each channel they are interested in, and
+ * create and pass a new socket to the channel using #spice_channel_open_fd, in
+ * the signal callback.
+ *
  * If @fd is -1, a valid fd will be requested later via the
- * SpiceChannel::open-fd signal.
+ * SpiceChannel::open-fd signal. Typically, you would want to just pass -1 as
+ * @fd this call since you will have to hook to SpiceChannel::open-fd signal
+ * anyway.
  *
  * Returns:
  **/