AbstractSyncLock (Web Toys 0.3.4.sb2jdk8 API)

java.lang.Object
- cn.zhxu.toys.concurrent.AbstractSyncLock

所有已实现的接口:

SyncLock

直接已知子类:

RedisSyncLock, RedisTemplateSyncLock
```
public abstract class AbstractSyncLock
extends Object
implements SyncLock
```
Redis并发同步锁

从以下版本开始:

0.4.9

作者:

Troy.Zhou

构造器概要

构造器
构造器和说明

AbstractSyncLock()

构造器
构造器和说明
`AbstractSyncLock()`

方法概要

所有方法实例方法抽象方法具体方法
限定符和类型	方法和说明
`protected abstract boolean`	`doTryLock(String key, String requestId, int maxHoldSeconds)` 上锁
`protected abstract void`	`doUnLock(String key, String requestId)` 解锁
`String`	`getKeyPrefix()`
`protected String`	`getLockKey(String name)`
`int`	`getMaxHoldSeconds()`
`int`	`getMaxWaitSeconds()`
`String`	`getNodeId()`
`protected String`	`getRequestId()`
`int`	`getRetryInterval()`
`void`	`lock(String name)` 获取锁
`void`	`lock(String name, int maxHoldSeconds)` 获取锁
`void`	`lock(String name, int maxHoldSeconds, int maxWaitSeconds)` 获取锁
`void`	`lock(String name, String requestId)` 获取锁
`void`	`lock(String name, String requestId, int maxHoldSeconds)` 获取锁
`void`	`lock(String name, String requestId, int maxHoldSeconds, int maxWaitSeconds)` 获取锁
`void`	`release(String name)` 释放锁
`void`	`release(String name, String requestId)` 释放锁
`<V> V`	`run(String name, Callable<V> run)` 在锁内运行
`<V> V`	`run(String name, int maxHoldSeconds, Callable<V> run)` 在锁内运行
`<V> V`	`run(String name, int maxHoldSeconds, int maxWaitSeconds, Callable<V> run)` 在锁内运行
`<V> V`	`run(String name, String requestId, Callable<V> run)` 在锁内运行
`<V> V`	`run(String name, String requestId, int maxHoldSeconds, Callable<V> run)` 在锁内运行
`<V> V`	`run(String name, String requestId, int maxHoldSeconds, int maxWaitSeconds, Callable<V> run)` 在锁内运行
`void`	`setKeyPrefix(String keyPrefix)`
`void`	`setMaxHoldSeconds(int maxHoldSeconds)`
`void`	`setMaxWaitSeconds(int maxWaitSeconds)`
`void`	`setNodeId(String nodeId)`
`void`	`setRetryInterval(int retryInterval)`
`void`	`with(String name, int maxHoldSeconds, int maxWaitSeconds, Runnable run)` 在锁内运行
`void`	`with(String name, int maxHoldSeconds, Runnable run)` 在锁内运行
`void`	`with(String name, Runnable run)` 在锁内运行
`void`	`with(String name, String requestId, int maxHoldSeconds, int maxWaitSeconds, Runnable run)` 在锁内运行
`void`	`with(String name, String requestId, int maxHoldSeconds, Runnable run)` 在锁内运行
`void`	`with(String name, String requestId, Runnable run)` 在锁内运行

从类继承的方法 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- 构造器详细资料
  - AbstractSyncLock
```
public AbstractSyncLock()
```
- 方法详细资料
  - lock
```
public void lock(String name)
```
    从接口复制的说明: SyncLock
    
    获取锁
    
    指定者:
    
    lock 在接口中 SyncLock
    
    参数:
    
    name - 锁名称
  - lock
```
public void lock(String name,
                 int maxHoldSeconds)
```
    从接口复制的说明: SyncLock
    
    获取锁
    
    指定者:
    
    lock 在接口中 SyncLock
    
    参数:
    
    name - 锁名称
    
    maxHoldSeconds - 锁最大持有时间
  - lock
```
public void lock(String name,
                 int maxHoldSeconds,
                 int maxWaitSeconds)
```
    从接口复制的说明: SyncLock
    
    获取锁
    
    指定者:
    
    lock 在接口中 SyncLock
    
    参数:
    
    name - 锁名称
    
    maxHoldSeconds - 持有锁最大时间
    
    maxWaitSeconds - 等待锁最大时间
  - lock
