Packages

  • package root
    Definition Classes
    root
  • package akka
    Definition Classes
    root
  • package pattern

    This package is used as a collection point for usage patterns which involve actors, futures, etc.

    Commonly Used Patterns With Akka

    This package is used as a collection point for usage patterns which involve actors, futures, etc. but are loosely enough coupled to (multiple of) them to present them separately from the core implementation. Currently supported are:

    • ask: create a temporary one-off actor for receiving a reply to a message and complete a scala.concurrent.Future with it; returns said Future.
    • pipeTo: feed eventually computed value of a future to an akka.actor.ActorRef as a message.
    • pipeToSelection: feed eventually computed value of a future to an akka.actor.ActorSelection as a message.

    In Scala the recommended usage is to import the pattern from the package object:

    import akka.pattern.ask

ask(actor, message) // use it directly
actor ask message   // use it by implicit conversion

    For Java the patterns are available as static methods of the akka.pattern.Patterns class:

    import static akka.pattern.Patterns.ask;

ask(actor, message);
    Definition Classes
    akka
  • trait PipeToSupport extends AnyRef
    Definition Classes
    pattern
  • PipeableCompletionStage
  • PipeableFuture

final class PipeableFuture[T] extends AnyRef

Source
PipeToSupport.scala
Linear Supertypes
AnyRef, Any
Type Hierarchy
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. PipeableFuture
  2. AnyRef
  3. Any
Implicitly
  1. by any2stringadd
  2. by StringFormat
  3. by Ensuring
  4. by ArrowAssoc
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new PipeableFuture(future: Future[T])(implicit executionContext: ExecutionContext)

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. def +(other: String): String
    Implicit
    This member is added by an implicit conversion from PipeableFuture[T] toany2stringadd[PipeableFuture[T]] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (PipeableFuture[T], B)
    Implicit
    This member is added by an implicit conversion from PipeableFuture[T] toArrowAssoc[PipeableFuture[T]] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()
  5. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  6. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  7. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @HotSpotIntrinsicCandidate() @native()
  8. def ensuring(cond: (PipeableFuture[T]) => Boolean, msg: => Any): PipeableFuture[T]
    Implicit
    This member is added by an implicit conversion from PipeableFuture[T] toEnsuring[PipeableFuture[T]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  9. def ensuring(cond: (PipeableFuture[T]) => Boolean): PipeableFuture[T]
    Implicit
    This member is added by an implicit conversion from PipeableFuture[T] toEnsuring[PipeableFuture[T]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  10. def ensuring(cond: Boolean, msg: => Any): PipeableFuture[T]
    Implicit
    This member is added by an implicit conversion from PipeableFuture[T] toEnsuring[PipeableFuture[T]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  11. def ensuring(cond: Boolean): PipeableFuture[T]
    Implicit
    This member is added by an implicit conversion from PipeableFuture[T] toEnsuring[PipeableFuture[T]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  12. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  13. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  14. val future: Future[T]
  15. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  16. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  17. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  18. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  19. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  20. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  21. def pipeTo(recipient: ActorRef)(implicit sender: ActorRef = Actor.noSender): Future[T]
  22. def pipeToSelection(recipient: ActorSelection)(implicit sender: ActorRef = Actor.noSender): Future[T]
  23. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  24. def to(recipient: ActorSelection, sender: ActorRef): PipeableFuture[T]
  25. def to(recipient: ActorSelection): PipeableFuture[T]
  26. def to(recipient: ActorRef, sender: ActorRef): PipeableFuture[T]
  27. def to(recipient: ActorRef): PipeableFuture[T]
  28. def toString(): String
    Definition Classes
    AnyRef → Any
  29. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  30. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  31. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable]) @Deprecated
    Deprecated

    (Since version 9)

  2. def formatted(fmtstr: String): String
    Implicit
    This member is added by an implicit conversion from PipeableFuture[T] toStringFormat[PipeableFuture[T]] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @deprecated @inline()
    Deprecated

    (Since version 2.12.16) Use formatString.format(value) instead of value.formatted(formatString), or use the f"" string interpolator. In Java 15 and later, formatted resolves to the new method in String which has reversed parameters.

  3. def →[B](y: B): (PipeableFuture[T], B)
    Implicit
    This member is added by an implicit conversion from PipeableFuture[T] toArrowAssoc[PipeableFuture[T]] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @deprecated
    Deprecated

    (Since version 2.13.0) Use -> instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd fromPipeableFuture[T] to any2stringadd[PipeableFuture[T]]

Inherited by implicit conversion StringFormat fromPipeableFuture[T] to StringFormat[PipeableFuture[T]]

Inherited by implicit conversion Ensuring fromPipeableFuture[T] to Ensuring[PipeableFuture[T]]

Inherited by implicit conversion ArrowAssoc fromPipeableFuture[T] to ArrowAssoc[PipeableFuture[T]]

Ungrouped