com.ibm.etcd.client.lock

Interface LockClient

All Known Implementing Classes:

EtcdLockClient

public interface LockClient

Lock operations

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	LockClient.FluentLockRequest
static interface	LockClient.FluentUnlockRequest

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.

Method Detail

lock

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

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.

Parameters:

name - unique name identifying the lock

unlock

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

Release the lock with the given key.

Parameters:

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