```
public void lock(String name,
                 String requestId)
```
    从接口复制的说明: SyncLock
    
    获取锁
    
    指定者:
    
    lock 在接口中 SyncLock
    
    参数:
    
    name - 锁名称
    
    requestId - 请求者
  - lock
```
public void lock(String name,
                 String requestId,
                 int maxHoldSeconds)
```
    从接口复制的说明: SyncLock
    
    获取锁
    
    指定者:
    
    lock 在接口中 SyncLock
    
    参数:
    
    name - 锁名称
    
    requestId - 请求者
    
    maxHoldSeconds - 锁最大持有时间
  - lock
```
public void lock(String name,
                 String requestId,
                 int maxHoldSeconds,
                 int maxWaitSeconds)
```
    从接口复制的说明: SyncLock
    
    获取锁
    
    指定者:
    
    lock 在接口中 SyncLock
    
    参数:
    
    name - 锁名称
    
    requestId - 请求者
    
    maxHoldSeconds - 持有锁最大时间
    
    maxWaitSeconds - 等待锁最大时间
  - doTryLock
```
protected abstract boolean doTryLock(String key,
                                     String requestId,
                                     int maxHoldSeconds)
```
    上锁
    
    参数:
    
    key - 业务建
    
    requestId - 请求标识
    
    maxHoldSeconds - 最大持有时间
    
    返回:
    
    是否上锁成功
  - release
```
public void release(String name)
```
    从接口复制的说明: SyncLock
    
    释放锁
    
    指定者:
    
    release 在接口中 SyncLock
    
    参数:
    
    name - 锁名称
  - release
```
public void release(String name,
                    String requestId)
```
    从接口复制的说明: SyncLock
    
    释放锁
    
    指定者:
    
    release 在接口中 SyncLock
    
    参数:
    
    name - 锁名称
    
    requestId - 请求者
  - doUnLock
```
protected abstract void doUnLock(String key,
                                 String requestId)
```
    解锁
    
    参数:
    
    key - 业务建
    
    requestId - 请求标识
  - with
```
public void with(String name,
                 Runnable run)
```
    从接口复制的说明: SyncLock
    
    在锁内运行
    
    指定者:
    
    with 在接口中 SyncLock
    
    参数:
    
    name - 锁名称
    
    run - 任务
  - with
```
public void with(String name,
                 int maxHoldSeconds,
                 Runnable run)
```
    从接口复制的说明: SyncLock
    
    在锁内运行
    
    指定者:
    
    with 在接口中 SyncLock
    
    参数:
    
    name - 锁名称
    
    maxHoldSeconds - 锁最大持有时间
    
    run - 任务
  - with
```
public void with(String name,
                 int maxHoldSeconds,
                 int maxWaitSeconds,
                 Runnable run)
```
    从接口复制的说明: SyncLock
    
    在锁内运行
    
    指定者:
    
    with 在接口中 SyncLock
    
    参数:
    
    name - 锁名称
    
    maxHoldSeconds - 持有锁最大时间
    
    maxWaitSeconds - 等待锁最大时间
    
    run - 任务
  - with
```
public void with(String name,
                 String requestId,
                 Runnable run)
```
    从接口复制的说明: SyncLock
    
    在锁内运行
    
    指定者:
    
    with 在接口中 SyncLock
    
    参数:
    
    name - 锁名称
    
    requestId - 请求者
    
    run - 任务
  - with
```
public void with(String name,
                 String requestId,
                 int maxHoldSeconds,
                 Runnable run)
```
    从接口复制的说明: SyncLock
    
    在锁内运行
    
    指定者:
    
    with 在接口中 SyncLock
    
    参数:
    
    name - 锁名称
    
    requestId - 请求者
    
    maxHoldSeconds - 锁最大持有时间
    
    run - 任务
  - with
```
public void with(String name,
                 String requestId,
                 int maxHoldSeconds,
                 int maxWaitSeconds,
                 Runnable run)
```
    从接口复制的说明: SyncLock
    
    在锁内运行
    
    指定者:
    
    with 在接口中 SyncLock
    
    参数:
    
    name - 锁名称
    
    requestId - 请求者
    
    maxHoldSeconds - 持有锁最大时间
    
    maxWaitSeconds - 等待锁最大时间
    
    run - 任务
  - run
