ktor-utils/io.ktor.util.pipeline/Pipeline

Pipeline

open class Pipeline<TSubject : Any, TContext : Any>(phases: PipelinePhase)

Represents an execution pipeline for asynchronous extensible computations

Constructors

Pipeline

fun Pipeline(phase: PipelinePhase, interceptors: List<PipelineInterceptor<TSubject, TContext>>)

Pipeline

fun Pipeline(vararg phases: PipelinePhase)

Functions

addPhase

fun addPhase(phase: PipelinePhase)

Adds phase to the end of this pipeline

afterIntercepted

open fun afterIntercepted()

Invoked after an interceptor has been installed

execute

suspend fun execute(context: TContext, subject: TSubject): TSubject

Executes this pipeline in the given context and with the given subject

insertPhaseAfter

fun insertPhaseAfter(reference: PipelinePhase, phase: PipelinePhase)

Inserts phase after the reference phase. If there are other phases inserted after reference, then phase will be inserted after them. Example:

insertPhaseBefore

fun insertPhaseBefore(reference: PipelinePhase, phase: PipelinePhase)

Inserts phase before the reference phase. Example:

intercept

fun intercept(phase: PipelinePhase, block: PipelineInterceptor<TSubject, TContext>)

Adds block to the phase of this pipeline

interceptorsForPhase

fun interceptorsForPhase(phase: PipelinePhase): List<PipelineInterceptor<TSubject, TContext>>

merge

fun merge(from: Pipeline<TSubject, TContext>)

Merges another pipeline into this pipeline, maintaining relative phases order

mergePhases

fun mergePhases(from: Pipeline<TSubject, TContext>)

resetFrom

fun resetFrom(from: Pipeline<TSubject, TContext>)

Reset current pipeline from other.

Properties

attributes

val attributes: Attributes

Provides common place to store pipeline attributes

developmentMode

open val developmentMode: Boolean = false

Indicated if debug mode is enabled. In debug mode users will get more details in the stacktrace.

isEmpty

val isEmpty: Boolean

items

val items: List<PipelinePhase>

Phases of this pipeline

Extensions

execute

inline suspend fun <TContext : Any> Pipeline<Unit, TContext>.execute(context: TContext)

Executes this pipeline

intercept

inline fun <TSubject : Any, TContext : Any> Pipeline<*, TContext>.intercept(phase: PipelinePhase, noinline block: suspend PipelineContext<TSubject, TContext>.(TSubject) -> Unit)

Intercepts an untyped pipeline when the subject is of the given type