Procedure GMP::SolverSession::Interrupt(solverSession, timeout)

GMP::SolverSession::Interrupt

The procedure GMP::SolverSession::Interrupt interrupts a solver session that is (asynchronous) executing.

GMP::SolverSession::Interrupt(
     solverSession,    ! (input) a solver session
     [timeout]         ! (optional) timeout interval
     )

Arguments

solverSession

An element in the set AllSolverSessions.

timeout

A scalar value indicating the time-out interval (in seconds). The default value is 600.

Return Value

The procedure returns 1 on success, or 0 otherwise.

Note

  • This interrupt procedure will wait until the solver session is successfully interrupted or the time-out interval elapses.

  • This procedure can also be called for a solver session that is not asynchronous executing. In that case the timeout argument will be ignored.

See also

The routines GMP::SolverSession::AsynchronousExecute, GMP::SolverSession::ExecutionStatus, GMP::SolverSession::Interrupt, GMP::SolverSession::WaitForCompletion and GMP::SolverSession::WaitForSingleCompletion.