```
public <V> V run(String name,
                 Callable<V> run)
```
    从接口复制的说明: SyncLock
    
    在锁内运行
    
    指定者:
    
    run 在接口中 SyncLock
    
    参数:
    
    name - 锁名称
    
    run - 任务
    
    返回:
    
    the result of run
  - run
```
public <V> V run(String name,
                 int maxHoldSeconds,
                 Callable<V> run)
```
    从接口复制的说明: SyncLock
    
    在锁内运行
    
    指定者:
    
    run 在接口中 SyncLock
    
    参数:
    
    name - 锁名称
    
    maxHoldSeconds - 锁最大持有时间
    
    run - 任务
    
    返回:
    
    the result of run
  - run
```
public <V> V run(String name,
                 int maxHoldSeconds,
                 int maxWaitSeconds,
                 Callable<V> run)
```
    从接口复制的说明: SyncLock
    
    在锁内运行
    
    指定者:
    
    run 在接口中 SyncLock
    
    参数:
    
    name - 锁名称
    
    maxHoldSeconds - 持有锁最大时间
    
    maxWaitSeconds - 等待锁最大时间
    
    run - 任务
    
    返回:
    
    the result of run
  - run
```
public <V> V run(String name,
                 String requestId,
                 Callable<V> run)
```
    从接口复制的说明: SyncLock
    
    在锁内运行
    
    指定者:
    
    run 在接口中 SyncLock
    
    参数:
    
    name - 锁名称
    
    requestId - 请求者
    
    run - 任务
    
    返回:
    
    the result of run
  - run
```
public <V> V run(String name,
                 String requestId,
                 int maxHoldSeconds,
                 Callable<V> run)
```
    从接口复制的说明: SyncLock
    
    在锁内运行
    
    指定者:
    
    run 在接口中 SyncLock
    
    参数:
    
    name - 锁名称
    
    requestId - 请求者
    
    maxHoldSeconds - 锁最大持有时间
    
    run - 任务
    
    返回:
    
    the result of run
  - run
```
public <V> V run(String name,
                 String requestId,
                 int maxHoldSeconds,
                 int maxWaitSeconds,
                 Callable<V> run)
```
    从接口复制的说明: SyncLock
    
    在锁内运行
    
    指定者:
    
    run 在接口中 SyncLock
    
    参数:
    
    name - 锁名称
    
    requestId - 请求者
    
    maxHoldSeconds - 持有锁最大时间
    
    maxWaitSeconds - 等待锁最大时间
    
    run - 任务
    
    返回:
    
    the result of run
  - getLockKey
```
protected String getLockKey(String name)
```
  - getRequestId
```
protected String getRequestId()
```
  - getKeyPrefix
```
public String getKeyPrefix()
```
  - setKeyPrefix
```
public void setKeyPrefix(String keyPrefix)
```
  - getNodeId
```
public String getNodeId()
```
  - setNodeId
```
public void setNodeId(String nodeId)
```
  - getMaxHoldSeconds
```
public int getMaxHoldSeconds()
```
  - setMaxHoldSeconds
```
public void setMaxHoldSeconds(int maxHoldSeconds)
```
  - getMaxWaitSeconds
```
public int getMaxWaitSeconds()
```
  - setMaxWaitSeconds
```
public void setMaxWaitSeconds(int maxWaitSeconds)
```
  - getRetryInterval
```
public int getRetryInterval()
```
  - setRetryInterval
```
public void setRetryInterval(int retryInterval)
```

类 AbstractSyncLock

构造器概要

方法概要

从类继承的方法 java.lang.Object

构造器详细资料

AbstractSyncLock

方法详细资料

lock

lock

lock

lock

lock

lock

doTryLock

release

release

doUnLock

with

with

with

with

with

with

run

run

run

run

run

run

getLockKey

getRequestId

getKeyPrefix

setKeyPrefix

getNodeId

setNodeId

getMaxHoldSeconds

setMaxHoldSeconds

getMaxWaitSeconds

setMaxWaitSeconds

getRetryInterval

setRetryInterval