summary refs log tree commit diff stats
path: root/include/io/channel-socket.h
diff options
context:
space:
mode:
authorPeter Maydell <peter.maydell@linaro.org>2016-02-16 15:47:35 +0000
committerPeter Maydell <peter.maydell@linaro.org>2016-02-16 15:47:35 +0000
commit250f53ddaac3211990fb20ced3c46d2338e195e3 (patch)
treea63512b4b83c92e9ccf688b2e57a0cec4d6a46de /include/io/channel-socket.h
parentd5db2ec1774642db7febda0fba1cb3d0b9ef7236 (diff)
parente8f117f3b3eb41a766d38e0b765f89ec79c6a9ff (diff)
downloadfocaccia-qemu-250f53ddaac3211990fb20ced3c46d2338e195e3.tar.gz
focaccia-qemu-250f53ddaac3211990fb20ced3c46d2338e195e3.zip
Merge remote-tracking branch 'remotes/berrange/tags/pull-io-next-2016-02-16-1' into staging
Merge I/O fixes 2016/02/16 v1

# gpg: Signature made Tue 16 Feb 2016 15:42:29 GMT using RSA key ID 15104FDF
# gpg: Good signature from "Daniel P. Berrange <dan@berrange.com>"
# gpg:                 aka "Daniel P. Berrange <berrange@redhat.com>"

* remotes/berrange/tags/pull-io-next-2016-02-16-1:
  io: convert QIOChannelBuffer to use uint8_t instead of char
  io: introduce helper for creating channels from file descriptors
  io: improve docs for QIOChannelSocket async functions

Signed-off-by: Peter Maydell <peter.maydell@linaro.org>
Diffstat (limited to 'include/io/channel-socket.h')
-rw-r--r--include/io/channel-socket.h11
1 files changed, 9 insertions, 2 deletions
diff --git a/include/io/channel-socket.h b/include/io/channel-socket.h
index 810537ef6f..70d06b40d9 100644
--- a/include/io/channel-socket.h
+++ b/include/io/channel-socket.h
@@ -105,7 +105,9 @@ int qio_channel_socket_connect_sync(QIOChannelSocket *ioc,
  * Attempt to connect to the address @addr. This method
  * will run in the background so the caller will regain
  * execution control immediately. The function @callback
- * will be invoked on completion or failure.
+ * will be invoked on completion or failure. The @addr
+ * parameter will be copied, so may be freed as soon
+ * as this function returns without waiting for completion.
  */
 void qio_channel_socket_connect_async(QIOChannelSocket *ioc,
                                       SocketAddress *addr,
@@ -140,7 +142,9 @@ int qio_channel_socket_listen_sync(QIOChannelSocket *ioc,
  * Attempt to listen to the address @addr. This method
  * will run in the background so the caller will regain
  * execution control immediately. The function @callback
- * will be invoked on completion or failure.
+ * will be invoked on completion or failure. The @addr
+ * parameter will be copied, so may be freed as soon
+ * as this function returns without waiting for completion.
  */
 void qio_channel_socket_listen_async(QIOChannelSocket *ioc,
                                      SocketAddress *addr,
@@ -181,6 +185,9 @@ int qio_channel_socket_dgram_sync(QIOChannelSocket *ioc,
  * This method will run in the background so the caller
  * will regain execution control immediately. The function
  * @callback will be invoked on completion or failure.
+ * The @localAddr and @remoteAddr parameters will be copied,
+ * so may be freed as soon as this function returns without
+ * waiting for completion.
  */
 void qio_channel_socket_dgram_async(QIOChannelSocket *ioc,
                                     SocketAddress *localAddr,