DefaultResizer

Instance Constructors

new DefaultResizer(lower: Int, upper: Int)

Java API constructor for default values except bounds.
new DefaultResizer(lowerBound: Int = 1, upperBound: Int = 10, pressureThreshold: Int = 1, rampupRate: Double = 0.2, backoffThreshold: Double = 0.3, backoffRate: Double = 0.1, messagesPerResize: Int = 10)
lowerBound
The fewest number of routees the router should ever have.
upperBound
The most number of routees the router should ever have. Must be greater than or equal to lowerBound.
pressureThreshold
Threshold to evaluate if routee is considered to be busy (under pressure). Implementation depends on this value (default is 1).
- 0: number of routees currently processing a message.
- 1: number of routees currently processing a message has some messages in mailbox.
- > 1: number of routees with at least the configured pressureThreshold messages in their mailbox. Note that estimating mailbox size of default UnboundedMailbox is O(N) operation.
rampupRate
Percentage to increase capacity whenever all routees are busy. For example, 0.2 would increase 20% (rounded up), i.e. if current capacity is 6 it will request an increase of 2 more routees.
backoffThreshold
Minimum fraction of busy routees before backing off. For example, if this is 0.3, then we'll remove some routees only when less than 30% of routees are busy, i.e. if current capacity is 10 and 3 are busy then the capacity is unchanged, but if 2 or less are busy the capacity is decreased. Use 0.0 or negative to avoid removal of routees.
backoffRate
Fraction of routees to be removed when the resizer reaches the backoffThreshold. For example, 0.1 would decrease 10% (rounded up), i.e. if current capacity is 9 it will request an decrease of 1 routee.
messagesPerResize
Number of messages between resize operation. Use 1 to resize before each message.

Value Members

final def !=(arg0: Any): Boolean

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

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

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

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

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

Definition Classes
Any
def backoff(pressure: Int, capacity: Int): Int

Computes a proposed negative (or zero) capacity delta using the configured backoffThreshold and backoffRate
Computes a proposed negative (or zero) capacity delta using the configured backoffThreshold and backoffRate
pressure
the current number of busy routees
capacity
the current number of total routees
returns
proposed decrease in capacity (as a negative number)
val backoffRate: Double

Fraction of routees to be removed when the resizer reaches the backoffThreshold.
Fraction of routees to be removed when the resizer reaches the backoffThreshold. For example, 0.1 would decrease 10% (rounded up), i.e. if current capacity is 9 it will request an decrease of 1 routee.
val backoffThreshold: Double

Minimum fraction of busy routees before backing off.
Minimum fraction of busy routees before backing off. For example, if this is 0.3, then we'll remove some routees only when less than 30% of routees are busy, i.e. if current capacity is 10 and 3 are busy then the capacity is unchanged, but if 2 or less are busy the capacity is decreased. Use 0.0 or negative to avoid removal of routees.
def capacity(routees: IndexedSeq[Routee]): Int

Returns the overall desired change in resizer capacity.
Returns the overall desired change in resizer capacity. Positive value will add routees to the resizer. Negative value will remove routees from the resizer.
routees
The current actor in the resizer
returns
the number of routees by which the resizer should be adjusted (positive, negative or zero)
def clone(): AnyRef

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

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

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

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

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

Definition Classes
AnyRef
def filter(pressure: Int, capacity: Int): Int

This method can be used to smooth the capacity delta by considering the current pressure and current capacity.
This method can be used to smooth the capacity delta by considering the current pressure and current capacity.
pressure
current number of busy routees
capacity
current number of routees
returns
proposed change in the capacity
def finalize(): Unit

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

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

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

Definition Classes
Any
def isTimeForResize(messageCounter: Long): Boolean

Is it time for resizing.
Is it time for resizing. Typically implemented with modulo of nth message, but could be based on elapsed time or something else. The messageCounter starts with 0 for the initial resize and continues with 1 for the first message. Make sure to perform initial resize before first message (messageCounter == 0), because there is no guarantee that resize will be done when concurrent messages are in play.
CAUTION: this method is invoked from the thread which tries to send a message to the pool, i.e. the ActorRef.!() method, hence it may be called concurrently.

Definition Classes
DefaultResizer → Resizer
val lowerBound: Int

The fewest number of routees the router should ever have.
val messagesPerResize: Int

Number of messages between resize operation.
Number of messages between resize operation. Use 1 to resize before each message.
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
def pressure(routees: IndexedSeq[Routee]): Int

