ShuriZma
/
xemu
mirror of https://github.com/xemu-project/xemu.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

io: Document qmp oob suitability of qio_channel_shutdown and io_shutdown 

Migration and yank code assume that qio_channel_shutdown is thread
-safe and can be called from qmp oob handler. Document this after
checking the code.

Signed-off-by: Lukas Straub <lukasstraub2@web.de>
Acked-by: Stefan Hajnoczi <stefanha@redhat.com>
Reviewed-by: Daniel P. Berrangé <berrange@redhat.com>
Message-Id: <32b8c27e256da043f0f00db05bd7ab8fbc506070.1609167865.git.lukasstraub2@web.de>
Signed-off-by: Markus Armbruster <armbru@redhat.com>
This commit is contained in:
Lukas Straub 2020-12-28 16:08:59 +01:00 committed by Markus Armbruster
parent e4d2bfb170
commit 8659f317d3
1 changed files with 4 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
include/io/channel.h
View File

@ -92,7 +92,8 @@ struct QIOChannel {
* provide additional optional features. * provide additional optional features.
* *
* Consult the corresponding public API docs for a description * Consult the corresponding public API docs for a description
* of the semantics of each callback * of the semantics of each callback. io_shutdown in particular
* must be thread-safe, terminate quickly and must not block.
*/ */
struct QIOChannelClass { struct QIOChannelClass {
ObjectClass parent; ObjectClass parent;
@ -510,6 +511,8 @@ int qio_channel_close(QIOChannel *ioc,
* QIO_CHANNEL_FEATURE_SHUTDOWN prior to calling * QIO_CHANNEL_FEATURE_SHUTDOWN prior to calling
* this method. * this method.
* *
* This function is thread-safe, terminates quickly and does not block.
*
* Returns: 0 on success, -1 on error * Returns: 0 on success, -1 on error
*/ */
int qio_channel_shutdown(QIOChannel *ioc, int qio_channel_shutdown(QIOChannel *ioc,