Zeebe.Client.Api.Commands.IFinalCommandWithRetryStep< T > Interface Template Reference

Inheritance diagram for Zeebe.Client.Api.Commands.IFinalCommandWithRetryStep< T >:

Public Member Functions
Task< T >	SendWithRetry (TimeSpan? timeout=null, CancellationToken token=default)
	Sends the command with retry to the Zeebe broker. This operation is asynchronous. In case of success, the task returns the event that was generated by the Zeebe broker in response to the command. If the sending of the command fails, because of broker back pressure or network issues the request is retried until the command succeeds. The wait time between retries can be configured on the ZeebeClientBuilder. Per default the wait time is based on power two, which means 2^1 seconds, 2^2 seconds etc. until it reaches the maximum of one minute.
Public Member Functions inherited from Zeebe.Client.Api.Commands.IFinalCommandStep< T >
Task< T >	Send (TimeSpan? timeout=null, CancellationToken token=default)
	Sends the command to the Zeebe broker. This operation is asynchronous. In case of success, the task returns the event that was generated by the Zeebe broker in response to the command.
Task< T >	Send (CancellationToken cancellationToken)
	Convenient method, which delegates to Send(TimeSpan? timeout = null, CancellationToken token = default).

Member Function Documentation

SendWithRetry()

Task< T > Zeebe.Client.Api.Commands.IFinalCommandWithRetryStep< T >.SendWithRetry	(	TimeSpan?	timeout = null,
		CancellationToken	token = default
	)

Sends the command with retry to the Zeebe broker. This operation is asynchronous. In case of success, the task returns the event that was generated by the Zeebe broker in response to the command. If the sending of the command fails, because of broker back pressure or network issues the request is retried until the command succeeds. The wait time between retries can be configured on the ZeebeClientBuilder. Per default the wait time is based on power two, which means 2^1 seconds, 2^2 seconds etc. until it reaches the maximum of one minute.

Use await ...SendWithRetry(); to wait until the response is available.

T response = await command.SendWithRetry();

Parameters

timeout	the time span after request should be timed out
token	the token that manages the cancellation of the request.

Returns

a task tracking state of success/failure of the command.

---

The documentation for this interface was generated from the following file:

• Client/Api/Commands/IFinalCommandWithRetryStep.cs