object ActorFlow

Provides a flow that is handled by an actor.

See https://github.com/akka/akka/issues/16985.

Source
ActorFlow.scala
Linear Supertypes
AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. ActorFlow
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Value Members

  1. def actorRef[In, Out](props: (ActorRef) => Props, bufferSize: Int = 16, overflowStrategy: OverflowStrategy = OverflowStrategy.fail)(implicit factory: ActorRefFactory, mat: Materializer): Flow[In, Out, _]

    Create a flow that is handled by an actor.

    Create a flow that is handled by an actor.

    Messages can be sent downstream by sending them to the actor passed into the props function. This actor meets the contract of the actor returned by https://pekko.apache.org/api/pekko/1.0/org/apache/pekko/stream/scaladsl/Source$.html#actorRef[T](bufferSize:Int,overflowStrategy:org.apache.pekko.stream.OverflowStrategy):org.apache.pekko.stream.scaladsl.Source[T,org.apache.pekko.actor.ActorRef org.apache.pekko.stream.scaladsl.Source.actorRef]].

    The props function should return the props for an actor to handle the flow. This actor will be created using the passed in org.apache.pekko.actor.ActorRefFactory. Each message received will be sent to the actor - there is no back pressure, if the actor is unable to process the messages, they will queue up in the actors mailbox. The upstream can be cancelled by the actor terminating itself.

    props

    A function that creates the props for actor to handle the flow.

    bufferSize

    The maximum number of elements to buffer.

    overflowStrategy

    The strategy for how to handle a buffer overflow.