Package org.redisson

Class RedissonScript

org.redisson.RedissonScript

All Implemented Interfaces:

RScript, RScriptAsync

public class RedissonScript
extends 
implements RScript

Author:

Nikita Koksharov

Nested Class Summary

Nested classes/interfaces inherited from interface org.redisson.api.RScript

RScript.Mode, RScript.ReturnType

Constructor Summary

Constructors

Constructor	Description
RedissonScript(CommandAsyncExecutor commandExecutor)
RedissonScript(CommandAsyncExecutor commandExecutor, Codec codec)

Method Summary

Modifier and Type	Method	Description
<R> R	key, RScript.Mode mode, luaScript, RScript.ReturnType returnType, <> keys, ... values)	Executes Lua script
<R> R	eval(RScript.Mode mode, luaScript, RScript.ReturnType returnType)	Executes Lua script
<R> R	eval(RScript.Mode mode, luaScript, RScript.ReturnType returnType, <> keys, ... values)	Executes Lua script
<R> RFuture<R>	key, RScript.Mode mode, luaScript, RScript.ReturnType returnType, <> keys, ... values)	Executes Lua script
<R> RFuture<R>	evalAsync(RScript.Mode mode, luaScript, RScript.ReturnType returnType)	Executes Lua script
<R> RFuture<R>	evalAsync(RScript.Mode mode, luaScript, RScript.ReturnType returnType, <> keys, ... values)	Executes Lua script
<R> R	key, RScript.Mode mode, shaDigest, RScript.ReturnType returnType, <> keys, ... values)	Executes Lua script stored in Redis scripts cache by SHA-1 digest
<R> R	evalSha(RScript.Mode mode, shaDigest, RScript.ReturnType returnType)	Executes Lua script stored in Redis scripts cache by SHA-1 digest
<R> R	evalSha(RScript.Mode mode, shaDigest, RScript.ReturnType returnType, <> keys, ... values)	Executes Lua script stored in Redis scripts cache by SHA-1 digest
<R> RFuture<R>	key, RScript.Mode mode, shaDigest, RScript.ReturnType returnType, <> keys, ... values)	Executes Lua script stored in Redis scripts cache by SHA-1 digest
<R> RFuture<R>	key, RScript.Mode mode, Codec codec, shaDigest, RScript.ReturnType returnType, <> keys, ... values)
<R> RFuture<R>	evalShaAsync(RScript.Mode mode, shaDigest, RScript.ReturnType returnType)	Executes Lua script stored in Redis scripts cache by SHA-1 digest
<R> RFuture<R>	evalShaAsync(RScript.Mode mode, shaDigest, RScript.ReturnType returnType, <> keys, ... values)	Executes Lua script stored in Redis scripts cache by SHA-1 digest
<>	... shaDigests)	Checks for presence Lua scripts in Redis script cache by SHA-1 digest.
<>	key, ... shaDigests)
<>>	... shaDigests)	Checks for presence Lua scripts in Redis script cache by SHA-1 digest.
<>>	key, ... shaDigests)	Checks for presence Lua scripts in Redis script cache by SHA-1 digest.
void	scriptFlush()	Flushes Lua script cache.
void	key)
>	scriptFlushAsync()	Flushes Lua script cache.
>	key)
void	scriptKill()	Kills currently executed Lua script
void	key)
>	scriptKillAsync()	Kills currently executed Lua script
>	key)
	luaScript)	Loads Lua script into Redis scripts cache and returns its SHA-1 digest
	key, luaScript)
>	luaScript)	Loads Lua script into Redis scripts cache and returns its SHA-1 digest
>	key, luaScript)	Loads Lua script into Redis scripts cache and returns its SHA-1 digest

Methods inherited from class java.lang.

, , , , , , , , , ,

Constructor Detail

RedissonScript

public RedissonScript(CommandAsyncExecutor commandExecutor)

RedissonScript

public RedissonScript(CommandAsyncExecutor commandExecutor,
                      Codec codec)

Method Detail

scriptLoad

public  scriptLoad( luaScript)

Description copied from interface: RScript

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

Specified by:

scriptLoad in interface RScript

Parameters:

luaScript - - lua script

Returns:

SHA-1 digest

scriptLoad

public  scriptLoad( key,
                          luaScript)

scriptLoadAsync

public > scriptLoadAsync( luaScript)

Description copied from interface: RScriptAsync

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

Specified by:

scriptLoadAsync in interface RScriptAsync

Parameters:

luaScript - - lua script

Returns:

SHA-1 digest

scriptLoadAsync

public > scriptLoadAsync( key,
                                        luaScript)

Description copied from interface: RScriptAsync

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

Specified by:

scriptLoadAsync in interface RScriptAsync

Parameters:

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

luaScript - - lua script

Returns:

SHA-1 digest

eval

public <R> R eval(RScript.Mode mode,
                   luaScript,
                  RScript.ReturnType returnType)

Description copied from interface: RScript

Executes Lua script

Specified by:

eval in interface RScript

Type Parameters:

R - - type of result

Parameters:

mode - - execution mode

luaScript - - lua script

returnType - - return type

Returns:

result object

eval

public <R> R eval(RScript.Mode mode,
                   luaScript,
                  RScript.ReturnType returnType,
                  <> keys,
                  ... values)

Description copied from interface: RScript

Executes Lua script

