com.ibm.etcd.api

Class LockGrpc.LockBlockingStub

java.lang.Object

io.grpc.stub.AbstractStub<S>

io.grpc.stub.AbstractBlockingStub<LockGrpc.LockBlockingStub>

com.ibm.etcd.api.LockGrpc.LockBlockingStub

Enclosing class:

LockGrpc

public static final class LockGrpc.LockBlockingStub
extends io.grpc.stub.AbstractBlockingStub<LockGrpc.LockBlockingStub>

A stub to allow clients to do synchronous rpc calls to service Lock.

 The lock service exposes client-side locking facilities as a gRPC interface.
 

Nested Class Summary

Nested classes/interfaces inherited from class io.grpc.stub.AbstractStub

io.grpc.stub.AbstractStub.StubFactory<T extends io.grpc.stub.AbstractStub<T>>

Method Summary

Modifier and Type	Method and Description
protected LockGrpc.LockBlockingStub	build(io.grpc.Channel channel, io.grpc.CallOptions callOptions)
LockResponse	lock(LockRequest request) Lock acquires a distributed shared lock on a given named lock.
UnlockResponse	unlock(UnlockRequest request) Unlock takes a key returned by Lock and releases the hold on lock.

Methods inherited from class io.grpc.stub.AbstractBlockingStub

newStub, newStub

Methods inherited from class io.grpc.stub.AbstractStub

getCallOptions, getChannel, withCallCredentials, withChannel, withCompression, withDeadline, withDeadlineAfter, withExecutor, withInterceptors, withMaxInboundMessageSize, withMaxOutboundMessageSize, withOption, withWaitForReady

Methods inherited from class java.lang.Object

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

Method Detail

build

protected LockGrpc.LockBlockingStub build(io.grpc.Channel channel,
                                          io.grpc.CallOptions callOptions)

Specified by:

build in class io.grpc.stub.AbstractStub<LockGrpc.LockBlockingStub>

lock

public LockResponse lock(LockRequest request)

 Lock acquires a distributed shared lock on a given named lock.
 On success, it will return a unique key that exists so long as the
 lock is held by the caller. 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 associate with the owner expires.
 

unlock

public UnlockResponse unlock(UnlockRequest request)

 Unlock takes a key returned by Lock and releases the hold on lock. The
 next Lock caller waiting for the lock will then be woken up and given
 ownership of the lock.