Packages

class ConfigRetriever extends AnyRef

Defines a configuration retriever that read configuration from

and tracks changes periodically.

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

Instance Constructors

  1. new ConfigRetriever(_asJava: AnyRef)

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: AnyRef
  6. def clone(): AnyRef
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @native() @throws( ... )
  7. def close(): Unit

    Closes the retriever.

  8. def configStream(): ReadStream[JsonObject]

    returns

    the stream of configurations. It's single stream (unicast) and that delivers the last known config and the successors periodically.

  9. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  10. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  11. def finalize(): Unit
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  12. def getCachedConfig(): JsonObject

    Gets the last computed configuration.

    Gets the last computed configuration. * @return the last configuration

  13. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  14. def getConfig(completionHandler: Handler[AsyncResult[JsonObject]]): Unit

    Reads the configuration from the different and computes the final configuration.

    Reads the configuration from the different and computes the final configuration. * @param completionHandler handler receiving the computed configuration, or a failure if the configuration cannot be retrieved

  15. def getConfigFuture(): Future[JsonObject]

    Like getConfig but returns a scala.concurrent.Future instead of taking an AsyncResultHandler.

  16. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  17. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  18. def listen(listener: Handler[ConfigChange]): Unit

    Registers a listener receiving configuration changes.

    Registers a listener receiving configuration changes. This method cannot only be called if the configuration is broadcasted. * @param listener the listener

  19. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  20. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  21. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  22. def setBeforeScanHandler(function: Handler[Unit]): ConfigRetriever

    Registers a handler called before every scan.

    Registers a handler called before every scan. This method is mostly used for logging purpose. * @param function the function, must not be null

    returns

    the current config retriever

  23. def setConfigurationProcessor(processor: (JsonObject) ⇒ JsonObject): ConfigRetriever

    Registers a handler that process the configuration before being injected into io.vertx.scala.config.ConfigRetriever#getConfig or io.vertx.scala.config.ConfigRetriever#listen.

    Registers a handler that process the configuration before being injected into io.vertx.scala.config.ConfigRetriever#getConfig or io.vertx.scala.config.ConfigRetriever#listen. This allows the code to customize the configuration. * @param processor the processor, must not be null. The method must not return null. The returned configuration is used. If the processor does not update the configuration, it must return the input configuration. If the processor throws an exception, the failure is passed to the #getConfig(Handler) handler.

    returns

    the current config retriever

  24. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  25. def toString(): String
    Definition Classes
    AnyRef → Any
  26. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  27. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  28. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @throws( ... )

Inherited from AnyRef

Inherited from Any

Ungrouped