Skip to content

interrupt_operatorInterruptOperatorInterruptOperatorinterrupt_operatorinterrupt_operator🔗

Short description🔗

interrupt_operatorInterruptOperatorInterruptOperatorinterrupt_operatorinterrupt_operator — Attempt to interrupt an operator running in a different thread.

Signature🔗

interrupt_operator( integer HThreadID, string Mode )void InterruptOperator( const HTuple& HThreadID, const HTuple& Mode )static void HOperatorSet.InterruptOperator( HTuple HThreadID, HTuple mode )def interrupt_operator( hthread_id: int, mode: str ) -> None

Herror interrupt_operator( const Hlong HThreadID, const char* Mode )

Herror T_interrupt_operator( const Htuple HThreadID, const Htuple Mode )

static void HSystem::InterruptOperator( Hlong HThreadID, const HString& Mode )

static void HSystem::InterruptOperator( Hlong HThreadID, const char* Mode )

static void HSystem::InterruptOperator( Hlong HThreadID, const wchar_t* Mode ) (Windows only)

static void HSystem.InterruptOperator( int HThreadID, string mode )

Description🔗

interrupt_operatorInterruptOperator attempts to gracefully interrupt the operator currently running in the HALCON thread represented by HThreadIDHThreadIDhthread_id. If that currently running operator supports interruption, it will abort its execution depending on Modemodemode (see below). If the thread is currently not executing any operator, or if the currently running operator does not support interruptions, interrupt_operatorInterruptOperator is a no-op. The execution of any future operator in the other thread is not affected.

The ID representing a thread can be obtained with get_current_hthread_idGetCurrentHthreadId.

interrupt_operatorInterruptOperator supports currently only one type of interruption, which can be set in Modemodemode. Note that the corresponding type must also be supported by the operator currently running in the other thread. To determine if an operator is interruptible and which kind of interrupts it supports, please see the “Execution Information” section of the operator documentation or query the information using the parameter 'interrupt_mode'"interrupt_mode" of the operator get_operator_infoGetOperatorInfo.

Some operators, for which no interruptibility is mentioned in the reference documentation, can still be interrupted at some points of their execution. However, such interruptabilities are not guaranteed and can change without further notice between different versions of HALCON.

  • 'cancel'"cancel": Abort the execution of the operator. All results computed by the operator are discarded and the operator returns the error code H_ERR_CANCEL (22).

Attention🔗

Note that not all operators support interruption. If a given operator supports interruptions and which modes are supported is described in the execution information section of the reference documentation of the corresponding operator.

Also note that there is no hard guarantee about the granularity of the interruption. The granularity can depend on the operator, its input data and the speed of the device. It is typically finer than 10 ms.

Execution information🔗

Execution information

  • Multithreading type: reentrant (runs in parallel with non-exclusive operators).

  • Multithreading scope: global (may be called from any thread).

  • Processed without parallelization.

Parameters🔗

HThreadIDHThreadIDhthread_id (input_control) integer → (integer)HTuple (Hlong)HTuple (int / long)intHtuple (Hlong)

Thread that runs the operator to interrupt.

Modemodemode (input_control) string → (string)HTuple (HString)HTuple (string)strHtuple (char*)

Interruption mode.

Default: 'cancel'"cancel"
List of values: 'cancel'"cancel"

Example🔗

(HDevelop)

global tuple HThreadID
get_current_hthread_id (HThreadID)
* call some slow operator...

* In a different thread
wait_seconds(2)
* Interrupt the long-running operator in the other thread
interrupt_operator (HThreadID, 'cancel')

Result🔗

If all the operator parameters are valid, interrupt_operatorInterruptOperator returns 2 (H_MSG_TRUE). Otherwise an exception is raised.

Combinations with other operators🔗

Combinations

Possible predecessors

get_current_hthread_idGetCurrentHthreadId

Alternatives

set_operator_timeoutSetOperatorTimeout

See also

get_current_hthread_idGetCurrentHthreadId, set_operator_timeoutSetOperatorTimeout

Module🔗

Foundation