From b1454e38987473c94f20b10061031f2abe5a69a0 Mon Sep 17 00:00:00 2001 From: Richard Jones Date: Thu, 9 Sep 2010 13:52:48 +0100 Subject: [PATCH] guestfs: Document progress notification messages in protocol. --- src/guestfs.pod | 14 ++++++++++++++ 1 file changed, 14 insertions(+) diff --git a/src/guestfs.pod b/src/guestfs.pod index 43b7460..97b9282 100644 --- a/src/guestfs.pod +++ b/src/guestfs.pod @@ -1526,6 +1526,20 @@ When the daemon launches it sends an initial word (C) which indicates that the guest and daemon is alive. This is what L waits for. +=head3 PROGRESS NOTIFICATION MESSAGES + +The daemon may send progress notification messages at any time. These +are distinguished by the normal length word being replaced by +C, followed by a fixed size progress message. + +The library turns them into progress callbacks (see +C) if there is a callback registered, +or discards them if not. + +The daemon self-limits the frequency of progress messages it sends +(see C). Not all calls generate +progress messages. + =head1 MULTIPLE HANDLES AND MULTIPLE THREADS All high-level libguestfs actions are synchronous. If you want -- 1.8.3.1