class ConfigRetriever extends AnyRef
Defines a configuration retriever that read configuration from
and tracks changes periodically.
- Alphabetic
- By Inheritance
- ConfigRetriever
- AnyRef
- Any
- Hide All
- Show All
- Public
- All
Instance Constructors
- new ConfigRetriever(_asJava: AnyRef)
Value Members
-
final
def
!=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
final
def
##(): Int
- Definition Classes
- AnyRef → Any
-
final
def
==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
final
def
asInstanceOf[T0]: T0
- Definition Classes
- Any
- def asJava: AnyRef
-
def
clone(): AnyRef
- Attributes
- protected[java.lang]
- Definition Classes
- AnyRef
- Annotations
- @native() @throws( ... )
-
def
close(): Unit
Closes the retriever.
-
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.
-
final
def
eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
def
equals(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
def
finalize(): Unit
- Attributes
- protected[java.lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( classOf[java.lang.Throwable] )
-
def
getCachedConfig(): JsonObject
Gets the last computed configuration.
Gets the last computed configuration. * @return the last configuration
-
final
def
getClass(): Class[_]
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
-
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
-
def
getConfigFuture(): Future[JsonObject]
Like getConfig but returns a scala.concurrent.Future instead of taking an AsyncResultHandler.
-
def
hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
-
final
def
isInstanceOf[T0]: Boolean
- Definition Classes
- Any
-
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
-
final
def
ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
final
def
notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
-
final
def
notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
-
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
-
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 returnnull
. 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
-
final
def
synchronized[T0](arg0: ⇒ T0): T0
- Definition Classes
- AnyRef
-
def
toString(): String
- Definition Classes
- AnyRef → Any
-
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
- @native() @throws( ... )