Package com.perforce.p4java.impl.mapbased.rpc.func.client

Class ClientProgressReport

java.lang.Object

com.perforce.p4java.impl.mapbased.rpc.func.client.ClientProgressReport

public class ClientProgressReport
extends java.lang.Object

Report the progress of the command tick by tick.

Field Summary

Fields

Modifier and Type	Field	Description
protected RpcServer	server
static java.lang.String	TRACE_PREFIX

Constructor Summary

Constructors

Constructor	Description
ClientProgressReport(RpcServer server)

Method Summary

Modifier and Type	Method	Description
boolean	report(IProgressCallback progressCallback, int cmdCallBackKey, RpcFunctionSpec funcSpec, CommandEnv cmdEnv, java.util.Map<java.lang.String,java.lang.Object> resultsMap)	Do a quick and dirty probabilistic progress report.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

TRACE_PREFIX

public static final java.lang.String TRACE_PREFIX

See Also:

Constant Field Values

server

protected RpcServer server

Constructor Detail

ClientProgressReport

public ClientProgressReport(RpcServer server)

Method Detail

report

public boolean report(IProgressCallback progressCallback,
                      int cmdCallBackKey,
                      RpcFunctionSpec funcSpec,
                      CommandEnv cmdEnv,
                      java.util.Map<java.lang.String,java.lang.Object> resultsMap)

Do a quick and dirty probabilistic progress report. Does not try to be too clever, but it does need to know something about the calling context to be able to send something useful back. If the tick() callback is called, this will return whatever the tick call returned, otherwise it returns true (which is usually interpreted to mean "keep going"...

Parameters:

progressCallback - progressCallback

cmdCallBackKey - cmdCallBackKey

funcSpec - funcSpec

cmdEnv - cmdEnv

resultsMap - resultsMap

Returns:

ok