com.ibm.etcd.client.lease

Class EtcdLeaseClient

java.lang.Object

com.ibm.etcd.client.lease.EtcdLeaseClient

All Implemented Interfaces:

LeaseClient, Closeable, AutoCloseable

public final class EtcdLeaseClient
extends Object
implements LeaseClient, Closeable

Nested Class Summary

Nested classes/interfaces inherited from interface com.ibm.etcd.client.lease.LeaseClient

LeaseClient.FluentGrantRequest, LeaseClient.FluentMaintainRequest

Field Summary

Fields

Modifier and Type	Field and Description
protected Set<com.ibm.etcd.client.lease.EtcdLeaseClient.LeaseRecord>	allLeases
protected static int	DEFAULT_INTERVAL_SECS
protected static int	DEFAULT_MIN_EXPIRY_SECS
protected LeaseKeepAliveRequest.Builder	KAR_BUILDER
protected Executor	kaReqExecutor
protected io.grpc.stub.StreamObserver<LeaseKeepAliveRequest>	kaReqStream
protected int	leaseCount
protected ConcurrentMap<Long,com.ibm.etcd.client.lease.EtcdLeaseClient.LeaseRecord>	leaseMap
protected static int	MIN_INTERVAL_SECS
protected static int	MIN_MIN_EXPIRY_SECS
protected ConcurrentMap<Long,List<com.ibm.etcd.client.lease.EtcdLeaseClient.KeepAliveFuture>>	oneTimeMap
protected Executor	respExecutor
protected GrpcClient.ResilientResponseObserver<LeaseKeepAliveRequest,LeaseKeepAliveResponse>	responseObserver

Constructor Summary

Constructors

Constructor and Description
EtcdLeaseClient(GrpcClient client)

Method Summary

Modifier and Type	Method and Description
void	close()
com.google.common.util.concurrent.ListenableFuture<LeaseGrantResponse>	create(long leaseId, long ttlSecs) Deprecated.
LeaseClient.FluentGrantRequest	grant(long ttlSecs) Start a fluent grant request for "one time" lease establishment.
com.google.common.util.concurrent.ListenableFuture<LeaseKeepAliveResponse>	keepAliveOnce(long leaseId)
protected void	leaseClosed(com.ibm.etcd.client.lease.EtcdLeaseClient.LeaseRecord rec)
com.google.common.util.concurrent.ListenableFuture<LeaseLeasesResponse>	list() List all existing leases Supported in versions >= 3.3 only
LeaseClient.FluentMaintainRequest	maintain() Maintain a "persistent" lease.
protected PersistentLease	newPersisentLease(long leaseId, int minExpirySecs, int keepAliveFreqSecs, io.grpc.stub.StreamObserver<PersistentLease.LeaseState> observer, Executor executor, boolean protect)
com.google.common.util.concurrent.ListenableFuture<LeaseRevokeResponse>	revoke(long leaseId)
com.google.common.util.concurrent.ListenableFuture<LeaseRevokeResponse>	revoke(long leaseId, boolean ensureWithRetries)
protected void	sendKeepAlive(long leaseId)
com.google.common.util.concurrent.ListenableFuture<LeaseTimeToLiveResponse>	ttl(long leaseId, boolean includeKeys)

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.ibm.etcd.client.lease.LeaseClient

create, ttl

Field Detail

MIN_MIN_EXPIRY_SECS

protected static final int MIN_MIN_EXPIRY_SECS

See Also:

Constant Field Values

MIN_INTERVAL_SECS

protected static final int MIN_INTERVAL_SECS

See Also:

Constant Field Values

DEFAULT_MIN_EXPIRY_SECS

protected static final int DEFAULT_MIN_EXPIRY_SECS

See Also:

Constant Field Values

DEFAULT_INTERVAL_SECS

protected static final int DEFAULT_INTERVAL_SECS

See Also:

Constant Field Values

KAR_BUILDER

protected final LeaseKeepAliveRequest.Builder KAR_BUILDER

kaReqStream

