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

Class EngineControlGrpc.EngineControlBlockingStub

java.lang.Object

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

io.grpc.stub.AbstractBlockingStub<EngineControlGrpc.EngineControlBlockingStub>

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

Enclosing class:

EngineControlGrpc

public static final class EngineControlGrpc.EngineControlBlockingStub
extends io.grpc.stub.AbstractBlockingStub<EngineControlGrpc.EngineControlBlockingStub>

A stub to allow clients to do limited synchronous 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.EngineControlBlockingStub	build(io.grpc.Channel channel, io.grpc.CallOptions callOptions)
Iterator<EngineControlOuterClass.RecordResponse>	getRecords(EngineControlOuterClass.GetRecordsRequest request)	Get all records from the in-memory engine.
EngineControlOuterClass.IncreaseTimeResponse	increaseTime(EngineControlOuterClass.IncreaseTimeRequest request)	Increases the engine time by a specific duration.
EngineControlOuterClass.ResetEngineResponse	resetEngine(EngineControlOuterClass.ResetEngineRequest request)	Resets the in-memory engine.
EngineControlOuterClass.StartEngineResponse	startEngine(EngineControlOuterClass.StartEngineRequest request)	Starts the in-memory engine.
EngineControlOuterClass.StopEngineResponse	stopEngine(EngineControlOuterClass.StopEngineRequest request)	Stops the in-memory engine.
EngineControlOuterClass.WaitForBusyStateResponse	waitForBusyState(EngineControlOuterClass.WaitForBusyStateRequest request)	Waits a given timeout for the engine to have reached a busy state.
EngineControlOuterClass.WaitForIdleStateResponse	waitForIdleState(EngineControlOuterClass.WaitForIdleStateRequest request)	Waits for the engine to have reached an idle state.

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, 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.EngineControlBlockingStub build(io.grpc.Channel channel,
 io.grpc.CallOptions callOptions)

Specified by:

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

startEngine

public EngineControlOuterClass.StartEngineResponse startEngine(EngineControlOuterClass.StartEngineRequest request)

Starts the in-memory engine.
 

stopEngine

public EngineControlOuterClass.StopEngineResponse stopEngine(EngineControlOuterClass.StopEngineRequest request)

Stops the in-memory engine.
 

resetEngine

public 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 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 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 EngineControlOuterClass.WaitForBusyStateResponse waitForBusyState(EngineControlOuterClass.WaitForBusyStateRequest request)

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

getRecords

public Iterator<EngineControlOuterClass.RecordResponse> getRecords(EngineControlOuterClass.GetRecordsRequest request)

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