org.redisson.api

Interface RScriptRx

public interface RScriptRx

RxJava2 interface for Redis Script feature

Author:

Nikita Koksharov

Method Summary

Modifier and Type	Method and Description
<R> io.reactivex.Maybe<R>	eval(RScript.Mode mode, String luaScript, RScript.ReturnType returnType) Executes Lua script
<R> io.reactivex.Maybe<R>	eval(RScript.Mode mode, String luaScript, RScript.ReturnType returnType, List<Object> keys, Object... values) Executes Lua script
<R> io.reactivex.Maybe<R>	eval(String key, RScript.Mode mode, String luaScript, RScript.ReturnType returnType, List<Object> keys, Object... values) Executes Lua script
<R> io.reactivex.Maybe<R>	evalSha(RScript.Mode mode, String shaDigest, RScript.ReturnType returnType) Executes Lua script stored in Redis scripts cache by SHA-1 digest
<R> io.reactivex.Maybe<R>	evalSha(RScript.Mode mode, String shaDigest, RScript.ReturnType returnType, List<Object> keys, Object... values) Executes Lua script stored in Redis scripts cache by SHA-1 digest
<R> io.reactivex.Maybe<R>	evalSha(String key, RScript.Mode mode, String shaDigest, RScript.ReturnType returnType, List<Object> keys, Object... values) Executes Lua script stored in Redis scripts cache by SHA-1 digest
io.reactivex.Single<List<Boolean>>	scriptExists(String... shaDigests) Checks for presence Lua scripts in Redis script cache by SHA-1 digest.
io.reactivex.Completable	scriptFlush() Flushes Lua script cache.
io.reactivex.Completable	scriptKill() Kills currently executed Lua script
io.reactivex.Single<String>	scriptLoad(String luaScript) Loads Lua script into Redis scripts cache and returns its SHA-1 digest

Method Detail

scriptFlush

io.reactivex.Completable scriptFlush()

Flushes Lua script cache.

Returns:

void

evalSha

<R> io.reactivex.Maybe<R> evalSha(RScript.Mode mode,
                                  String shaDigest,
                                  RScript.ReturnType returnType,
                                  List<Object> keys,
                                  Object... values)

Executes Lua script stored in Redis scripts cache by SHA-1 digest

Type Parameters:

R - - type of result

Parameters:

mode - - execution mode

shaDigest - - SHA-1 digest

returnType - - return type

keys - - keys available through KEYS param in script

values - - values available through VALUES param in script

Returns:

result object

evalSha

<R> io.reactivex.Maybe<R> evalSha(String key,
                                  RScript.Mode mode,
                                  String shaDigest,
                                  RScript.ReturnType returnType,
                                  List<Object> keys,
                                  Object... values)

Executes Lua script stored in Redis scripts cache by SHA-1 digest

Type Parameters:

R - - type of result

Parameters:

key - - used to locate Redis node in Cluster which stores cached Lua script

mode - - execution mode

shaDigest - - SHA-1 digest

returnType - - return type

keys - - keys available through KEYS param in script

values - - values available through VALUES param in script

Returns:

result object

evalSha

<R> io.reactivex.Maybe<R> evalSha(RScript.Mode mode,
                                  String shaDigest,
                                  RScript.ReturnType returnType)

Executes Lua script stored in Redis scripts cache by SHA-1 digest

Type Parameters:

R - - type of result

Parameters:

mode - - execution mode

shaDigest - - SHA-1 digest

returnType - - return type

Returns:

result object

eval

<R> io.reactivex.Maybe<R> eval(RScript.Mode mode,
                               String luaScript,
                               RScript.ReturnType returnType,
                               List<Object> keys,
                               Object... values)

Executes Lua script

Type Parameters:

R - - type of result

Parameters:

mode - - execution mode

luaScript - - lua script

returnType - - return type

keys - - keys available through KEYS param in script

values - - values available through VALUES param in script

Returns:

result object

eval

<R> io.reactivex.Maybe<R> eval(RScript.Mode mode,
                               String luaScript,
                               RScript.ReturnType returnType)

Executes Lua script

Type Parameters:

R - - type of result

Parameters:

mode - - execution mode

luaScript - - lua script

returnType - - return type

Returns:

result object

eval

<R> io.reactivex.Maybe<R> eval(String key,
                               RScript.Mode mode,
                               String luaScript,
                               RScript.ReturnType returnType,
                               List<Object> keys,
                               Object... values)

Executes Lua script

Type Parameters:

R - - type of result

Parameters:

key - - used to locate Redis node in Cluster which stores cached Lua script

mode - - execution mode

luaScript - - lua script

returnType - - return type

keys - - keys available through KEYS param in script

values - - values available through VALUES param in script

Returns:

result object

scriptLoad

io.reactivex.Single<String> scriptLoad(String luaScript)

Loads Lua script into Redis scripts cache and returns its SHA-1 digest

Parameters:

luaScript - - lua script

Returns:

SHA-1 digest

scriptExists

io.reactivex.Single<List<Boolean>> scriptExists(String... shaDigests)

Checks for presence Lua scripts in Redis script cache by SHA-1 digest.

Parameters:

shaDigests - - collection of SHA-1 digests

Returns:

list of booleans corresponding to collection SHA-1 digests

scriptKill

io.reactivex.Completable scriptKill()

Kills currently executed Lua script

Returns:

void