Packages

object Props extends AbstractProps with Serializable

Factory for Props instances.

Props is a ActorRef configuration object, that is immutable, so it is thread safe and fully sharable.

Used when creating new actors through ActorSystem.actorOf and ActorContext.actorOf.

Source
Props.scala
Linear Supertypes
Serializable, AbstractProps, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Props
  2. Serializable
  3. AbstractProps
  4. AnyRef
  5. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. def apply(clazz: Class[_], args: Any*): Props

    Scala API: create a Props given a class and its constructor arguments.

  5. def apply[T <: Actor](creator: => T)(implicit arg0: ClassTag[T]): Props

    Scala API: Returns a Props that has default values except for "creator" which will be a function that creates an instance using the supplied thunk.

    Scala API: Returns a Props that has default values except for "creator" which will be a function that creates an instance using the supplied thunk.

    CAVEAT: Required mailbox type cannot be detected when using anonymous mixin composition when creating the instance. For example, the following will not detect the need for DequeBasedMessageQueueSemantics as defined in Stash:

    'Props(new Actor with Stash { ... })

    Instead you must create a named class that mixin the trait, e.g. class MyActor extends Actor with Stash.

  6. def apply[T <: Actor]()(implicit arg0: ClassTag[T]): Props

    Scala API: Returns a Props that has default values except for "creator" which will be a function that creates an instance of the supplied type using the default constructor.

  7. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  8. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @HotSpotIntrinsicCandidate() @native()
  9. def create[T <: Actor](actorClass: Class[T], creator: Creator[T]): Props

    Create new Props from the given pekko.japi.Creator with the type set to the given actorClass.

    Create new Props from the given pekko.japi.Creator with the type set to the given actorClass.

    Definition Classes
    AbstractProps
  10. def create(clazz: Class[_], args: AnyRef*): Props

    Java API: create a Props given a class and its constructor arguments.

    Java API: create a Props given a class and its constructor arguments.

    Definition Classes
    AbstractProps
    Annotations
    @varargs()
  11. final val default: Props

    The default Props instance, uses the settings from the Props object starting with default*.

  12. final val defaultCreator: () => Actor

    The defaultCreator, simply throws an UnsupportedOperationException when applied, which is used when creating a Props

  13. final val defaultDeploy: Deploy

    The default Deploy instance which is used when creating a Props

  14. final val defaultRoutedProps: RouterConfig

    The defaultRoutedProps is NoRouter which is used when creating a Props

  15. final val empty: Props

    A Props instance whose creator will create an actor that doesn't respond to any message

  16. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  17. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  18. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  19. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  20. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  21. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  22. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  23. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  24. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  25. def toString(): String
    Definition Classes
    AnyRef → Any
  26. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  27. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  28. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])

Deprecated Value Members

  1. def create[T <: Actor](creator: Creator[T]): Props

    Create new Props from the given pekko.japi.Creator.

    Create new Props from the given pekko.japi.Creator.

    You can not use a Java 8 lambda with this method since the generated classes don't carry enough type information.

    Use the Props.create(actorClass, creator) instead.

    Definition Classes
    AbstractProps
    Annotations
    @deprecated
    Deprecated

    (Since version Akka 2.5.18) Use Props.create(actorClass, creator) instead, since this can't be used with Java 8 lambda.

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

    (Since version 9)

Inherited from Serializable

Inherited from AbstractProps

Inherited from AnyRef

Inherited from Any

Ungrouped