Package io.camunda.zeebe.process.test.engine.protocol

Class EngineControlGrpc.EngineControlFutureStub

java.lang.Object

io.grpc.stub.AbstractStub<EngineControlGrpc.EngineControlFutureStub>

io.grpc.stub.AbstractFutureStub<EngineControlGrpc.EngineControlFutureStub>

io.camunda.zeebe.process.test.engine.protocol.EngineControlGrpc.EngineControlFutureStub

Enclosing class:

EngineControlGrpc

public static final class EngineControlGrpc.EngineControlFutureStub
extends io.grpc.stub.AbstractFutureStub<EngineControlGrpc.EngineControlFutureStub>

A stub to allow clients to do ListenableFuture-style rpc calls to service EngineControl.

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	Description
protected EngineControlGrpc.EngineControlFutureStub	build(io.grpc.Channel channel, io.grpc.CallOptions callOptions)
com.google.common.util.concurrent.ListenableFuture<EngineControlOuterClass.IncreaseTimeResponse>	increaseTime(EngineControlOuterClass.IncreaseTimeRequest request)	Increases the engine time by a specific duration.
com.google.common.util.concurrent.ListenableFuture<EngineControlOuterClass.ResetEngineResponse>	resetEngine(EngineControlOuterClass.ResetEngineRequest request)	Resets the in-memory engine.
com.google.common.util.concurrent.ListenableFuture<EngineControlOuterClass.StartEngineResponse>	startEngine(EngineControlOuterClass.StartEngineRequest request)	Starts the in-memory engine.
com.google.common.util.concurrent.ListenableFuture<EngineControlOuterClass.StopEngineResponse>	stopEngine(EngineControlOuterClass.StopEngineRequest request)	Stops the in-memory engine.
com.google.common.util.concurrent.ListenableFuture<EngineControlOuterClass.WaitForBusyStateResponse>	waitForBusyState(EngineControlOuterClass.WaitForBusyStateRequest request)	Waits a given timeout for the engine to have reached a busy state.
com.google.common.util.concurrent.ListenableFuture<EngineControlOuterClass.WaitForIdleStateResponse>	waitForIdleState(EngineControlOuterClass.WaitForIdleStateRequest request)	Waits for the engine to have reached an idle state.

Methods inherited from class io.grpc.stub.AbstractFutureStub

newStub, newStub

Methods inherited from class io.grpc.stub.AbstractStub

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

Methods inherited from class java.lang.Object

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

Method Details

build

protected EngineControlGrpc.EngineControlFutureStub build(io.grpc.Channel channel,
 io.grpc.CallOptions callOptions)

Specified by:

build in class io.grpc.stub.AbstractStub<EngineControlGrpc.EngineControlFutureStub>

startEngine

public com.google.common.util.concurrent.ListenableFuture<EngineControlOuterClass.StartEngineResponse> startEngine(EngineControlOuterClass.StartEngineRequest request)

Starts the in-memory engine.
 

stopEngine

public com.google.common.util.concurrent.ListenableFuture<EngineControlOuterClass.StopEngineResponse> stopEngine(EngineControlOuterClass.StopEngineRequest request)

Stops the in-memory engine.
 

resetEngine

public com.google.common.util.concurrent.ListenableFuture<EngineControlOuterClass.ResetEngineResponse> resetEngine(EngineControlOuterClass.ResetEngineRequest request)

Resets the in-memory engine. This is done by recreating the engine entirely.
The engine should be reset before executing the next test. This prevents
the tests from influencing each other.
Using this while running tests concurrently will still cause issues. This is
because the first test will be using the engine, whilst the second test will
reset it. Therefore, the data from the first test will get lost.
After resetting the engine still needs to be started.
 

increaseTime

public com.google.common.util.concurrent.ListenableFuture<EngineControlOuterClass.IncreaseTimeResponse> increaseTime(EngineControlOuterClass.IncreaseTimeRequest request)

Increases the engine time by a specific duration. Increasing the time could
be useful for when triggering timers with a date somewhere in the future.
 

waitForIdleState

public com.google.common.util.concurrent.ListenableFuture<EngineControlOuterClass.WaitForIdleStateResponse> waitForIdleState(EngineControlOuterClass.WaitForIdleStateRequest request)

Waits for the engine to have reached an idle state. Idle state is a state in
which the process engine makes no progress and is waiting for new commands
or events to trigger.
 

waitForBusyState

public com.google.common.util.concurrent.ListenableFuture<EngineControlOuterClass.WaitForBusyStateResponse> waitForBusyState(EngineControlOuterClass.WaitForBusyStateRequest request)

Waits a given timeout for the engine to have reached a busy state.