aboutsummaryrefslogtreecommitdiff
path: root/include
diff options
context:
space:
mode:
authorJohn Levon <john.levon@nutanix.com>2021-09-27 13:26:52 +0100
committerGitHub <noreply@github.com>2021-09-27 13:26:52 +0100
commit2cc236ee84ed70a6df421e5352994ac4eb03de21 (patch)
treee43843fc34e6e8d496160e939cbefc1066ad759d /include
parentd12584bf8c726a1907655f03e5a18b549599da41 (diff)
downloadlibvfio-user-2cc236ee84ed70a6df421e5352994ac4eb03de21.zip
libvfio-user-2cc236ee84ed70a6df421e5352994ac4eb03de21.tar.gz
libvfio-user-2cc236ee84ed70a6df421e5352994ac4eb03de21.tar.bz2
clarify LIBVFIO_USER_FLAG_ATTACH_NB behavior (#603)
Signed-off-by: John Levon <john.levon@nutanix.com> Reviewed-by: Swapnil Ingle <swapnil.ingle@nutanix.com>
Diffstat (limited to 'include')
-rw-r--r--include/libvfio-user.h4
1 files changed, 4 insertions, 0 deletions
diff --git a/include/libvfio-user.h b/include/libvfio-user.h
index a4d8105..8a4bfe7 100644
--- a/include/libvfio-user.h
+++ b/include/libvfio-user.h
@@ -81,6 +81,10 @@ dma_sg_size(void);
* Attaching to the transport is non-blocking.
* The caller must then manually call vfu_attach_ctx(),
* which is non-blocking, as many times as necessary.
+ *
+ * This also applies to vfu_run_ctx(). However, it's presumed that any actual
+ * reads or writes of the socket connection will not need to block, since both
+ * APIS are synchronous.
*/
#define LIBVFIO_USER_FLAG_ATTACH_NB (1 << 0)