Class Thread

Hierarchy

ThreadEventBus
- Thread

Index

Constructors

Constructors

constructor

new Thread(eventBus): Thread
Parameters
- eventBus: EventBus<ThreadEventType, ThreadEvent>
Returns Thread
Overrides ThreadEventBus.constructor
- Defined in dist/sdk/tmp-typedoc/framework-types/thread/Thread.d.ts:31

Properties

`Private` abortAndWaitForChildren

abortAndWaitForChildren: any

`Readonly` abortController

abortController: AbortController

`Protected` `Optional` abortable

abortable?: Abortable<unknown>

`Private` `Readonly` children

children: any

`Private` dispose

dispose: any

`Protected` `Readonly` eventBus

eventBus: EventBus<ThreadEventType, ThreadEvent>

`Private` `Readonly` executionDeferred

executionDeferred: any

`Private` getChildAbortables

getChildAbortables: any

`Private` handleError

handleError: any

`Readonly` id

id: string

`Private` `Readonly` removeAbortListener

removeAbortListener: any

`Private` removeChild

removeChild: any

`Private` threadState

threadState: any

`Private` waitForChildren

waitForChildren: any

Accessors

onExit

get onExit(): Deferred<void>
Returns Deferred<void>
- Defined in dist/sdk/tmp-typedoc/framework-types/thread/Thread.d.ts:32

state

get state(): ThreadState
Returns ThreadState
- Defined in dist/sdk/tmp-typedoc/framework-types/thread/Thread.d.ts:33

Methods

abort

abort(reason?): void
Parameters
- Optional reason: Error
Returns void
- Defined in dist/sdk/tmp-typedoc/framework-types/thread/Thread.d.ts:37

attach

attach(type, listener): (() => void)
Parameters
- type: ThreadEventType
- listener: Listener<ThreadEvent>
Returns (() => void)
- - (): void
  - Returns void
Inherited from ThreadEventBus.attach
- Defined in dist/sdk/tmp-typedoc/framework-types/thread/ThreadEventBus.d.ts:20

createChild

createChild(name, handleError?): Thread
Parameters
- name: string
- Optional handleError: ((error) => boolean)
  - - (error): boolean
    - Parameters
      
      error: Error
      
      Returns boolean
Returns Thread
- Defined in dist/sdk/tmp-typedoc/framework-types/thread/Thread.d.ts:34

disposeEventBus

disposeEventBus(): void
Returns void
Inherited from ThreadEventBus.disposeEventBus
- Defined in dist/sdk/tmp-typedoc/framework-types/thread/ThreadEventBus.d.ts:21

fork

fork<CTX, ForkedTask>(context, task, parameter): Abortable<TaskReturn<ForkedTask>>
Type Parameters
- CTX extends ExecutionContext<any, any, CTX>
- ForkedTask extends NamedTask<Task<CTX, any, any>>
Parameters
- context: CTX
- task: ForkedTask
- parameter: TaskParam<ForkedTask>
Returns Abortable<TaskReturn<ForkedTask>>
- Defined in dist/sdk/tmp-typedoc/framework-types/thread/Thread.d.ts:38

framework-types
- abortable
  - Abortable.d.ts
    - Abortable
    - abortAndWaitForExit
    - forEach
    - isAbortable
    - linkAbortSignal
    - map
    - race
    - rejectAfter
    - resolveAfter
    - rightCompose
    - sequence
    - waitForExit
  - Types.d.ts
    - AbortableCreator
    - CheckChained
    - Head
    - Last
    - Tail
- api-manager
  - ApiManager.d.ts
    - ApiManager
    - Property
  - Errors.d.ts
    - ApiDisposedError
- data-structures
  - MapWithDefault.d.ts
    - MapWithDefault
  - Types.d.ts
    - GenericHashMap
- effect
  - EffectFactory.d.ts
    - createEffectFactory
  - Types.d.ts
    - AnyEffectFactory
    - EffectFactory
- effects
- error
  - FrameworkDisposedError.d.ts
    - FrameworkDisposedError
  - FrameworkError.d.ts
    - FrameworkError
- event-bus
  - EventBus.d.ts
    - EventBus
    - Detach
    - Listener
- execution-context
- package-api
- polyfills
- registry
  - Registry.d.ts
    - Registry
  - RegistryInterface.d.ts
    - RegistryInterface
    - Replacer
- task
  - Task.d.ts
    - bindTask
    - isTask
  - TaskUtils.d.ts
  - Types.d.ts
    - AnyContextTask
    - AnyNamedTask
    - AnyParameterTask
    - AnyTask
    - BoundTask
    - NamedTask
    - Task
    - TaskParam
    - TaskReturn
- thread
  - Thread.d.ts
  - ThreadEventBus.d.ts
- utils
  - debug
    - thread
      - ThreadDecorator.d.ts
        
        ThreadDebugDecorator
  - Awaitable.d.ts
    - Awaitable
  - Deferred.d.ts
    - Deferred
  - StringUtils.d.ts
    - generateId
- index.d.ts
  - WithBaseApi
  - framework
- BaseTypes.d.ts
- Types.d.ts
  - BaseContext
- framework.d.ts
  - WithBaseApi
  - framework
player-types

Class Thread

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

eventBus: EventBus<ThreadEventType, ThreadEvent>

Returns Thread

Properties

Private abortAndWaitForChildren

Readonly abortController

Protected Optional abortable

Private Readonly children

Private dispose

Protected Readonly eventBus

Private Readonly executionDeferred

Private getChildAbortables

Private handleError

Readonly id

Private Readonly removeAbortListener

Private removeChild

Private threadState

Private waitForChildren

Accessors

onExit

Returns Deferred<void>

state

Returns ThreadState

Methods

abort

Parameters

Optional reason: Error

Returns void

attach

Parameters

type: ThreadEventType

listener: Listener<ThreadEvent>

Returns (() => void)

Returns void

createChild

Parameters

name: string

Optional handleError: ((error) => boolean)

Parameters

error: Error

Returns boolean

Returns Thread

disposeEventBus

Returns void

fork

Type Parameters

CTX extends ExecutionContext<any, any, CTX>

ForkedTask extends NamedTask<Task<CTX, any, any>>

Parameters

context: CTX

task: ForkedTask

parameter: TaskParam<ForkedTask>

Returns Abortable<TaskReturn<ForkedTask>>

Settings

Member Visibility

Theme

On This Page

`Private` abortAndWaitForChildren

`Readonly` abortController

`Protected` `Optional` abortable

`Private` `Readonly` children

`Private` dispose

`Protected` `Readonly` eventBus

`Private` `Readonly` executionDeferred

`Private` getChildAbortables

`Private` handleError

`Readonly` id

`Private` `Readonly` removeAbortListener

`Private` removeChild

`Private` threadState

`Private` waitForChildren

`Optional` reason: Error

`Optional` handleError: ((error) => boolean)