Class

colossus.service

ClientConfig

Related Doc: package service

Permalink

case class ClientConfig(address: InetSocketAddress, requestTimeout: Duration, name: MetricAddress, pendingBufferSize: Int = 100, sentBufferSize: Int = 100, failFast: Boolean = false, connectionAttempts: PollingDuration = ..., idleTimeout: Duration = Duration.Inf) extends Product with Serializable

Configuration used to specify a Client's parameters

address

The address with which to connect

requestTimeout

The request timeout value

name

The MetricAddress associated with this client

pendingBufferSize

Size of the pending buffer

sentBufferSize

Size of the sent buffer

failFast

When a failure is detected, immediately fail all pending requests.

connectionAttempts

Polling configuration to govern retry behavior for both initial connect attempts and for connection lost events.

idleTimeout

How long the connection can remain idle (both sending and receiving data) before it is closed. This should be significantly higher than requestTimeout.

Linear Supertypes
Serializable, Serializable, Product, Equals, AnyRef, Any
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. ClientConfig
  2. Serializable
  3. Serializable
  4. Product
  5. Equals
  6. AnyRef
  7. Any
  1. Hide All
  2. Show all
Visibility
  1. Public
  2. All

Instance Constructors

  1. new ClientConfig(address: InetSocketAddress, requestTimeout: Duration, name: MetricAddress, pendingBufferSize: Int = 100, sentBufferSize: Int = 100, failFast: Boolean = false, connectionAttempts: PollingDuration = ..., idleTimeout: Duration = Duration.Inf)

    Permalink

    address

    The address with which to connect

    requestTimeout

    The request timeout value

    name

    The MetricAddress associated with this client

    pendingBufferSize

    Size of the pending buffer

    sentBufferSize

    Size of the sent buffer

    failFast

    When a failure is detected, immediately fail all pending requests.

    connectionAttempts

    Polling configuration to govern retry behavior for both initial connect attempts and for connection lost events.

    idleTimeout

    How long the connection can remain idle (both sending and receiving data) before it is closed. This should be significantly higher than requestTimeout.

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. val address: InetSocketAddress

    Permalink

    The address with which to connect

  5. final def asInstanceOf[T0]: T0

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

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  7. val connectionAttempts: PollingDuration

    Permalink

    Polling configuration to govern retry behavior for both initial connect attempts and for connection lost events.

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

    Permalink
    Definition Classes
    AnyRef
  9. val failFast: Boolean

    Permalink

    When a failure is detected, immediately fail all pending requests.

  10. def finalize(): Unit

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

    Permalink
    Definition Classes
    AnyRef → Any
  12. val idleTimeout: Duration

    Permalink

    How long the connection can remain idle (both sending and receiving data) before it is closed.

    How long the connection can remain idle (both sending and receiving data) before it is closed. This should be significantly higher than requestTimeout.

  13. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  14. val name: MetricAddress

    Permalink

    The MetricAddress associated with this client

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

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

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

    Permalink
    Definition Classes
    AnyRef
  18. val pendingBufferSize: Int

    Permalink

    Size of the pending buffer

  19. val requestTimeout: Duration

    Permalink

    The request timeout value

  20. val sentBufferSize: Int

    Permalink

    Size of the sent buffer

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

    Permalink
    Definition Classes
    AnyRef
  22. final def wait(): Unit

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

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

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

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Ungrouped