BACKGROUNDHANDLERCOMMAND

Detailed Description

Enumerations

enum  BACKGROUNDHANDLERCOMMAND {
  ISRUNNING,
  STOP,
  START,
  REMOVE
}
 

Functions

enum BACKGROUNDHANDLERCOMMAND MAXON_ENUM_LIST (BACKGROUNDHANDLERCOMMAND)
 

Enumeration Type Documentation

◆ BACKGROUNDHANDLERCOMMAND

Enumerator
ISRUNNING 

Return true if the handler is currently running, otherwise false.

STOP 

Stop the current activity. Return true when the activity has stopped.

START 

Check if there is something to do. If not, return false. In case there is something to do, directly start this job and return true.
There is also the possibility to do a small job synchronously and return false (pretend as if nothing was started).

Note
As the background handler is processed in the main application thread this means that if you process something unthreaded, the complete application will be blocked.
For example some code that takes 10 seconds means that the user will not be able to click on any button or stop anything during that time.
That is why only extremely short tasks must be directly processed, otherwise start an asynchronous thread.
REMOVE 

The handler is being removed. Return true.

Function Documentation

◆ MAXON_ENUM_LIST()