diff options
| author | Richard Jones <rjones@redhat.com> | 2010-09-09 13:52:48 +0100 |
|---|---|---|
| committer | Richard Jones <rjones@redhat.com> | 2010-09-09 13:52:48 +0100 |
| commit | b1454e38987473c94f20b10061031f2abe5a69a0 (patch) | |
| tree | 453fdf40f6d90f5b2756a131a87c8a307e1e0ad2 /src | |
| parent | e2ef068cb7d18f0c0d4931f97332a38ea4ea2477 (diff) | |
| download | libguestfs-b1454e38987473c94f20b10061031f2abe5a69a0.tar.gz libguestfs-b1454e38987473c94f20b10061031f2abe5a69a0.tar.xz libguestfs-b1454e38987473c94f20b10061031f2abe5a69a0.zip | |
guestfs: Document progress notification messages in protocol.
Diffstat (limited to 'src')
| -rw-r--r-- | src/guestfs.pod | 14 |
1 files changed, 14 insertions, 0 deletions
diff --git a/src/guestfs.pod b/src/guestfs.pod index 43b74603..97b92824 100644 --- a/src/guestfs.pod +++ b/src/guestfs.pod @@ -1526,6 +1526,20 @@ When the daemon launches it sends an initial word (C<GUESTFS_LAUNCH_FLAG>) which indicates that the guest and daemon is alive. This is what L</guestfs_launch> 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<GUESTFS_PROGRESS_FLAG>, followed by a fixed size progress message. + +The library turns them into progress callbacks (see +C<guestfs_set_progress_callback>) if there is a callback registered, +or discards them if not. + +The daemon self-limits the frequency of progress messages it sends +(see C<daemon/proto.c:notify_progress>). Not all calls generate +progress messages. + =head1 MULTIPLE HANDLES AND MULTIPLE THREADS All high-level libguestfs actions are synchronous. If you want |