TsgcSSEClient › Properties › ReconnectOptions

ReconnectOptions Property

Controls the automatic reconnection after the stream ends or a network error happens.

Syntax

property ReconnectOptions: TsgcSSEClient_ReconnectOptions read FReconnectOptions write SetReconnectOptions;

Default Value

Enabled = True, Interval = 3000

Remarks

The client reconnects when the stream ends or a network error happens, and it sends the Last-Event-ID header so the server can resume the stream. It does not reconnect when the server answers with an HTTP status other than 200, or with a content type other than text/event-stream. A status 204 stops the client without an error.

• Enabled: when False, the client closes instead of reconnecting. Default True.
• Interval: base delay in milliseconds before a reconnection. Default 3000. A retry: field sent by the server replaces this value for the rest of the session.
• MaxAttempts: maximum number of consecutive failed attempts before the client gives up and closes. 0 means no limit. The counter restarts every time a connection opens successfully. Default 0.
• Backoff: when True, the delay is multiplied by BackoffMultiplier on every consecutive attempt. Default False.
• BackoffMultiplier: growth factor used when Backoff is enabled. Default 2.0.
• MaxInterval: upper limit in milliseconds of the delay. 0 means no limit. Default 0.
• Jitter: random variation applied to the delay, as a fraction of it (0.2 means up to 20 percent). Default 0.

The final delay of every attempt can still be changed or cancelled from the OnReconnect event.

Example

oSSE.ReconnectOptions.Enabled := True;
oSSE.ReconnectOptions.Interval := 1000;
oSSE.ReconnectOptions.MaxAttempts := 10;
oSSE.ReconnectOptions.Backoff := True;
oSSE.ReconnectOptions.BackoffMultiplier := 2.0;
oSSE.ReconnectOptions.MaxInterval := 30000;
oSSE.ReconnectOptions.Jitter := 0.2;

Back to Properties