Threading

Module used to create and manipulate threads. Threads let you execute time-consuming tasks without blocking current execution thread.

Index

Interfaces

• ErrorMessageFormatFunction

Variables

• threads

Functions

• formatFatalErrorMessage
• getThread
• initThread

Interfaces

ErrorMessageFormatFunction

• ErrorMessageFormatFunction(error: any, priority: number): string

• Parameters

  • error: any

    java.lang.Throwable instance or javascript exception

  • priority: number

    current thread priority

  Returns string

Variables

constthreads

internal

threads: {}

Running threads, use Threading.getThread to directly access required thread by name.

---

Type declaration

• [name string]: java.lang.Thread

Functions

formatFatalErrorMessage

• formatFatalErrorMessage(error: any, name: string, priority: number, formatFunc: ErrorMessageFormatFunction): string

• internal

  Function used to create formatted error message with the full debug information about exception in one of the threads.

  ---

  Parameters

  • error: any

    java.lang.Throwable instance or javascript exception

  • name: string

    thread name used to localize errors if there are any

  • priority: number

    current thread priority

  • formatFunc: ErrorMessageFormatFunction

    function that formats the exception itself

  Returns string

getThread

• getThread(name: string): Nullable<java.lang.Thread>

• Gets thread by it's name.

  ---

  Parameters

  • name: string

    name of the thread

  Returns Nullable<java.lang.Thread>

  Instance representing the thread.

initThread

• initThread(name: string, func: () => void, priority?: number, isErrorFatal?: boolean, formatFunc?: ErrorMessageFormatFunction): java.lang.Thread

• Creates and runs new thread with specified function as a task.

  ---

  Parameters

  • name: string

    thread name used to localize errors if there are any

  • func: () => void

    function that runs in the new thread. Usually it is some time-consuming task, that is executed in the new thread to avoid blocking user interfaces

  • optionalpriority: number

    priority of the thread (integer value). The higher priority is, the quicker the task will be executed. Default value is 0

  • optionalisErrorFatal: boolean

    if true, all errors in the thread are considered fatal and lead to fatal error AlertDialog, formatted with formatFunc

  • optionalformatFunc: ErrorMessageFormatFunction

    function that formats exceptions in the thread to display in fatal error AlertDialog

  Returns java.lang.Thread

  Instance representing created thread.