com.tplan.robot.remoteclient.capabilities

Interface AtomicIOCapable

public interface AtomicIOCapable

Methods of a client in need to be notified of atomic mouse and keyboard operations such as click or typing of character or press and release of a key.

Since:

7.2.4

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

Method Summary

Modifier and Type	Method and Description
void	setAtomicKeyboardOperationFinished() Notify the client that the previously started atomic keyboard operation has finished.
void	setAtomicKeyboardOperationStarting(long maxDuration) Notify the client that an atomic keyboard operation which is not to be interrupted by an asynchronous event is about to start.
void	setAtomicMouseOperationFinished() Notify the client that the previously started atomic mouse operation has finished.
void	setAtomicMouseOperationStarting(long maxDuration) Notify the client that an atomic mouse operation which is not to be interrupted by an asynchronous event is about to start.

Method Detail

setAtomicKeyboardOperationStarting

void setAtomicKeyboardOperationStarting(long maxDuration)

Notify the client that an atomic keyboard operation which is not to be interrupted by an asynchronous event is about to start.

Parameters:

maxDuration - optional maximum duration to stay away from asynchronous events. This can be used as a safety measure should the automation fail to reset the status through a call of setAtomicKeyboardOperationFinished(). A value of 0 or lower means that the client should always wait until it gets notified of the operation end.

setAtomicKeyboardOperationFinished

void setAtomicKeyboardOperationFinished()

Notify the client that the previously started atomic keyboard operation has finished.

setAtomicMouseOperationStarting

void setAtomicMouseOperationStarting(long maxDuration)

Notify the client that an atomic mouse operation which is not to be interrupted by an asynchronous event is about to start.

Parameters:

maxDuration - optional maximum duration to stay away from asynchronous events. This can be used as a safety measure should the automation fail to reset the status through a call of setAtomicMouseOperationFinished(). A value of 0 or lower means that the client should always wait until it gets notified of the operation end.

setAtomicMouseOperationFinished

void setAtomicMouseOperationFinished()

Notify the client that the previously started atomic mouse operation has finished.