com.ibm.etcd.client.lease

Interface PersistentLease

All Superinterfaces:

AutoCloseable, Closeable, Future<Long>, com.google.common.util.concurrent.ListenableFuture<Long>

public interface PersistentLease
extends com.google.common.util.concurrent.ListenableFuture<Long>, Closeable

A lease which is kept alive indefinitely and (re)created when necessary.

This class is also a future which completes with the lease id once the lease is created or verified.

Use the Closeable.close() method to cancel/revoke the lease

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	PersistentLease.LeaseState

Method Summary

Modifier and Type	Method and Description
void	addStateObserver(io.grpc.stub.StreamObserver<PersistentLease.LeaseState> observer, boolean publishInitialState)
long	getCurrentTtlSecs()
long	getKeepAliveTtlSecs()
long	getLeaseId()
long	getPreferredTtlSecs()
PersistentLease.LeaseState	getState()
void	removeStateObserver(io.grpc.stub.StreamObserver<PersistentLease.LeaseState> observer)

Methods inherited from interface com.google.common.util.concurrent.ListenableFuture

addListener

Methods inherited from interface java.util.concurrent.Future

cancel, get, get, isCancelled, isDone

Methods inherited from interface java.io.Closeable

close

Method Detail

getLeaseId

long getLeaseId()

Returns:

the leaseId, or 0 if pending

getState

PersistentLease.LeaseState getState()

Returns:

the current lease state

See Also:

PersistentLease.LeaseState

getPreferredTtlSecs

long getPreferredTtlSecs()

Returns:

the ttl which will be used if/when (re)creating the lease

getKeepAliveTtlSecs

long getKeepAliveTtlSecs()

Returns:

the ttl of the last successful keepalive, or -1 before initial grant

getCurrentTtlSecs

long getCurrentTtlSecs()

Returns:

the number of seconds before this lease expires, or -1 before initial grant

addStateObserver

void addStateObserver(io.grpc.stub.StreamObserver<PersistentLease.LeaseState> observer,
                      boolean publishInitialState)

Parameters:

observer -

publishInitialState - if true, the StreamObserver.onNext(Object) method of the supplied observer will be called first with the current state regardless of when it last changed. Subsequent callbacks will correspond to state changes.

removeStateObserver

void removeStateObserver(io.grpc.stub.StreamObserver<PersistentLease.LeaseState> observer)