com.ibm.etcd.client.lock

Class EtcdLockClient

java.lang.Object

com.ibm.etcd.client.lock.EtcdLockClient

All Implemented Interfaces:

LockClient

public final class EtcdLockClient
extends Object
implements LockClient

Nested Class Summary

Nested classes/interfaces inherited from interface com.ibm.etcd.client.lock.LockClient

LockClient.FluentLockRequest, LockClient.FluentUnlockRequest

Field Summary

Fields

Modifier and Type	Field and Description
protected EtcdClient	etcdClient
protected GrpcClient	grpcClient

Constructor Summary

Constructors

Constructor and Description
EtcdLockClient(GrpcClient grpcClient, EtcdClient etcdClient)

Method Summary

Modifier and Type	Method and Description
LockClient.FluentLockRequest	lock(com.google.protobuf.ByteString name) Acquire a lock with the given name.
LockClient.FluentUnlockRequest	unlock(com.google.protobuf.ByteString key) Release the lock with the given key.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

etcdClient

protected final EtcdClient etcdClient

grpcClient

protected final GrpcClient grpcClient

Constructor Detail

EtcdLockClient

public EtcdLockClient(GrpcClient grpcClient,
                      EtcdClient etcdClient)

Method Detail

lock

public LockClient.FluentLockRequest lock(com.google.protobuf.ByteString name)

Description copied from interface: LockClient

Acquire a lock with the given name. Unless one of the withLease() methods is used, the lock will be tied to this client's session lease.

The response contains a key whose existence is tied to the caller's ownership of the lock. This key can be used in conjunction with transactions to safely ensure updates to etcd only occur while holding lock ownership. The lock is held until Unlock is called on the key or the lease associated with the owner expires.

Specified by:

lock in interface LockClient

Parameters:

name - unique name identifying the lock

unlock

public LockClient.FluentUnlockRequest unlock(com.google.protobuf.ByteString key)

Description copied from interface: LockClient

Release the lock with the given key.

Specified by:

unlock in interface LockClient

Parameters:

key - unique key returned in the LockResponse from the LockClient.lock(ByteString) method.