Object/Class

com.twitter.finagle.loadbalancer

LoadBalancerFactory

Related Docs: class LoadBalancerFactory | package loadbalancer

Permalink

object LoadBalancerFactory

Exposes a Stack.Module which composes load balancing into the respective Stack. This is mixed in by default into Finagle's com.twitter.finagle.client.StackClient. The only necessary configuration is a LoadBalancerFactory.Dest which represents a changing collection of addresses that is load balanced over.

Linear Supertypes
AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. LoadBalancerFactory
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Type Members

  1. case class AddressOrdering(ordering: Ordering[Address]) extends Product with Serializable

    Permalink

    A class eligible for configuring a com.twitter.finagle.Stackable com.twitter.finagle.loadbalancer.LoadBalancerFactory with a finagle Address ordering.

    A class eligible for configuring a com.twitter.finagle.Stackable com.twitter.finagle.loadbalancer.LoadBalancerFactory with a finagle Address ordering. The collection of endpoints in a load balancer are sorted by this ordering. Although it's generally not a good idea to have the same ordering across process boundaries, the final ordering decision is left to the load balancer implementations. This only provides a stable ordering before we hand off the collection of endpoints to the balancer.

  2. case class Dest(va: Var[Addr]) extends Product with Serializable

    Permalink

    A class eligible for configuring a com.twitter.finagle.Stackable com.twitter.finagle.loadbalancer.LoadBalancerFactory with a collection of addrs to load balance.

  3. case class EnableProbation(enable: Boolean) extends Product with Serializable

    Permalink

    A class eligible for configuring a client's load balancer probation setting.

    A class eligible for configuring a client's load balancer probation setting. When enabled, the balancer treats removals as advisory and flags them. If a a flagged endpoint is also detected as unhealthy by Finagle's session qualifiers (e.g. fail-fast, failure accrual, etc) then the host is removed from the collection.

  4. case class ErrorLabel(label: String) extends Product with Serializable

    Permalink

    A class eligible for configuring a com.twitter.finagle.Stackable com.twitter.finagle.loadbalancer.LoadBalancerFactory with a label for use in error messages.

  5. case class HostStats(hostStatsReceiver: StatsReceiver) extends Product with Serializable

    Permalink

    A class eligible for configuring a com.twitter.finagle.Stackable com.twitter.finagle.loadbalancer.LoadBalancerFactory per host com.twitter.finagle.stats.StatsReceiver.

    A class eligible for configuring a com.twitter.finagle.Stackable com.twitter.finagle.loadbalancer.LoadBalancerFactory per host com.twitter.finagle.stats.StatsReceiver. If the per-host StatsReceiver is not null, the load balancer will broadcast stats to it (scoped with the "host:port" pair) for each host in the destination. For clients with a large host sets in their destination, this can cause unmanageable memory pressure.

  6. case class Param(loadBalancerFactory: LoadBalancerFactory) extends Product with Serializable

    Permalink

    A class eligible for configuring a com.twitter.finagle.Stackable com.twitter.finagle.loadbalancer.LoadBalancerFactory.

  7. case class ReplicateAddresses(count: Int) extends Product with Serializable

    Permalink

    A class eligible for configuring the way endpoints are created for a load balancer.

    A class eligible for configuring the way endpoints are created for a load balancer. In particular, each endpoint that is resolved is replicated by the given parameter. This increases concurrency for each identical endpoint and allows them to be load balanced over. This is useful for pipelining or multiplexing protocols that may incur head-of-line blocking (e.g. from the server's processing threads or the network) without this replication.

  8. case class WhenNoNodesOpenParam(whenNoNodesOpen: WhenNoNodesOpen) extends Product with Serializable

    Permalink

    A class eligible for configuring the LoadBalancerFactory behavior when the balancer does not find a node with Status.Open.

    A class eligible for configuring the LoadBalancerFactory behavior when the balancer does not find a node with Status.Open.

    The default is to "fail open" and pick a node at random.

    See also

    WhenNoNodesOpen

Value Members

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

    Permalink
    Definition Classes
    AnyRef → Any

  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any

  3. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any

  4. object AddressOrdering extends Serializable

    Permalink

  5. object Dest extends Serializable

    Permalink

  6. implicit object EnableProbation extends Stack.Param[EnableProbation] with Serializable

    Permalink

  7. object ErrorLabel extends Serializable

    Permalink

  8. object HostStats extends Serializable

    Permalink

  9. object Param extends Serializable

    Permalink

  10. object ReplicateAddresses extends Serializable

    Permalink

  11. object WhenNoNodesOpenParam extends Serializable

    Permalink

  12. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any

  13. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  14. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef

  15. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any

  16. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )

  17. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any

  18. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any

  19. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any

  20. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef

  21. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef

  22. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef

  23. val role: Role

    Permalink

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

    Permalink
    Definition Classes
    AnyRef

  25. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any

  26. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

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

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  28. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from AnyRef

Inherited from Any

Ungrouped