vertx / io.vertx.reactivex.core.shareddata / SharedData

SharedData

open class SharedData

Shared data allows you to share data safely between different parts of your application in a safe way.

Shared data provides:

WARNING: In clustered mode, asynchronous maps/locks/counters rely on distributed data structures provided by the cluster manager. Beware that the latency relative to asynchronous maps/locks/counters operations can be much higher in clustered than in local mode.

Please see the documentation for more information. NOTE: This class has been automatically generated from the io.vertx.core.shareddata.SharedData non RX-ified interface using Vert.x codegen.

Constructors

<init>

SharedData(delegate: SharedData)

Properties

__TYPE_ARG

static val __TYPE_ARG: TypeArg<SharedData>

Functions

equals

open fun equals(other: Any?): Boolean

getAsyncMap

open fun <K : Any, V : Any> getAsyncMap(name: String, resultHandler: Handler<AsyncResult<AsyncMap<K, V>>>): Unit

Get the io.vertx.reactivex.core.shareddata.AsyncMap with the specified name. When clustered, the map is accessible to all nodes in the cluster and data put into the map from any node is visible to to any other node.

WARNING: In clustered mode, asynchronous shared maps rely on distributed data structures provided by the cluster manager. Beware that the latency relative to asynchronous shared maps operations can be much higher in clustered than in local mode.

getClusterWideMap

open fun <K : Any, V : Any> getClusterWideMap(name: String, resultHandler: Handler<AsyncResult<AsyncMap<K, V>>>): Unit

Get the cluster wide map with the specified name. The map is accessible to all nodes in the cluster and data put into the map from any node is visible to to any other node.

getCounter

open fun getCounter(name: String, resultHandler: Handler<AsyncResult<Counter>>): Unit

Get an asynchronous counter. The counter will be passed to the handler.

getDelegate

open fun getDelegate(): SharedData

getLocalMap

open fun <K : Any, V : Any> getLocalMap(name: String): LocalMap<K, V>

Return a LocalMap with the specific name.

getLock

open fun getLock(name: String, resultHandler: Handler<AsyncResult<Lock>>): Unit

Get an asynchronous lock with the specified name. The lock will be passed to the handler when it is available.

getLockWithTimeout

open fun getLockWithTimeout(name: String, timeout: Long, resultHandler: Handler<AsyncResult<Lock>>): Unit

Like io.vertx.reactivex.core.shareddata.SharedData#getLock but specifying a timeout. If the lock is not obtained within the timeout a failure will be sent to the handler

hashCode

open fun hashCode(): Int

newInstance

open static fun newInstance(arg: SharedData): SharedData

rxGetAsyncMap

open fun <K : Any, V : Any> rxGetAsyncMap(name: String): Single<AsyncMap<K, V>>

Get the io.vertx.reactivex.core.shareddata.AsyncMap with the specified name. When clustered, the map is accessible to all nodes in the cluster and data put into the map from any node is visible to to any other node.

WARNING: In clustered mode, asynchronous shared maps rely on distributed data structures provided by the cluster manager. Beware that the latency relative to asynchronous shared maps operations can be much higher in clustered than in local mode.

rxGetClusterWideMap

open fun <K : Any, V : Any> rxGetClusterWideMap(name: String): Single<AsyncMap<K, V>>

Get the cluster wide map with the specified name. The map is accessible to all nodes in the cluster and data put into the map from any node is visible to to any other node.

rxGetCounter

open fun rxGetCounter(name: String): Single<Counter>

Get an asynchronous counter. The counter will be passed to the handler.

rxGetLock

open fun rxGetLock(name: String): Single<Lock>

Get an asynchronous lock with the specified name. The lock will be passed to the handler when it is available.

rxGetLockWithTimeout

open fun rxGetLockWithTimeout(name: String, timeout: Long): Single<Lock>

Like io.vertx.reactivex.core.shareddata.SharedData#getLock but specifying a timeout. If the lock is not obtained within the timeout a failure will be sent to the handler

toString

open fun toString(): String