[Qemu-devel] [PATCH] io: improve docs for QIOChannelSocket async functions

[Qemu-devel] [PATCH] io: improve docs for QIOChannelSocket async functions

[Daniel P. Berrange]

In the docs for qio_channel_socket_connect_async,
qio_channel_socket_listen_async and
qio_channel_socket_dgram_async, mention that the
SocketAddress parameters are copied, so can be freed
immediately.

Signed-off-by: Daniel P. Berrange <berrange@redhat.com>
---
 include/io/channel-socket.h | 11 +++++++++--
 1 file changed, 9 insertions(+), 2 deletions(-)

diff --git a/include/io/channel-socket.h b/include/io/channel-socket.h
index 810537e..70d06b4 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,
-- 
2.5.0

Re: [Qemu-devel] [PATCH] io: improve docs for QIOChannelSocket async functions

[Dr. David Alan Gilbert]

* Daniel P. Berrange (berrange@redhat.com) wrote:
> In the docs for qio_channel_socket_connect_async,
> qio_channel_socket_listen_async and
> qio_channel_socket_dgram_async, mention that the
> SocketAddress parameters are copied, so can be freed
> immediately.
> 
> Signed-off-by: Daniel P. Berrange <berrange@redhat.com>

Thanks,

Reviewed-by: Dr. David Alan Gilbert <dgilbert@redhat.com>

> ---
>  include/io/channel-socket.h | 11 +++++++++--
>  1 file changed, 9 insertions(+), 2 deletions(-)
> 
> diff --git a/include/io/channel-socket.h b/include/io/channel-socket.h
> index 810537e..70d06b4 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,
> -- 
> 2.5.0
> 
--
Dr. David Alan Gilbert / dgilbert@redhat.com / Manchester, UK