io.ktor.util.pipeline

Class Pipeline<TSubject,TContext>

io.ktor.util.pipeline.Pipeline<TSubject,TContext>

public class Pipeline<TSubject,TContext>

Represents an execution pipeline for asynchronous extensible computations

Constructor Summary

Constructors

Constructor and Description
Pipeline(io.ktor.util.pipeline.PipelinePhase phases) Represents an execution pipeline for asynchronous extensible computations
Pipeline(PipelinePhase phase, java.util.List<? extends kotlin.jvm.functions.Function3<? super io.ktor.util.pipeline.PipelineContext<TSubject,TContext>,? super TSubject,? super kotlin.coroutines.experimental.Continuation<? super kotlin.Unit>,? extends java.lang.Object>> interceptors)

Method Summary

Modifier and Type	Method and Description
void	addPhase(PipelinePhase phase) Adds phase to the end of this pipeline
void	afterIntercepted() Invoked after an interceptor has been installed
java.lang.Object	execute(TContext context, TSubject subject, kotlin.coroutines.experimental.Continuation<? super TSubject> p) Executes this pipeline in the given context and with the given subject
Attributes	getAttributes() Provides common place to store pipeline attributes
java.util.List<io.ktor.util.pipeline.PipelinePhase>	getItems() Phases of this pipeline
void	insertPhaseAfter(PipelinePhase reference, PipelinePhase phase) Inserts phase after the reference phase
void	insertPhaseBefore(PipelinePhase reference, PipelinePhase phase) Inserts phase before the reference phase
void	intercept(PipelinePhase phase, kotlin.jvm.functions.Function3<? super io.ktor.util.pipeline.PipelineContext<TSubject,TContext>,? super TSubject,? super kotlin.coroutines.experimental.Continuation<? super kotlin.Unit>,? extends java.lang.Object> block) Adds block to the phase of this pipeline
boolean	isEmpty()
void	merge(Pipeline<TSubject,TContext> from) Merges another pipeline into this pipeline, maintaining relative phases order

Constructor Detail

Pipeline

public Pipeline(io.ktor.util.pipeline.PipelinePhase phases)

Represents an execution pipeline for asynchronous extensible computations

Pipeline

public Pipeline(PipelinePhase phase,
                java.util.List<? extends kotlin.jvm.functions.Function3<? super io.ktor.util.pipeline.PipelineContext<TSubject,TContext>,? super TSubject,? super kotlin.coroutines.experimental.Continuation<? super kotlin.Unit>,? extends java.lang.Object>> interceptors)

Method Detail

getAttributes

public Attributes getAttributes()

Provides common place to store pipeline attributes

execute

public java.lang.Object execute(TContext context,
                                TSubject subject,
                                kotlin.coroutines.experimental.Continuation<? super TSubject> p)

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

getItems

public java.util.List<io.ktor.util.pipeline.PipelinePhase> getItems()

Phases of this pipeline

addPhase

public void addPhase(PipelinePhase phase)

Adds phase to the end of this pipeline

insertPhaseAfter

public void insertPhaseAfter(PipelinePhase reference,
                             PipelinePhase phase)

Inserts phase after the reference phase

insertPhaseBefore

public void insertPhaseBefore(PipelinePhase reference,
                              PipelinePhase phase)

Inserts phase before the reference phase

isEmpty

public boolean isEmpty()

Returns:

true if there are no interceptors installed regardless number of phases

intercept

public void intercept(PipelinePhase phase,
                      kotlin.jvm.functions.Function3<? super io.ktor.util.pipeline.PipelineContext<TSubject,TContext>,? super TSubject,? super kotlin.coroutines.experimental.Continuation<? super kotlin.Unit>,? extends java.lang.Object> block)

Adds block to the phase of this pipeline

afterIntercepted

public void afterIntercepted()

Invoked after an interceptor has been installed

merge

public void merge(Pipeline<TSubject,TContext> from)

Merges another pipeline into this pipeline, maintaining relative phases order