akka.stream.stage

Interface Context<Out>

All Superinterfaces:

LifecycleContext

All Known Subinterfaces:

DetachedContext<Out>

public interface Context<Out>
extends LifecycleContext

Passed to the callback methods of PushPullStage and StatefulStage.

Method Summary

Modifier and Type	Method and Description
TerminationDirective	absorbTermination() Puts the stage in a finishing state so that final elements can be pushed from onPull.
FreeDirective	fail(java.lang.Throwable cause) Cancel upstreams and complete downstreams with failure.
FreeDirective	finish() Cancel upstreams and complete downstreams successfully.
boolean	isFinishing() This returns true after absorbTermination() has been used.
UpstreamDirective	pull() Request for more elements from upstreams.
DownstreamDirective	push(Out elem) Push one element to downstreams.
DownstreamDirective	pushAndFinish(Out elem) Push one element to downstream immediately followed by cancel of upstreams and complete of downstreams.

Methods inherited from interface akka.stream.stage.LifecycleContext

attributes, materializer

Method Detail

push

DownstreamDirective push(Out elem)

Push one element to downstreams.

Parameters:

elem - (undocumented)

Returns:

(undocumented)

pull

UpstreamDirective pull()

Request for more elements from upstreams.

Returns:

(undocumented)

finish

FreeDirective finish()

Cancel upstreams and complete downstreams successfully.

Returns:

(undocumented)

pushAndFinish

DownstreamDirective pushAndFinish(Out elem)

Push one element to downstream immediately followed by cancel of upstreams and complete of downstreams.

Parameters:

elem - (undocumented)

Returns:

(undocumented)

fail

FreeDirective fail(java.lang.Throwable cause)

Cancel upstreams and complete downstreams with failure.

Parameters:

cause - (undocumented)

Returns:

(undocumented)

absorbTermination

TerminationDirective absorbTermination()

Puts the stage in a finishing state so that final elements can be pushed from onPull.

Returns:

(undocumented)

isFinishing

boolean isFinishing()

This returns true after absorbTermination() has been used.

Returns:

(undocumented)