Nakama .NET 3.1.1
.NET client for Nakama server written in C
Nakama.RetryConfiguration Class Reference

A configuration for controlling retriable requests. More...

Public Member Functions

 RetryConfiguration (int baseDelay, int maxRetries)
 Create a new retry configuration. More...
 
 RetryConfiguration (int baseDelay, int maxRetries, RetryListener listener)
 Create a new retry configuration. More...
 
 RetryConfiguration (int baseDelay, int maxRetries, RetryListener listener, Jitter jitter)
 Create a new retry configuration. More...
 

Properties

int BaseDelay [get]
 The base delay (milliseconds) used to calculate the time before making another request attempt. This base will be raised to N, where N is the number of retry attempts. More...
 
Jitter Jitter [get]
 The jitter algorithm used to apply randomness to the retry delay. Defaults to RetryJitter.FullJitter More...
 
int MaxAttempts [get]
 The maximum number of attempts to make before cancelling the request task. More...
 
RetryListener RetryListener [get]
 A callback that is invoked before a new retry attempt is made. More...
 

Detailed Description

A configuration for controlling retriable requests.

Retry configurations can be assigned to the IClient on a request-by-request basis via the see <cref="RequestConfiguration"/> parameter.

Retry configurations can also be assigned on a global basis using IClient.GlobalRetryConfiguration. Configurations passed via the see <cref="RequestConfiguraiton"/> parameter take precedence over the global configuration.

Constructor & Destructor Documentation

◆ RetryConfiguration() [1/3]

Nakama.RetryConfiguration.RetryConfiguration ( int  baseDelay,
int  maxRetries 
)
inline

Create a new retry configuration.

Parameters
baseDelayThe base delay (milliseconds) used to calculate the time before making another request attempt.
maxRetriesThe maximum number of attempts to make before cancelling the request task.

◆ RetryConfiguration() [2/3]

Nakama.RetryConfiguration.RetryConfiguration ( int  baseDelay,
int  maxRetries,
RetryListener  listener 
)
inline

Create a new retry configuration.

Parameters
baseDelayThe base delay (milliseconds) used to calculate the time before making another request attempt.
maxRetriesThe maximum number of attempts to make before cancelling the request task.
listenerA callback that is invoked before a new retry attempt is made.

◆ RetryConfiguration() [3/3]

Nakama.RetryConfiguration.RetryConfiguration ( int  baseDelay,
int  maxRetries,
RetryListener  listener,
Jitter  jitter 
)
inline

Create a new retry configuration.

Parameters
baseDelayThe base delay (milliseconds) used to calculate the time before making another request attempt.
maxRetriesThe maximum number of attempts to make before cancelling the request task.
listenerA callback that is invoked before a new retry attempt is made.
jitter/// The jitter algorithm used to apply randomness to the retry delay.

Property Documentation

◆ BaseDelay

int Nakama.RetryConfiguration.BaseDelay
get

The base delay (milliseconds) used to calculate the time before making another request attempt. This base will be raised to N, where N is the number of retry attempts.

◆ Jitter

Jitter Nakama.RetryConfiguration.Jitter
get

The jitter algorithm used to apply randomness to the retry delay. Defaults to RetryJitter.FullJitter

◆ MaxAttempts

int Nakama.RetryConfiguration.MaxAttempts
get

The maximum number of attempts to make before cancelling the request task.

◆ RetryListener

RetryListener Nakama.RetryConfiguration.RetryListener
get

A callback that is invoked before a new retry attempt is made.


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