ktor-utils/io.ktor.util.pipeline

Package io.ktor.util.pipeline

Types

@Target(allowedTargets = [AnnotationTarget.CLASS, AnnotationTarget.TYPEALIAS, AnnotationTarget.TYPE, AnnotationTarget.FUNCTION])

annotation class ContextDsl

DslMarker for pipeline execution context

InvalidPhaseException

class InvalidPhaseException(message: String) : Throwable

An exception about misconfigured phases in a pipeline

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

Represents an execution pipeline for asynchronous extensible computations

PipelineContext

interface PipelineContext<TSubject : Any, TContext : Any> : CoroutineScope

Represents running execution of a pipeline

PipelineExecutor

~~interface~~ ~~PipelineExecutor~~<R>

Represent an object that launches pipeline execution

PipelineInterceptor

typealias PipelineInterceptor<TSubject, TContext> = suspend PipelineContext<TSubject, TContext>.(TSubject) -> Unit

Represents an interceptor type which is a suspend extension function for context

class PipelinePhase(name: String)

Represents a phase in a pipeline

Functions

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

Executes this pipeline

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

pipelineExecutorFor

~~fun~~ <TSubject : Any, TContext : Any> ~~pipelineExecutorFor~~(~~context~~: ~~TContext~~, ~~interceptors~~: List<PipelineInterceptor<TSubject, TContext>>, ~~subject~~: ~~TSubject~~): PipelineExecutor<TSubject>

Build a pipeline of the specified interceptors and create executor.