Class P4::Progress
Description
The P4::Progress class is a handler class that
provides access to progress indicators from the server. After defining
the output handler, set P4#progress() to an
instance of a subclass of P4::Progress (or use a
p4.with_progress( progress ) block) to enable
callbacks.
You must implement all five of the following methods:
init(), description(),
update(), total(), and
done(), even if the implementation consists of
trivially returning 0.
Class Methods
new P4::MyProgress.new -> aP4::Progress
Constructs a new subclass of P4::Progress.
Instance Methods
init -> int
Initialize progress indicator.
description -> int
Description and type of units to be used for progress reporting.
update -> int
If non-zero, user has requested a cancellation of the operation.
total -> int
Total number of units expected (if known).
done -> int
If non-zero, operation has failed.