vertx-lang-scala-docs_2.12 3.6.0 API < Back
 

# Packages

-  package root
  Definition Classes
    root
-  package io
  Definition Classes
    root
-  package vertx
  Definition Classes
    io
-  package scala
  Definition Classes
    vertx
-  package circuitbreaker
  Definition Classes
    scala
- CircuitBreaker
- CircuitBreakerOptions
- HystrixMetricHandler

c

io.vertx.scala.circuitbreaker

# CircuitBreakerOptions 

###
Companion object CircuitBreakerOptions

#### class CircuitBreakerOptions extends AnyRef

Circuit breaker configuration options. All time are given in milliseconds.

Linear Supertypes
AnyRef, Any
 
Ordering

1. Alphabetic
2. By Inheritance

Inherited

1. CircuitBreakerOptions
2. AnyRef
3. Any

1. Hide All
2. Show All

Visibility

1. Public
2. All

### Instance Constructors

1.  new CircuitBreakerOptions(_asJava: circuitbreaker.CircuitBreakerOptions)

### 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.  final def asInstanceOf[T0]: T0
   Definition Classes
     Any
5.  def asJava: circuitbreaker.CircuitBreakerOptions
6.  def clone(): AnyRef
   Attributes
     protected[java.lang]
   Definition Classes
     AnyRef
   Annotations
     @native() @throws( ... )
7.  final def eq(arg0: AnyRef): Boolean
   Definition Classes
     AnyRef
8.  def equals(arg0: Any): Boolean
   Definition Classes
     AnyRef → Any
9.  def finalize(): Unit
   Attributes
     protected[java.lang]
   Definition Classes
     AnyRef
   Annotations
     @throws( classOf[java.lang.Throwable] )
10.  final def getClass(): Class[_]
    Definition Classes
      AnyRef → Any
    Annotations
      @native()
11.  def getFailuresRollingWindow: Long
12.  def getMaxFailures: Int
13.  def getMaxRetries: Int
14.  def getMetricsRollingBuckets: Int
15.  def getMetricsRollingWindow: Long
16.  def getNotificationAddress: String
17.  def getNotificationPeriod: Long
18.  def getResetTimeout: Long
19.  def getTimeout: Long
20.  def hashCode(): Int
    Definition Classes
      AnyRef → Any
    Annotations
      @native()
21.  def isFallbackOnFailure: Boolean
22.  final def isInstanceOf[T0]: Boolean
    Definition Classes
      Any
23.  final def ne(arg0: AnyRef): Boolean
    Definition Classes
      AnyRef
24.  final def notify(): Unit
    Definition Classes
      AnyRef
    Annotations
      @native()
25.  final def notifyAll(): Unit
    Definition Classes
      AnyRef
    Annotations
      @native()
26.  def setFailuresRollingWindow(value: Long): CircuitBreakerOptions

    Sets the rolling window used for metrics.

27.  def setFallbackOnFailure(value: Boolean): CircuitBreakerOptions

    Sets whether or not the fallback is executed on failure, even when the circuit is closed.

28.  def setMaxFailures(value: Int): CircuitBreakerOptions

    Sets the maximum number of failures before opening the circuit.

29.  def setMaxRetries(value: Int): CircuitBreakerOptions

    Configures the number of times the circuit breaker tries to redo the operation before failing.

30.  def setMetricsRollingBuckets(value: Int): CircuitBreakerOptions

    Sets the configured number of buckets the rolling window is divided into.

    Sets the configured number of buckets the rolling window is divided into.

    The following must be true - metrics.rollingStats.timeInMilliseconds % metrics.rollingStats.numBuckets == 0 - otherwise it will throw an exception.

    In other words, 10000/10 is okay, so is 10000/20 but 10000/7 is not.

31.  def setMetricsRollingWindow(value: Long): CircuitBreakerOptions

    Sets the rolling window used for metrics.

32.  def setNotificationAddress(value: String): CircuitBreakerOptions

    Sets the event bus address on which the circuit breaker publish its state change.

33.  def setNotificationPeriod(value: Long): CircuitBreakerOptions

    Configures the period in milliseconds where the circuit breaker send a notification on the event bus with its current state.

34.  def setResetTimeout(value: Long): CircuitBreakerOptions

    Sets the time in ms before it attempts to re-close the circuit (by going to the half-open state).

    Sets the time in ms before it attempts to re-close the circuit (by going to the half-open state). If the circuit is closed when the timeout is reached, nothing happens. `-1` disables this feature.

35.  def setTimeout(value: Long): CircuitBreakerOptions

    Sets the timeout in milliseconds.

    Sets the timeout in milliseconds. If an action is not completed before this timeout, the action is considered as a failure.

36.  final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
      AnyRef
37.  def toString(): String
    Definition Classes
      AnyRef → Any
38.  final def wait(): Unit
    Definition Classes
      AnyRef
    Annotations
      @throws( ... )
39.  final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
      AnyRef
    Annotations
      @throws( ... )
40.  final def wait(arg0: Long): Unit
    Definition Classes
      AnyRef
    Annotations
      @native() @throws( ... )

### Inherited from AnyRef

### Inherited from Any

### Ungrouped