io.github.spring.tools.redis.capable

接口 ILockTemplate

所有已知子接口:

ILock, IRedisLock

所有已知实现类:

AbsLockDecorator, DefaultRedisLock, ReentrantLockDecorator

public interface ILockTemplate

Redis Lock callback 执行能力定义

定义了 redis 执行能力接口规范

版本:

1.0.0

作者:

Fenghu.Shi

方法概要

限定符和类型	方法和说明
default <T> T	execute(IDoCallback<T> callback) 委托执行，支持降级和回滚，如果获取所失败，则抛出异常，只尝试获取一次，失败立即返回
default <T> T	execute(IDoCallback<T> callback, IDoCallback<T> faultCallback) 委托执行，支持降级，只尝试获取一次，失败立即返回
default <T> T	execute(IDoCallback<T> callback, IDoCallback<T> faultCallback, IDoCallback<T> rollback) 委托执行，支持降级和回滚，只尝试获取一次，失败立即返回
<T> T	execute(IDoCallback<T> callback, IDoCallback<T> faultCallback, IDoCallback<T> rollback, int time, TimeUnit unit) 委托执行，支持降级和回滚，等待特定时间段，如果超时则失败
default <T> T	execute(IDoCallback<T> callback, IDoCallback<T> faultCallback, int time, TimeUnit unit) 委托执行，支持降级和回滚，等待特定时间段，如果超时则失败
default <T> T	execute(IDoCallback<T> callback, int time, TimeUnit unit) 委托执行，支持降级和回滚，等待特定时间段，如果超时则失败

方法详细资料

execute

default <T> T execute(IDoCallback<T> callback,
                      @Nullable
                      IDoCallback<T> faultCallback,
                      @Nullable
                      IDoCallback<T> rollback)
               throws TimeoutLockException,
                      Throwable

委托执行，支持降级和回滚，只尝试获取一次，失败立即返回

类型参数:

T - 返回值类型

参数:

callback - 获取锁成功执行的函数

faultCallback - 获取所失败后降级参数，=null 时，获取失败将抛出 SharedLockTimeoutException

rollback - 释放资源失败回退操作

返回:

返回值

抛出:

TimeoutLockException - 获取锁失败

Throwable - 其他异常，包括业务异常等

execute

default <T> T execute(IDoCallback<T> callback,
                      @Nullable
                      IDoCallback<T> faultCallback)
               throws TimeoutLockException,
                      Throwable

委托执行，支持降级，只尝试获取一次，失败立即返回

类型参数:

T - 返回值类型

参数:

callback - 获取所成功执行的函数

faultCallback - 获取所失败后降级参数，=null 时，获取失败将抛出 LockTimeoutException

返回:

返回值

抛出:

TimeoutLockException - 获取锁失败

Throwable - 其他异常，包括业务异常等

execute

default <T> T execute(IDoCallback<T> callback)
               throws TimeoutLockException,
                      Throwable

委托执行，支持降级和回滚，如果获取所失败，则抛出异常，只尝试获取一次，失败立即返回

类型参数:

T - 返回值类型

参数:

callback - 获取锁成功执行的函数

返回:

返回值

抛出:

TimeoutLockException - 获取锁失败

Throwable - 其他异常

execute

<T> T execute(IDoCallback<T> callback,
              @Nullable
              IDoCallback<T> faultCallback,
              @Nullable
              IDoCallback<T> rollback,
              int time,
              TimeUnit unit)
       throws TimeoutLockException,
              Throwable

委托执行，支持降级和回滚，等待特定时间段，如果超时则失败

类型参数:

T - 返回值类型

参数:

callback - 获取锁成功执行的函数

faultCallback - 获取所失败后降级参数，=null 时，获取失败将抛出 SharedLockTimeoutException

rollback - 释放资源失败回退操作

time - 等待时间

unit - 时间单位

返回:

返回值

抛出:

TimeoutLockException - 获取锁失败

Throwable - 其他异常，包括业务异常等

execute

default <T> T execute(IDoCallback<T> callback,
                      @Nullable
                      IDoCallback<T> faultCallback,
                      int time,
                      TimeUnit unit)
               throws TimeoutLockException,
                      Throwable

委托执行，支持降级和回滚，等待特定时间段，如果超时则失败

类型参数:

T - 返回值类型

参数:

callback - 获取锁成功执行的函数

faultCallback - 获取所失败后降级参数，=null 时，获取失败将抛出 SharedLockTimeoutException

time - 等待时间

unit - 时间单位

返回:

返回值

抛出:

TimeoutLockException - 获取锁失败

Throwable - 其他异常，包括业务异常等

execute

default <T> T execute(IDoCallback<T> callback,
                      int time,
                      TimeUnit unit)
               throws TimeoutLockException,
                      Throwable

委托执行，支持降级和回滚，等待特定时间段，如果超时则失败

类型参数:

T - 返回值类型

参数:

callback - 获取锁成功执行的函数

time - 等待时间

unit - 时间单位

返回:

返回值

抛出:

TimeoutLockException - 获取锁失败

Throwable - 其他异常，包括业务异常等