Zeebe C# Client 2.9.0
C# Client to communicate with an Zeebe Gateway
Loading...
Searching...
No Matches
Public Member Functions | List of all members
Zeebe.Client.Api.Builder.IZeebeClientFinalBuildStep Interface Reference
Inheritance diagram for Zeebe.Client.Api.Builder.IZeebeClientFinalBuildStep:
Zeebe.Client.Api.Builder.IZeebeSecureClientBuilder

Public Member Functions

IZeebeClientFinalBuildStep UseKeepAlive (TimeSpan keepAlive)
 Uses the given time interval to determine when to send a keepalive ping to the gateway. The default is 30 seconds.
 
IZeebeClientFinalBuildStep UseRetrySleepDurationProvider (Func< int, TimeSpan > sleepDurationProvider)
 Uses the given duration provider for the send retries. On each retry, the duration to wait is calculated by calling sleepDurationProvider with the current retry number (1 for first retry, 2 for second etc).
 
IZeebeClient Build ()
 Builds the client with the given configuration.
 

Member Function Documentation

◆ Build()

IZeebeClient Zeebe.Client.Api.Builder.IZeebeClientFinalBuildStep.Build ( )

Builds the client with the given configuration.

Returns
the client which was build with the given configuration.

◆ UseKeepAlive()

IZeebeClientFinalBuildStep Zeebe.Client.Api.Builder.IZeebeClientFinalBuildStep.UseKeepAlive ( TimeSpan keepAlive)

Uses the given time interval to determine when to send a keepalive ping to the gateway. The default is 30 seconds.

This is an optional configuration.

Parameters
keepAlivethe timespan between keep alive requests.
Returns
the final step builder.

◆ UseRetrySleepDurationProvider()

IZeebeClientFinalBuildStep Zeebe.Client.Api.Builder.IZeebeClientFinalBuildStep.UseRetrySleepDurationProvider ( Func< int, TimeSpan > sleepDurationProvider)

Uses the given duration provider for the send retries. On each retry, the duration to wait is calculated by calling sleepDurationProvider with the current retry number (1 for first retry, 2 for second etc).

This is an optional configuration. Per default the wait time provider provides base two wait time, 2^1 seconds, 2^2 seconds, 2^3 seconds etc. until one minute is reached.

Parameters
sleepDurationProviderThe function that provides the duration to wait for for a particular retry attempt.
Returns
the final step builder.
The documentation for this interface was generated from the following file: