ktor-utils/io.ktor.util.pipeline

Package-level declarations

Types

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

abstract class PipelineContext<TSubject : Any, TContext : Any>(val context: TContext) : CoroutineScope

Represents running execution of a pipeline

PipelineInterceptor

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

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

class PipelinePhase(val 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