com.tplan.robot.remoteclient.capabilities

Interface ResourceOptimizationCapable

public interface ResourceOptimizationCapable

Methods of a desktop client which needs to optimize image operations.

Since:

7.2.3

T-Plan Robot Enterprise, (C) 2009-2025 T-Plan Limited. All rights reserved.

Method Summary

Modifier and Type	Method and Description
BufferedImage	getImage(Rectangle bounds, long maxAgeMs, boolean cachedOnly) Get a current or recently created desktop image or its part.
long	getLastImageRetrieveDurationMs() Get duration of the last image retrieval.
boolean	isGetImagePerformanceIntensive() Indicates whether image retrieval is resource/performance intensive and should be optimized by low priority processes such as for example report generators etc.
boolean	isResourceIntensiveOperationInProgress() Indicates whether a resource intensive operation is in progress.
void	setIntensiveOperationInProgress(boolean inProgress, String source) Notify the client that a resource intensive operation is about to start or finish.

Method Detail

getImage

BufferedImage getImage(Rectangle bounds,
                       long maxAgeMs,
                       boolean cachedOnly)

Get a current or recently created desktop image or its part.

Parameters:

bounds - the image bounds or null to get the full screen image.

maxAgeMs - maximum age of the eventual cached image.

cachedOnly - use true to return the cached image only or null if it is not available. The value of false will force creation of a new image if there's no cached one.

Returns:

the desktop image.

Since:

7.2.3

isGetImagePerformanceIntensive

boolean isGetImagePerformanceIntensive()

Indicates whether image retrieval is resource/performance intensive and should be optimized by low priority processes such as for example report generators etc.

Returns:

true if getting the image is a costly operation or false otherwise.

Since:

7.2.3

getLastImageRetrieveDurationMs

long getLastImageRetrieveDurationMs()

Get duration of the last image retrieval.

Returns:

the duration in millis or a negative number if the value is not available.

Since:

7.2.3

setIntensiveOperationInProgress

void setIntensiveOperationInProgress(boolean inProgress,
                                     String source)

Notify the client that a resource intensive operation is about to start or finish. This method is reserved for hight priority processes such as for example the WaitFor automation command. Other lower priority processes such as report generators are then expected to check the status via isResourceIntensiveOperationInProgress() and avoid other resource intensive tasks while an operation is in progress.

Parameters:

inProgress - true/false to indicate that an image intensive operation is about to start/finish.

source - optional source or reason. It is only used for debugging of who set the mode.

Since:

7.2.3

isResourceIntensiveOperationInProgress

boolean isResourceIntensiveOperationInProgress()

Indicates whether a resource intensive operation is in progress. See setIntensiveOperationInProgress(boolean, String) for details.

Returns:

true/false if a resource intensive operation is in progress.

Since:

7.2.3