com.tplan.robot.remoteclient.capabilities

Interface PoolingCapable

public interface PoolingCapable

This interface declares that it makes sense to pool the client connection in order to be reused by other scripts.

Connection pooling can be switched on through RemoteDesktopClientFactory.setReuseClients(boolean). When the mode is on, clients released by test scripts are not disconnected and they are rather put into the connection pool where they can be picked up by newly connecting test scripts. This leads to performance improvements especially where the connecting sequence is long and spends too much time (such as RFB/VNC or RDP).

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

Method Summary

Modifier and Type	Method and Description
void	clientPooled() This method is called when the client is pooled and made ready for reuse.
void	clientReused() This method is called when the client is picked up from the pool by a new test scripts.
boolean	isPoolingCapable() Define whether the client can be pooled at the moment or not.

Method Detail

isPoolingCapable

boolean isPoolingCapable()

Define whether the client can be pooled at the moment or not. Though most implementations will always return true, the method allows to disable pooling based on dynamic factors. Note that this method is checked by the connection pool only when the client is about to be pooled and it has no effect on clients which are already in the pool.

Returns:

boolean if the object is momentarily suitable for pooling, false if not.

clientPooled

void clientPooled()

This method is called when the client is pooled and made ready for reuse. The client is expected to fire a RemoteDesktopServerEvent event to notify its listeners that the connection was pooled.

clientReused

void clientReused()

This method is called when the client is picked up from the pool by a new test scripts. This method allows the client to do anything necessary, for example refresh the screen image or check for updates.