david.venhoff/QEMU-Nyx-fork
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

io: improve docs for QIOChannelSocket async functions

Browse Source 
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>
This commit is contained in:
Daniel P. Berrange 2016-02-03 13:47:36 +00:00
parent a5af12871f
commit fe81e932ec
1 changed files with 9 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
include/io/channel-socket.h
View File

@ -105,7 +105,9 @@ int qio_channel_socket_connect_sync(QIOChannelSocket *ioc,
* Attempt to connect to the address @addr. This method * Attempt to connect to the address @addr. This method
* will run in the background so the caller will regain * will run in the background so the caller will regain
* execution control immediately. The function @callback * 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, void qio_channel_socket_connect_async(QIOChannelSocket *ioc,
SocketAddress *addr, SocketAddress *addr,
@ -140,7 +142,9 @@ int qio_channel_socket_listen_sync(QIOChannelSocket *ioc,
* Attempt to listen to the address @addr. This method * Attempt to listen to the address @addr. This method
* will run in the background so the caller will regain * will run in the background so the caller will regain
* execution control immediately. The function @callback * 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, void qio_channel_socket_listen_async(QIOChannelSocket *ioc,
SocketAddress *addr, SocketAddress *addr,
@ -181,6 +185,9 @@ int qio_channel_socket_dgram_sync(QIOChannelSocket *ioc,
* This method will run in the background so the caller * This method will run in the background so the caller
* will regain execution control immediately. The function * will regain execution control immediately. The function
* @callback will be invoked on completion or failure. * @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, void qio_channel_socket_dgram_async(QIOChannelSocket *ioc,
SocketAddress *localAddr, SocketAddress *localAddr,