public class SharedData extends Object
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 theoriginal
non RX-ified interface using Vert.x codegen.Modifier and Type | Field and Description |
---|---|
static io.vertx.lang.rx.TypeArg<SharedData> |
__TYPE_ARG |
Constructor and Description |
---|
SharedData(Object delegate) |
SharedData(SharedData delegate) |
Modifier and Type | Method and Description |
---|---|
boolean |
equals(Object o) |
<K,V> void |
getAsyncMap(String name,
Handler<AsyncResult<AsyncMap<K,V>>> resultHandler)
Get the
AsyncMap with the specified name. |
<K,V> void |
getClusterWideMap(String name,
Handler<AsyncResult<AsyncMap<K,V>>> resultHandler)
Get the cluster wide map with the specified name.
|
void |
getCounter(String name,
Handler<AsyncResult<Counter>> resultHandler)
Get an asynchronous counter.
|
SharedData |
getDelegate() |
<K,V> void |
getLocalAsyncMap(String name,
Handler<AsyncResult<AsyncMap<K,V>>> resultHandler)
Get the
AsyncMap with the specified name. |
void |
getLocalCounter(String name,
Handler<AsyncResult<Counter>> resultHandler)
Get an asynchronous local counter.
|
void |
getLocalLock(String name,
Handler<AsyncResult<Lock>> resultHandler)
Get an asynchronous local lock with the specified name.
|
void |
getLocalLockWithTimeout(String name,
long timeout,
Handler<AsyncResult<Lock>> resultHandler)
Like
getLocalLock(java.lang.String, io.vertx.core.Handler<io.vertx.core.AsyncResult<io.vertx.reactivex.core.shareddata.Lock>>) but specifying a timeout. |
<K,V> LocalMap<K,V> |
getLocalMap(String name)
Return a
LocalMap with the specific name . |
void |
getLock(String name,
Handler<AsyncResult<Lock>> resultHandler)
Get an asynchronous lock with the specified name.
|
void |
getLockWithTimeout(String name,
long timeout,
Handler<AsyncResult<Lock>> resultHandler)
Like
getLock(java.lang.String, io.vertx.core.Handler<io.vertx.core.AsyncResult<io.vertx.reactivex.core.shareddata.Lock>>) but specifying a timeout. |
int |
hashCode() |
static SharedData |
newInstance(SharedData arg) |
<K,V> Single<AsyncMap<K,V>> |
rxGetAsyncMap(String name)
Get the
AsyncMap with the specified name. |
<K,V> Single<AsyncMap<K,V>> |
rxGetClusterWideMap(String name)
Get the cluster wide map with the specified name.
|
Single<Counter> |
rxGetCounter(String name)
Get an asynchronous counter.
|
<K,V> Single<AsyncMap<K,V>> |
rxGetLocalAsyncMap(String name)
Get the
AsyncMap with the specified name. |
Single<Counter> |
rxGetLocalCounter(String name)
Get an asynchronous local counter.
|
Single<Lock> |
rxGetLocalLock(String name)
Get an asynchronous local lock with the specified name.
|
Single<Lock> |
rxGetLocalLockWithTimeout(String name,
long timeout)
Like
getLocalLock(java.lang.String, io.vertx.core.Handler<io.vertx.core.AsyncResult<io.vertx.reactivex.core.shareddata.Lock>>) but specifying a timeout. |
Single<Lock> |
rxGetLock(String name)
Get an asynchronous lock with the specified name.
|
Single<Lock> |
rxGetLockWithTimeout(String name,
long timeout)
Like
getLock(java.lang.String, io.vertx.core.Handler<io.vertx.core.AsyncResult<io.vertx.reactivex.core.shareddata.Lock>>) but specifying a timeout. |
String |
toString() |
public static final io.vertx.lang.rx.TypeArg<SharedData> __TYPE_ARG
public SharedData(SharedData delegate)
public SharedData(Object delegate)
public SharedData getDelegate()
public <K,V> void getClusterWideMap(String name, Handler<AsyncResult<AsyncMap<K,V>>> resultHandler)
name
- the name of the mapresultHandler
- the map will be returned asynchronously in this handlerpublic <K,V> Single<AsyncMap<K,V>> rxGetClusterWideMap(String name)
name
- the name of the mappublic <K,V> void getAsyncMap(String name, Handler<AsyncResult<AsyncMap<K,V>>> resultHandler)
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.
name
- the name of the mapresultHandler
- the map will be returned asynchronously in this handlerpublic <K,V> Single<AsyncMap<K,V>> rxGetAsyncMap(String name)
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.
name
- the name of the mappublic <K,V> void getLocalAsyncMap(String name, Handler<AsyncResult<AsyncMap<K,V>>> resultHandler)
AsyncMap
with the specified name.
When clustered, the map is NOT accessible to all nodes in the cluster. Only the instance which created the map can put and retrieve data from this map.
name
- the name of the mapresultHandler
- the map will be returned asynchronously in this handlerpublic <K,V> Single<AsyncMap<K,V>> rxGetLocalAsyncMap(String name)
AsyncMap
with the specified name.
When clustered, the map is NOT accessible to all nodes in the cluster. Only the instance which created the map can put and retrieve data from this map.
name
- the name of the mappublic void getLock(String name, Handler<AsyncResult<Lock>> resultHandler)
In general lock acquision is unordered, so that sequential attempts to acquire a lock, even from a single thread, can happen in non-sequential order.
name
- the name of the lockresultHandler
- the handlerpublic Single<Lock> rxGetLock(String name)
In general lock acquision is unordered, so that sequential attempts to acquire a lock, even from a single thread, can happen in non-sequential order.
name
- the name of the lockpublic void getLockWithTimeout(String name, long timeout, Handler<AsyncResult<Lock>> resultHandler)
getLock(java.lang.String, io.vertx.core.Handler<io.vertx.core.AsyncResult<io.vertx.reactivex.core.shareddata.Lock>>)
but specifying a timeout. If the lock is not obtained within the timeout
a failure will be sent to the handler.
In general lock acquision is unordered, so that sequential attempts to acquire a lock, even from a single thread, can happen in non-sequential order.
name
- the name of the locktimeout
- the timeout in msresultHandler
- the handlerpublic Single<Lock> rxGetLockWithTimeout(String name, long timeout)
getLock(java.lang.String, io.vertx.core.Handler<io.vertx.core.AsyncResult<io.vertx.reactivex.core.shareddata.Lock>>)
but specifying a timeout. If the lock is not obtained within the timeout
a failure will be sent to the handler.
In general lock acquision is unordered, so that sequential attempts to acquire a lock, even from a single thread, can happen in non-sequential order.
name
- the name of the locktimeout
- the timeout in mspublic void getLocalLock(String name, Handler<AsyncResult<Lock>> resultHandler)
In general lock acquision is unordered, so that sequential attempts to acquire a lock, even from a single thread, can happen in non-sequential order.
name
- the name of the lockresultHandler
- the handlerpublic Single<Lock> rxGetLocalLock(String name)
In general lock acquision is unordered, so that sequential attempts to acquire a lock, even from a single thread, can happen in non-sequential order.
name
- the name of the lockpublic void getLocalLockWithTimeout(String name, long timeout, Handler<AsyncResult<Lock>> resultHandler)
getLocalLock(java.lang.String, io.vertx.core.Handler<io.vertx.core.AsyncResult<io.vertx.reactivex.core.shareddata.Lock>>)
but specifying a timeout. If the lock is not obtained within the timeout
a failure will be sent to the handler.
In general lock acquision is unordered, so that sequential attempts to acquire a lock, even from a single thread, can happen in non-sequential order.
name
- the name of the locktimeout
- the timeout in msresultHandler
- the handlerpublic Single<Lock> rxGetLocalLockWithTimeout(String name, long timeout)
getLocalLock(java.lang.String, io.vertx.core.Handler<io.vertx.core.AsyncResult<io.vertx.reactivex.core.shareddata.Lock>>)
but specifying a timeout. If the lock is not obtained within the timeout
a failure will be sent to the handler.
In general lock acquision is unordered, so that sequential attempts to acquire a lock, even from a single thread, can happen in non-sequential order.
name
- the name of the locktimeout
- the timeout in mspublic void getCounter(String name, Handler<AsyncResult<Counter>> resultHandler)
name
- the name of the counter.resultHandler
- the handlerpublic Single<Counter> rxGetCounter(String name)
name
- the name of the counter.public void getLocalCounter(String name, Handler<AsyncResult<Counter>> resultHandler)
name
- the name of the counter.resultHandler
- the handlerpublic Single<Counter> rxGetLocalCounter(String name)
name
- the name of the counter.public <K,V> LocalMap<K,V> getLocalMap(String name)
LocalMap
with the specific name
.name
- the name of the mappublic static SharedData newInstance(SharedData arg)
Copyright © 2023 Eclipse. All rights reserved.