Number of routees considered busy, or above 'pressure level'.
Number of routees considered busy, or above 'pressure level'.
Implementation depends on the value of pressureThreshold (default is 1).
- 0: number of routees currently processing a message.
- 1: number of routees currently processing a message has some messages in mailbox.
- > 1: number of routees with at least the configured pressureThreshold messages in their mailbox. Note that estimating mailbox size of default UnboundedMailbox is O(N) operation.
routees
the current resizer of routees
returns
number of busy routees, between 0 and routees.size
val pressureThreshold: Int

Threshold to evaluate if routee is considered to be busy (under pressure).
Threshold to evaluate if routee is considered to be busy (under pressure). Implementation depends on this value (default is 1).
- 0: number of routees currently processing a message.
- 1: number of routees currently processing a message has some messages in mailbox.
- > 1: number of routees with at least the configured pressureThreshold messages in their mailbox. Note that estimating mailbox size of default UnboundedMailbox is O(N) operation.
def rampup(pressure: Int, capacity: Int): Int

Computes a proposed positive (or zero) capacity delta using the configured rampupRate.
Computes a proposed positive (or zero) capacity delta using the configured rampupRate.
pressure
the current number of busy routees
capacity
the current number of total routees
returns
proposed increase in capacity
val rampupRate: Double

Percentage to increase capacity whenever all routees are busy.
Percentage to increase capacity whenever all routees are busy. For example, 0.2 would increase 20% (rounded up), i.e. if current capacity is 6 it will request an increase of 2 more routees.
def resize(currentRoutees: IndexedSeq[Routee]): Int

Decide if the capacity of the router need to be changed.
Decide if the capacity of the router need to be changed. Will be invoked when isTimeForResize returns true and no other resize is in progress.
Return the number of routees to add or remove. Negative value will remove that number of routees. Positive value will add that number of routees. 0 will not change the routees.
This method is invoked only in the context of the Router actor.

Definition Classes
DefaultResizer → Resizer
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
val upperBound: Int

The most number of routees the router should ever have.
The most number of routees the router should ever have. Must be greater than or equal to lowerBound.
final def wait(): Unit

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

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

Definition Classes
AnyRef
Annotations
@throws( ... )
def →[B](y: B): (DefaultResizer, B)

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

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from Resizer

Inherited from AnyRef

Inherited from Any

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

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

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

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

Ungrouped

Related Docs: object DefaultResizer | package routing

case class DefaultResizer(lowerBound: Int = 1, upperBound: Int = 10, pressureThreshold: Int = 1, rampupRate: Double = 0.2, backoffThreshold: Double = 0.3, backoffRate: Double = 0.1, messagesPerResize: Int = 10) extends Resizer with Product with Serializable

Instance Constructors

new DefaultResizer(lower: Int, upper: Int)

new DefaultResizer(lowerBound: Int = 1, upperBound: Int = 10, pressureThreshold: Int = 1, rampupRate: Double = 0.2, backoffThreshold: Double = 0.3, backoffRate: Double = 0.1, messagesPerResize: Int = 10)

Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

def +(other: String): String

def ->[B](y: B): (DefaultResizer, B)

final def ==(arg0: Any): Boolean

final def asInstanceOf[T0]: T0

def backoff(pressure: Int, capacity: Int): Int

val backoffRate: Double

val backoffThreshold: Double

def capacity(routees: IndexedSeq[Routee]): Int

def clone(): AnyRef

def ensuring(cond: (DefaultResizer) ⇒ Boolean, msg: ⇒ Any): DefaultResizer

def ensuring(cond: (DefaultResizer) ⇒ Boolean): DefaultResizer

def ensuring(cond: Boolean, msg: ⇒ Any): DefaultResizer

def ensuring(cond: Boolean): DefaultResizer

final def eq(arg0: AnyRef): Boolean

def filter(pressure: Int, capacity: Int): Int

def finalize(): Unit

def formatted(fmtstr: String): String

final def getClass(): Class[_]

final def isInstanceOf[T0]: Boolean

def isTimeForResize(messageCounter: Long): Boolean

val lowerBound: Int

val messagesPerResize: Int

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

def pressure(routees: IndexedSeq[Routee]): Int

val pressureThreshold: Int

def rampup(pressure: Int, capacity: Int): Int

val rampupRate: Double

def resize(currentRoutees: IndexedSeq[Routee]): Int

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

val upperBound: Int

final def wait(): Unit

final def wait(arg0: Long, arg1: Int): Unit

final def wait(arg0: Long): Unit

def →[B](y: B): (DefaultResizer, B)

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from Resizer

Inherited from AnyRef

Inherited from Any

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

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

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

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

Ungrouped