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

Interface EngineControlGrpc.AsyncService

All Known Implementing Classes:

EngineControlGrpc.EngineControlImplBase

Enclosing class:

EngineControlGrpc

public static interface EngineControlGrpc.AsyncService

Method Summary

Modifier and Type	Method	Description
default void	getRecords(EngineControlOuterClass.GetRecordsRequest request, io.grpc.stub.StreamObserver<EngineControlOuterClass.RecordResponse> responseObserver)	Get all records from the in-memory engine.
default void	increaseTime(EngineControlOuterClass.IncreaseTimeRequest request, io.grpc.stub.StreamObserver<EngineControlOuterClass.IncreaseTimeResponse> responseObserver)	Increases the engine time by a specific duration.
default void	resetEngine(EngineControlOuterClass.ResetEngineRequest request, io.grpc.stub.StreamObserver<EngineControlOuterClass.ResetEngineResponse> responseObserver)	Resets the in-memory engine.
default void	startEngine(EngineControlOuterClass.StartEngineRequest request, io.grpc.stub.StreamObserver<EngineControlOuterClass.StartEngineResponse> responseObserver)	Starts the in-memory engine.
default void	stopEngine(EngineControlOuterClass.StopEngineRequest request, io.grpc.stub.StreamObserver<EngineControlOuterClass.StopEngineResponse> responseObserver)	Stops the in-memory engine.
default void	waitForBusyState(EngineControlOuterClass.WaitForBusyStateRequest request, io.grpc.stub.StreamObserver<EngineControlOuterClass.WaitForBusyStateResponse> responseObserver)	Waits a given timeout for the engine to have reached a busy state.
default void	waitForIdleState(EngineControlOuterClass.WaitForIdleStateRequest request, io.grpc.stub.StreamObserver<EngineControlOuterClass.WaitForIdleStateResponse> responseObserver)	Waits for the engine to have reached an idle state.

Method Details

startEngine

default void startEngine(EngineControlOuterClass.StartEngineRequest request,
 io.grpc.stub.StreamObserver<EngineControlOuterClass.StartEngineResponse> responseObserver)

Starts the in-memory engine.
 

stopEngine

default void stopEngine(EngineControlOuterClass.StopEngineRequest request,
 io.grpc.stub.StreamObserver<EngineControlOuterClass.StopEngineResponse> responseObserver)

Stops the in-memory engine.
 

resetEngine

default void resetEngine(EngineControlOuterClass.ResetEngineRequest request,
 io.grpc.stub.StreamObserver<EngineControlOuterClass.ResetEngineResponse> responseObserver)

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

default void increaseTime(EngineControlOuterClass.IncreaseTimeRequest request,
 io.grpc.stub.StreamObserver<EngineControlOuterClass.IncreaseTimeResponse> responseObserver)

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

default void waitForIdleState(EngineControlOuterClass.WaitForIdleStateRequest request,
 io.grpc.stub.StreamObserver<EngineControlOuterClass.WaitForIdleStateResponse> responseObserver)

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

default void waitForBusyState(EngineControlOuterClass.WaitForBusyStateRequest request,
 io.grpc.stub.StreamObserver<EngineControlOuterClass.WaitForBusyStateResponse> responseObserver)

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

getRecords

default void getRecords(EngineControlOuterClass.GetRecordsRequest request,
 io.grpc.stub.StreamObserver<EngineControlOuterClass.RecordResponse> responseObserver)

Get all records from the in-memory engine. These records will be returned
in a JSON format. Client-side these should be mapped to Records.
For an easy way to serialize this JSON back to a Record please refer to:
https://github.com/camunda/zeebe/tree/main/protocol-jackson