diff options
| author | Daniel P. Berrange <berrange@redhat.com> | 2016-02-03 13:47:36 +0000 |
|---|---|---|
| committer | Daniel P. Berrange <berrange@redhat.com> | 2016-02-15 14:48:25 +0000 |
| commit | fe81e932ec0d25157abbe5e7ebcb50493e61a4d6 (patch) | |
| tree | 2f79d0905363fa70859e22f1ea58899c26eae085 /include/io/channel-socket.h | |
| parent | a5af12871fd4601c44f08d9e49131e9ca13ef102 (diff) | |
io: improve docs for QIOChannelSocket async functions
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.
Reviewed-by: "Dr. David Alan Gilbert" <dgilbert@redhat.com>
Signed-off-by: Daniel P. Berrange <berrange@redhat.com>
Diffstat (limited to 'include/io/channel-socket.h')
| -rw-r--r-- | include/io/channel-socket.h | 11 |
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, |