com.daml.ledger.api.v1.testing

Class ResetServiceGrpc.ResetServiceFutureStub

java.lang.Object

io.grpc.stub.AbstractStub<ResetServiceGrpc.ResetServiceFutureStub>

com.daml.ledger.api.v1.testing.ResetServiceGrpc.ResetServiceFutureStub

Enclosing class:

ResetServiceGrpc

public static final class ResetServiceGrpc.ResetServiceFutureStub
extends io.grpc.stub.AbstractStub<ResetServiceGrpc.ResetServiceFutureStub>

 Service to reset the ledger state. The goal here is to be able to reset the state in a way
 that's much faster compared to restarting the whole ledger application (be it a sandbox
 or the real ledger server).
 Note that *all* state present in the ledger implementation will be reset, most importantly
 including the ledger ID. This means that clients will have to re-fetch the ledger ID
 from the identity service after hitting this endpoint.
 The semantics are as follows:
 * When the reset service returns the reset is initiated, but not completed;
 * While the reset is performed, the ledger will not accept new requests. In fact we guarantee
   that ledger stops accepting new requests by the time the response to Reset is delivered;
 * In-flight requests might be aborted, we make no guarantees on when or how quickly this
   happens;
 * The ledger might be unavailable for a period of time before the reset is complete.
 Given the above, the recommended mode of operation for clients of the reset endpoint is to
 call it, then call the ledger identity endpoint in a retry loop that will tolerate a brief
 window when the ledger is down, and resume operation as soon as the new ledger ID is delivered.
 Note that this service will be available on the sandbox and might be available in some other testing
 environments, but will *never* be available in production.
 

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 ResetServiceGrpc.ResetServiceFutureStub	build(io.grpc.Channel channel, io.grpc.CallOptions callOptions)
com.google.common.util.concurrent.ListenableFuture<com.google.protobuf.Empty>	reset(ResetServiceOuterClass.ResetRequest request) Resets the ledger state.

Methods inherited from class io.grpc.stub.AbstractStub

getCallOptions, getChannel, newStub, newStub, 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 ResetServiceGrpc.ResetServiceFutureStub build(io.grpc.Channel channel,
                                                        io.grpc.CallOptions callOptions)

Specified by:

build in class io.grpc.stub.AbstractStub<ResetServiceGrpc.ResetServiceFutureStub>

reset

public com.google.common.util.concurrent.ListenableFuture<com.google.protobuf.Empty> reset(ResetServiceOuterClass.ResetRequest request)

 Resets the ledger state. Note that loaded DARs won't be removed -- this only rolls back the
 ledger to genesis.