com.kapowtech.robosuite.api.java.rest

Interface Stoppable

All Known Implementing Classes:

QueuedRequestRunner

public interface Stoppable

An object that allows you to stop a robot that is executing.

See Also:

RobotResponseHandler.handleError(ApiException, Stoppable)

Method Summary

Modifier and Type	Method and Description
void	stop() Sends the stop request.

Method Detail

stop

void stop()
   throws ApiException

Sends the stop request. The server will try to stop the robot ASAP, however since the server doesn't send a response when stop is requested, the only way to know if the robot has actually stopped, is to ping the server, and check if the robots execution id has been removed from the set of executing robots.

Throws:

ApiException - if a connection to the server could not be obtained