public interface ProgressMonitor
ConnectionConfig
to receive feedback on LiveViewConnectionFactory.getConnection(ConnectionConfig)
.
It also enables the client to ProgressMonitor.cancel()
the connection request.
Modifier and Type | Field and Description |
---|---|
static int |
UNKNOWN
Constant indicating an unknown amount of work.
|
Modifier and Type | Method and Description |
---|---|
void |
beginTask(java.lang.String name,
int totalWork)
The server reports to the monitor at the beginning of a task
|
void |
cancel()
The client can cancel the current request
|
void |
done()
The server calls this on completion of the task
|
boolean |
isCanceled()
The api will use this call to see if the client cancelled the current request
|
void |
subTask(java.lang.String name)
The server calls this with the name of sub tasks
|
void |
worked(int work)
The server reports incremental units complete on the current task
|
static final int UNKNOWN
void cancel()
boolean isCanceled()
void beginTask(java.lang.String name, int totalWork)
name
- the name of the tasktotalWork
- the total steps to complete the taskvoid done()
void subTask(java.lang.String name)
void worked(int work)
work
- the amount done on the current task