Specified by:

eval in interface RScript

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

evalAsync

public <R> RFuture<R> evalAsync(RScript.Mode mode,
                                 luaScript,
                                RScript.ReturnType returnType,
                                <> keys,
                                ... values)

Description copied from interface: RScriptAsync

Executes Lua script

Specified by:

evalAsync in interface RScriptAsync

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

evalSha

public <R> R evalSha(RScript.Mode mode,
                      shaDigest,
                     RScript.ReturnType returnType)

Description copied from interface: RScript

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

Specified by:

evalSha in interface RScript

Type Parameters:

R - - type of result

Parameters:

mode - - execution mode

shaDigest - - SHA-1 digest

returnType - - return type

Returns:

result object

evalSha

public <R> R evalSha(RScript.Mode mode,
                      shaDigest,
                     RScript.ReturnType returnType,
                     <> keys,
                     ... values)

Description copied from interface: RScript

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

Specified by:

evalSha in interface RScript

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

evalShaAsync

public <R> RFuture<R> evalShaAsync(RScript.Mode mode,
                                    shaDigest,
                                   RScript.ReturnType returnType,
                                   <> keys,
                                   ... values)

Description copied from interface: RScriptAsync

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

Specified by:

evalShaAsync in interface RScriptAsync

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

evalShaAsync

public <R>  key,
                                   RScript.Mode mode,
                                   Codec codec,
                                    shaDigest,
                                   RScript.ReturnType returnType,
                                   <> keys,
                                   ... values)

scriptKill

public void scriptKill()

Description copied from interface: RScript

Kills currently executed Lua script

Specified by:

scriptKill in interface RScript

scriptKill

public void scriptKill( key)

scriptKillAsync

public > scriptKillAsync()

Description copied from interface: RScriptAsync

Kills currently executed Lua script

Specified by:

scriptKillAsync in interface RScriptAsync

Returns:

void

scriptKillAsync

public > scriptKillAsync( key)

scriptExists

public <> scriptExists(... shaDigests)

Description copied from interface: RScript

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

Specified by:

scriptExists in interface RScript

Parameters:

shaDigests - - collection of SHA-1 digests

Returns:

list of booleans corresponding to collection SHA-1 digests

scriptExistsAsync

public <>> scriptExistsAsync(... shaDigests)

Description copied from interface: RScriptAsync

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

Specified by:

scriptExistsAsync in interface RScriptAsync

Parameters:

shaDigests - - collection of SHA-1 digests

Returns:

list of booleans corresponding to collection SHA-1 digests

scriptExists

public <> scriptExists( key,
                                  ... shaDigests)

scriptExistsAsync

public <>> scriptExistsAsync( key,
                                                ... shaDigests)

Description copied from interface: RScriptAsync

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

Specified by:

scriptExistsAsync in interface RScriptAsync

Parameters:

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

shaDigests - - collection of SHA-1 digests

Returns:

list of booleans corresponding to collection SHA-1 digests

scriptFlush

public void scriptFlush()

Description copied from interface: RScript

Flushes Lua script cache.

Specified by:

scriptFlush in interface RScript

scriptFlush

public void scriptFlush( key)

scriptFlushAsync

public > scriptFlushAsync()

Description copied from interface: RScriptAsync

Flushes Lua script cache.

Specified by:

scriptFlushAsync in interface RScriptAsync

Returns:

void

scriptFlushAsync

public > scriptFlushAsync( key)

evalShaAsync

public <R> RFuture<R> evalShaAsync(RScript.Mode mode,
                                    shaDigest,
                                   RScript.ReturnType returnType)

Description copied from interface: RScriptAsync

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

Specified by:

evalShaAsync in interface RScriptAsync

Type Parameters:

R - - type of result

Parameters:

mode - - execution mode

shaDigest - - SHA-1 digest

returnType - - return type

Returns:

result object

evalAsync

public <R> RFuture<R> evalAsync(RScript.Mode mode,
                                 luaScript,
                                RScript.ReturnType returnType)

Description copied from interface: RScriptAsync

Executes Lua script

Specified by:

evalAsync in interface RScriptAsync

Type Parameters:

R - - type of result

Parameters:

mode - - execution mode

luaScript - - lua script

returnType - - return type

Returns:

result object

evalShaAsync

public <R>  key,
                                   RScript.Mode mode,
                                    shaDigest,
                                   RScript.ReturnType returnType,
                                   <> keys,
                                   ... values)

Description copied from interface: RScriptAsync

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

Specified by:

evalShaAsync in interface RScriptAsync

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

evalAsync

public <R>  key,
                                RScript.Mode mode,
                                 luaScript,
                                RScript.ReturnType returnType,
                                <> keys,
                                ... values)

Description copied from interface: RScriptAsync

Executes Lua script

Specified by:

evalAsync in interface RScriptAsync

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

evalSha

public <R> R evalSha( key,
                     RScript.Mode mode,
                      shaDigest,
                     RScript.ReturnType returnType,
                     <> keys,
                     ... values)

Description copied from interface: RScript

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

Specified by:

evalSha in interface RScript

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

eval

public <R> R eval( key,
                  RScript.Mode mode,
                   luaScript,
                  RScript.ReturnType returnType,
                  <> keys,
                  ... values)

Description copied from interface: RScript

Executes Lua script

Specified by:

eval in interface RScript

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