Trait

akka.actor

Extension

Related Doc: package actor

Permalink

trait Extension extends AnyRef

The basic ActorSystem covers all that is needed for locally running actors, using futures and so on. In addition, more features can hook into it and thus become visible to actors et al by registering themselves as extensions. This is accomplished by providing an extension—which is an object implementing this trait—to ActorSystem.registerExtension(...) or by specifying the corresponding option in the configuration passed to ActorSystem, which will then instantiate (without arguments) each FQCN and register the result.

The extension itself can be created in any way desired and has full access to the ActorSystem implementation.

This trait is only a marker interface to signify an Akka Extension. This is how an extension is normally constructed.

Scala API:

object MyExt extends ExtensionId[Ext] with ExtensionIdProvider {

  override def lookup = MyExt

  override def createExtension(system: ExtendedActorSystem): Ext = new Ext(system)

  // Java API: retrieve the extension for the given system.
  override def get(system: ActorSystem): UdpExt = super.get(system)
}

class Ext(system: ExtendedActorSystem) extends Extension {
  ...
}

Java API:

public class MyExt extends AbstractExtensionId<MyExtImpl>
  implements ExtensionIdProvider {
  public final static MyExt MyExtProvider = new MyExt();

  private MyExt() {}

  public MyExt lookup() {
    return MyExt.MyExtProvider;
  }

  public MyExtImpl createExtension(ExtendedActorSystem system) {
    return new MyExtImpl();
  }
}

public class MyExtImpl implements Extension {
   ...
}

See also akka.actor.ExtensionKey for a concise way of formulating extensions.

Source
Extension.scala
Linear Supertypes
Known Subclasses
Type Hierarchy
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Extension
  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. All

Value Members

  1. final def !=(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  3. def +(other: String): String

    Permalink
    Implicit information
    This member is added by an implicit conversion from Extension to any2stringadd[Extension] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (Extension, B)

    Permalink
    Implicit information
    This member is added by an implicit conversion from Extension to ArrowAssoc[Extension] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()
  5. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  6. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  7. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  8. def ensuring(cond: (Extension) ⇒ Boolean, msg: ⇒ Any): Extension

    Permalink
    Implicit information
    This member is added by an implicit conversion from Extension to Ensuring[Extension] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  9. def ensuring(cond: (Extension) ⇒ Boolean): Extension

    Permalink
    Implicit information
    This member is added by an implicit conversion from Extension to Ensuring[Extension] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  10. def ensuring(cond: Boolean, msg: ⇒ Any): Extension

    Permalink
    Implicit information
    This member is added by an implicit conversion from Extension to Ensuring[Extension] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  11. def ensuring(cond: Boolean): Extension

    Permalink
    Implicit information
    This member is added by an implicit conversion from Extension to Ensuring[Extension] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  12. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  13. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  14. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  15. def formatted(fmtstr: String): String

    Permalink
    Implicit information
    This member is added by an implicit conversion from Extension to StringFormat[Extension] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @inline()
  16. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
  17. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  18. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  19. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  20. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  21. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  22. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  23. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any
  24. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  25. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  26. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  27. def [B](y: B): (Extension, B)

    Permalink
    Implicit information
    This member is added by an implicit conversion from Extension to ArrowAssoc[Extension] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd from Extension to any2stringadd[Extension]

Inherited by implicit conversion StringFormat from Extension to StringFormat[Extension]

Inherited by implicit conversion Ensuring from Extension to Ensuring[Extension]

Inherited by implicit conversion ArrowAssoc from Extension to ArrowAssoc[Extension]

Ungrouped