ActorPublisher
Related Docs:
object ActorPublisher
| package actor
INTERNAL API
INTERNAL API
INTERNAL API
INTERNAL API
INTERNAL API
INTERNAL API
INTERNAL API
INTERNAL API
INTERNAL API
INTERNAL API
The state when the publisher is active, i.e.
The state when the publisher is active, i.e. before the subscriber is attached and when an subscriber is attached. It is allowed to call #onComplete and #onError in this state. It is allowed to call #onNext in this state when #totalDemand is greater than zero.
The state after the stream subscriber has canceled the subscription.
The state after the stream subscriber has canceled the subscription. It is allowed to call #onNext, #onError, and #onComplete in this state, but the calls will not perform anything.
The terminal state after calling #onComplete.
The terminal state after calling #onComplete. It is not allowed to call #onNext, #onError, and #onComplete in this state.
The terminal state after calling #onError.
The terminal state after calling #onError. It is not allowed to call #onNext, #onError, and #onComplete in this state.
Complete the stream.
Complete the stream. After that you are not allowed to call #onNext, #onError and #onComplete.
Complete the stream.
Complete the stream. After that you are not allowed to call #onNext, #onError and #onComplete.
After signaling completion the Actor will then stop itself as it has completed the protocol. When #onComplete is called before any Subscriber has had the chance to subscribe to this ActorPublisher the completion signal (and therefore stopping of the Actor as well) will be delayed until such Subscriber arrives.
Terminate the stream with failure.
Terminate the stream with failure. After that you are not allowed to call #onNext, #onError and #onComplete.
Terminate the stream with failure.
Terminate the stream with failure. After that you are not allowed to call #onNext, #onError and #onComplete.
After signaling the Error the Actor will then stop itself as it has completed the protocol. When #onError is called before any Subscriber has had the chance to subscribe to this ActorPublisher the error signal (and therefore stopping of the Actor as well) will be delayed until such Subscriber arrives.
Send an element to the stream subscriber.
Send an element to the stream subscriber. You are allowed to send as many elements
as have been requested by the stream subscriber. This amount can be inquired with
#totalDemand. It is only allowed to use onNext when isActive and totalDemand > 0,
otherwise onNext will throw IllegalStateException.
Subscription timeout after which this actor will become Canceled and reject any incoming "late" subscriber.
Subscription timeout after which this actor will become Canceled and reject any incoming "late" subscriber.
The actor will receive an SubscriptionTimeoutExceeded message upon which it MUST react by performing all necessary cleanup and stopping itself.
Use this feature in order to avoid leaking actors when you suspect that this Publisher may never get subscribed to by some Subscriber.
Total number of requested elements from the stream subscriber.
Total number of requested elements from the stream subscriber.
This actor automatically keeps tracks of this amount based on
incoming request messages and outgoing onNext.
Extend/mixin this trait in your akka.actor.Actor to make it a stream publisher that keeps track of the subscription life cycle and requested elements.
Create a org.reactivestreams.Publisher backed by this actor with Scala API ActorPublisher#apply, or Java API UntypedActorPublisher#create or Java API compatible with lambda expressions AbstractActorPublisher#create.
It can be attached to a org.reactivestreams.Subscriber or be used as an input source for a akka.stream.scaladsl.Flow. You can only attach one subscriber to this publisher.
The life cycle state of the subscription is tracked with the following boolean members: #isActive, #isCompleted, #isErrorEmitted, and #isCanceled.
You send elements to the stream by calling #onNext. You are allowed to send as many elements as have been requested by the stream subscriber. This amount can be inquired with #totalDemand. It is only allowed to use
onNextwhenisActiveandtotalDemand > 0, otherwiseonNextwill throwIllegalStateException.When the stream subscriber requests more elements the ActorPublisher#Request message is delivered to this actor, and you can act on that event. The #totalDemand is updated automatically.
When the stream subscriber cancels the subscription the ActorPublisher#Cancel message is delivered to this actor. After that subsequent calls to
onNextwill be ignored.You can complete the stream by calling #onComplete. After that you are not allowed to call #onNext, #onError and #onComplete.
You can terminate the stream with failure by calling #onError. After that you are not allowed to call #onNext, #onError and #onComplete.
If you suspect that this ActorPublisher may never get subscribed to, you can override the #subscriptionTimeout method to provide a timeout after which this Publisher should be considered canceled. The actor will be notified when the timeout triggers via an akka.stream.actor.ActorPublisherMessage.SubscriptionTimeoutExceeded message and MUST then perform cleanup and stop itself.
If the actor is stopped the stream will be completed, unless it was not already terminated with failure, completed or canceled.
(Since version 2.5.0) Use
akka.stream.stage.GraphStageinstead, it allows for all operations an Actor would and is more type-safe as well as guaranteed to be ReactiveStreams compliant.