protected io.grpc.stub.StreamObserver<LeaseKeepAliveRequest> kaReqStream

leaseCount

protected int leaseCount

kaReqExecutor

protected final Executor kaReqExecutor

respExecutor

protected final Executor respExecutor

allLeases

protected final Set<com.ibm.etcd.client.lease.EtcdLeaseClient.LeaseRecord> allLeases

leaseMap

protected final ConcurrentMap<Long,com.ibm.etcd.client.lease.EtcdLeaseClient.LeaseRecord> leaseMap

oneTimeMap

protected final ConcurrentMap<Long,List<com.ibm.etcd.client.lease.EtcdLeaseClient.KeepAliveFuture>> oneTimeMap

responseObserver

protected final GrpcClient.ResilientResponseObserver<LeaseKeepAliveRequest,LeaseKeepAliveResponse> responseObserver

Constructor Detail

EtcdLeaseClient

public EtcdLeaseClient(GrpcClient client)

Method Detail

create

@Deprecated
public com.google.common.util.concurrent.ListenableFuture<LeaseGrantResponse> create(long leaseId,
                                                                                                 long ttlSecs)

Deprecated.

Specified by:

create in interface LeaseClient

Returns:

future for LeaseGrantResponse

grant

public LeaseClient.FluentGrantRequest grant(long ttlSecs)

Description copied from interface: LeaseClient

Start a fluent grant request for "one time" lease establishment. If the lease is to be kept alive for some period, consider creating a PersistentLease via the LeaseClient.maintain() method.

Specified by:

grant in interface LeaseClient

revoke

public com.google.common.util.concurrent.ListenableFuture<LeaseRevokeResponse> revoke(long leaseId)

Specified by:

revoke in interface LeaseClient

Returns:

future for LeaseRevokeResponse

revoke

public com.google.common.util.concurrent.ListenableFuture<LeaseRevokeResponse> revoke(long leaseId,
                                                                                      boolean ensureWithRetries)

Specified by:

revoke in interface LeaseClient

ensureWithRetries - if true, the asynchronous request will be retried continuously in the background after connection failures (between back-off pauses)

Returns:

future for LeaseRevokeResponse

ttl

public com.google.common.util.concurrent.ListenableFuture<LeaseTimeToLiveResponse> ttl(long leaseId,
                                                                                       boolean includeKeys)

Specified by:

ttl in interface LeaseClient

Returns:

future for LeaseTimeToLiveResponse

keepAliveOnce

public com.google.common.util.concurrent.ListenableFuture<LeaseKeepAliveResponse> keepAliveOnce(long leaseId)

Specified by:

keepAliveOnce in interface LeaseClient

Returns:

future for LeaseKeepAliveResponse

list

public com.google.common.util.concurrent.ListenableFuture<LeaseLeasesResponse> list()

Description copied from interface: LeaseClient

List all existing leases

Supported in versions >= 3.3 only

Specified by:

list in interface LeaseClient

Returns:

future for LeaseLeasesResponse

maintain

public LeaseClient.FluentMaintainRequest maintain()

Description copied from interface: LeaseClient

Maintain a "persistent" lease. This will keep a lease alive indefinitely, creating or recreating it if it doesn't exist. It can be cancelled/revoked by closing the returned PersistentLease object.

Specifying a lease id is optional. If not provided it will be server-assigned. The return PersistentLease is also a future, which will be completed with the lease id when it is granted/confirmed.

NOTE sole "ownership" of the lease is assumed - i.e. the lease should not be revoked elsewhere.

Specified by:

maintain in interface LeaseClient

newPersisentLease

protected PersistentLease newPersisentLease(long leaseId,
                                            int minExpirySecs,
                                            int keepAliveFreqSecs,
                                            io.grpc.stub.StreamObserver<PersistentLease.LeaseState> observer,
                                            Executor executor,
                                            boolean protect)

leaseClosed

protected void leaseClosed(com.ibm.etcd.client.lease.EtcdLeaseClient.LeaseRecord rec)

sendKeepAlive

protected void sendKeepAlive(long leaseId)

close

public void close()

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable