Class TestServiceGrpc.TestServiceBlockingStub

java.lang.Object
io.grpc.stub.AbstractStub<TestServiceGrpc.TestServiceBlockingStub>
io.grpc.stub.AbstractBlockingStub<TestServiceGrpc.TestServiceBlockingStub>
io.temporal.api.testservice.v1.TestServiceGrpc.TestServiceBlockingStub
Enclosing class:
TestServiceGrpc

public static final class TestServiceGrpc.TestServiceBlockingStub extends io.grpc.stub.AbstractBlockingStub<TestServiceGrpc.TestServiceBlockingStub>
 TestService API defines an interface supported only by the Temporal Test Server.
 It provides functionality needed or supported for testing purposes only.
 This is an EXPERIMENTAL API.
 
  • Method Details

    • build

      protected TestServiceGrpc.TestServiceBlockingStub build(io.grpc.Channel channel, io.grpc.CallOptions callOptions)
      Specified by:
      build in class io.grpc.stub.AbstractStub<TestServiceGrpc.TestServiceBlockingStub>
    • lockTimeSkipping

      public LockTimeSkippingResponse lockTimeSkipping(LockTimeSkippingRequest request)
       LockTimeSkipping increments Time Locking Counter by one.
       If Time Locking Counter is positive, time skipping is locked (disabled).
       When time skipping is disabled, the time in test server is moving normally, with a real time pace.
       Test Server is typically started with locked time skipping and Time Locking Counter = 1.
       LockTimeSkipping and UnlockTimeSkipping calls are counted.
       
    • unlockTimeSkipping

      public UnlockTimeSkippingResponse unlockTimeSkipping(UnlockTimeSkippingRequest request)
       UnlockTimeSkipping decrements Time Locking Counter by one.
       If the counter reaches 0, it unlocks time skipping and fast forwards time.
       LockTimeSkipping and UnlockTimeSkipping calls are counted. Calling UnlockTimeSkipping does not
       guarantee that time is going to be fast forwarded as another lock can be holding it.
       Time Locking Counter can't be negative, unbalanced calls to UnlockTimeSkipping will lead to rpc call failure
       
    • sleep

      public SleepResponse sleep(SleepRequest request)
       This call returns only when the Test Server Time advances by the specified duration.
       This is an EXPERIMENTAL API.
       
    • sleepUntil

      public SleepResponse sleepUntil(SleepUntilRequest request)
       This call returns only when the Test Server Time advances to the specified timestamp.
       If the current Test Server Time is beyond the specified timestamp, returns immediately.
       This is an EXPERIMENTAL API.
       
    • unlockTimeSkippingWithSleep

      public SleepResponse unlockTimeSkippingWithSleep(SleepRequest request)
       UnlockTimeSkippingWhileSleep decreases time locking counter by one and increases it back
       once the Test Server Time advances by the duration specified in the request.
       This call returns only when the Test Server Time advances by the specified duration.
       If it is called when Time Locking Counter is
         - more than 1 and no other unlocks are coming in, rpc call will block for the specified duration, time will not be fast forwarded.
         - 1, it will lead to fast forwarding of the time by the duration specified in the request and quick return of this rpc call.
         - 0 will lead to rpc call failure same way as an unbalanced UnlockTimeSkipping.
       
    • getCurrentTime

      public GetCurrentTimeResponse getCurrentTime(com.google.protobuf.Empty request)
       GetCurrentTime returns the current Temporal Test Server time
       This time might not be equal to {@link System#currentTimeMillis()} due to time skipping.