akka.contrib.pattern

ShardRegion

object ShardRegion

Source
ClusterSharding.scala
See also

ClusterSharding extension

Linear Supertypes
Content Hierarchy Learn more about scaladoc diagrams
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. ShardRegion
  2. AnyRef
  3. Any
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Type Members

  1. type EntryId = String

    Marker type of entry identifier (String).

  2. type IdExtractor = PartialFunction[Msg, (EntryId, Msg)]

    Interface of the partial function used by the ShardRegion to extract the entry id and the message to send to the entry from an incoming message.

    Interface of the partial function used by the ShardRegion to extract the entry id and the message to send to the entry from an incoming message. The implementation is application specific. If the partial function does not match the message will be unhandled, i.e. posted as Unhandled messages on the event stream. Note that the extracted message does not have to be the same as the incoming message to support wrapping in message envelope that is unwrapped before sending to the entry actor.

  3. trait MessageExtractor extends AnyRef

    Java API: Interface of functions to extract entry id, shard id, and the message to send to the entry from an incoming message.

  4. type Msg = Any

    Marker type of application messages (Any).

  5. case class Passivate(stopMessage: Any) extends ShardRegionCommand with Product with Serializable

    If the state of the entries are persistent you may stop entries that are not used to reduce memory consumption.

  6. type ShardId = String

    Marker type of shard identifier (String).

  7. sealed trait ShardRegionCommand extends AnyRef

  8. type ShardResolver = (Msg) ⇒ ShardId

    Interface of the function used by the ShardRegion to extract the shard id from an incoming message.

    Interface of the function used by the ShardRegion to extract the shard id from an incoming message. Only messages that passed the IdExtractor will be used as input to this function.

Value Members

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

    Definition Classes
    AnyRef
  2. final def !=(arg0: Any): Boolean

    Definition Classes
    Any
  3. final def ##(): Int

    Definition Classes
    AnyRef → Any
  4. final def ==(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  5. final def ==(arg0: Any): Boolean

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

    Definition Classes
    Any
  7. def clone(): AnyRef

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  8. final def eq(arg0: AnyRef): Boolean

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

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

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  11. final def getClass(): Class[_]

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

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

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

    Definition Classes
    AnyRef
  15. final def notify(): Unit

    Definition Classes
    AnyRef
  16. final def notifyAll(): Unit

    Definition Classes
    AnyRef
  17. def props(entryProps: Props, role: String, coordinatorPath: String, retryInterval: FiniteDuration, bufferSize: Int, messageExtractor: MessageExtractor): Props

    Java API: Factory method for the akka.actor.Props of the ShardRegion actor.

  18. def props(entryProps: Props, role: Option[String], coordinatorPath: String, retryInterval: FiniteDuration, bufferSize: Int, idExtractor: IdExtractor, shardResolver: (Msg) ⇒ ShardId): Props

    Scala API: Factory method for the akka.actor.Props of the ShardRegion actor.

  19. def props(entryProps: Option[Props], role: Option[String], coordinatorPath: String, retryInterval: FiniteDuration, bufferSize: Int, idExtractor: IdExtractor, shardResolver: (Msg) ⇒ ShardId): Props

    Scala API: Factory method for the akka.actor.Props of the ShardRegion actor.

  20. def proxyProps(role: String, coordinatorPath: String, retryInterval: FiniteDuration, bufferSize: Int, messageExtractor: MessageExtractor): Props

    Java API: : Factory method for the akka.actor.Props of the ShardRegion actor when using it in proxy only mode.

  21. def proxyProps(role: Option[String], coordinatorPath: String, retryInterval: FiniteDuration, bufferSize: Int, idExtractor: IdExtractor, shardResolver: (Msg) ⇒ ShardId): Props

    Scala API: Factory method for the akka.actor.Props of the ShardRegion actor when using it in proxy only mode.

  22. final def synchronized[T0](arg0: ⇒ T0): T0

    Definition Classes
    AnyRef
  23. def toString(): String

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

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

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

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from AnyRef

Inherited from Any

Ungrouped