diff options
| author | Lukas Straub <lukasstraub2@web.de> | 2020-12-28 16:08:59 +0100 |
|---|---|---|
| committer | Markus Armbruster <armbru@redhat.com> | 2021-01-13 10:21:17 +0100 |
| commit | 8659f317d3303092d8e534eeefd160aa5ead9aab (patch) | |
| tree | 620f659b7f3dc7b2e61e21f3997bda405f877e7d /include/io | |
| parent | e4d2bfb1700db663ddda448368f06570f7f81970 (diff) | |
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>
Diffstat (limited to 'include/io')
| -rw-r--r-- | include/io/channel.h | 5 |
1 files changed, 4 insertions, 1 deletions
diff --git a/include/io/channel.h b/include/io/channel.h index 4d6fe45f63..ab9ea77959 100644 --- a/include/io/channel.h +++ b/include/io/channel.h @@ -92,7 +92,8 @@ struct QIOChannel { * provide additional optional features. * * 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 { ObjectClass parent; @@ -510,6 +511,8 @@ int qio_channel_close(QIOChannel *ioc, * QIO_CHANNEL_FEATURE_SHUTDOWN prior to calling * this method. * + * This function is thread-safe, terminates quickly and does not block. + * * Returns: 0 on success, -1 on error */ int qio_channel_shutdown(QIOChannel *ioc, |