Class ScheduledParallelChainState<TElement>

State of a parallel chain whose job has been scheduled on the thread pool (or even where the computation already has completed).

Type parameters

TElement

type of the elements produced by the stream

Hierarchy

ScheduledParallelChainState

Implements

IScheduledParallelChainState<TElement>

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new ScheduledParallelChainState(stream: IParallelStream<TElement[], TElement[]>, options: IDefaultInitializedParallelOptions, environment: ParallelEnvironmentDefinition): ScheduledParallelChainState

- Defined in common/parallel/chain/scheduled-parallel-chain-state.ts:12
Creates a new state that is based on the given stream

Parameters
- stream: IParallelStream<TElement[], TElement[]>
  
  the stream for the scheduled tasks
- options: IDefaultInitializedParallelOptions
  
  the options used for the scheduled job
- environment: ParallelEnvironmentDefinition
  
  the environment used for the scheduled job
Returns ScheduledParallelChainState

Properties

Private environment

environment: ParallelEnvironmentDefinition

the environment used for the scheduled job

Private options

options: IDefaultInitializedParallelOptions

the options used for the scheduled job

stream

stream: IParallelStream<TElement[], TElement[]>

Methods

addEnvironment

addEnvironment(environment: IParallelChainEnvironment): IParallelChainState<TElement>

Implementation of IScheduledParallelChainState.addEnvironment
- Defined in common/parallel/chain/scheduled-parallel-chain-state.ts:32
Parameters
- environment: IParallelChainEnvironment
Returns IParallelChainState<TElement>

chainOperation

chainOperation<TElementNew>(operation: IParallelOperation): IParallelChainState<TElementNew>

Implementation of IScheduledParallelChainState.chainOperation
- Defined in common/parallel/chain/scheduled-parallel-chain-state.ts:28
Type parameters
- TElementNew
Parameters
- operation: IParallelOperation
Returns IParallelChainState<TElementNew>

resolve

resolve(): IScheduledParallelChainState<TElement>

Implementation of IScheduledParallelChainState.resolve
- Defined in common/parallel/chain/scheduled-parallel-chain-state.ts:24
Returns IScheduledParallelChainState<TElement>

Generated using TypeDoc