requestMonitorConnection

Start a monitor for the current host session. Assumes a human operator will be connecting using the Viewer Monitor application to monitor a test of the calling application.

bool HostScreen.requestMonitorConnection(String monitorName,
bool withRecording, int timeout);

Arguments

monitorName

The advertised name of the monitor. This name is used for a user at a Viewer Monitor application to create a connection and new monitor window to this session. If withRecording=true, this will also form the basis of the recording created.

withRecording

When true, a recording will be created and processed of the test session. The name of the recording will be based on the monitorName parameter.

timeout

Number of milliseconds to wait for the response from the monitor.

Returns

True if a monitor connected within the timeout period. False if no monitor connected.

Remarks

This activates a monitor for an application under test. While no exception will be thrown if no monitor connects, the false return value can be used to throw an exception and end a test.

Calling applications can also treat the connection by a monitor as optional, by checking the return value and not making any requestMonitorApproval calls. This would be a likely scenario for an application that has been tested but may still need a monitor under certain conditions.

Requirements

Flynet Viewer