клиент ASP.NET Core SignalR .NET

Чтобы повторно подключиться к клиентам, можно настроить автоматическое повторное подключение или настроить повторное подключение вручную.

Автоматическое повторное подключение

HubConnection можно настроить для автоматического повторного подключения с помощью метода WithAutomaticReconnect объекта HubConnectionBuilder. По умолчанию он не выполняет автоматическое повторное подключение.

HubConnection connection= new HubConnectionBuilder()
    .WithUrl(new Uri("http://127.0.0.1:5000/chathub"))
    .WithAutomaticReconnect()
    .Build();

Без каких-либо параметров WithAutomaticReconnect() клиент настраивает ожидание 0, 2, 10 и 30 секунд соответственно перед попыткой повторного подключения. Он останавливается после четырех неудачных попыток.

Перед началом любых попыток повторного подключения HubConnection переходит в состояние HubConnectionState.Reconnecting и генерирует событие Reconnecting. Этот подход позволяет предупреждать пользователей о том, что подключение потеряно и отключает элементы пользовательского интерфейса. Неинтерактивные приложения могут начать ставить сообщения в очередь или отбрасывать их.

connection.Reconnecting += error =>
{
    Debug.Assert(connection.State == HubConnectionState.Reconnecting);

    // Notify users the connection was lost and the client is reconnecting.
    // Start queuing or dropping messages.

    return Task.CompletedTask;
};

Если клиент успешно переподключается в течение первых четырёх попыток, HubConnection снова переходит в состояние Connected и инициирует событие Reconnected. Этот подход позволяет информировать пользователей о том, что подключение теперь восстановлено, и вывести из очереди сообщения.

Поскольку соединение выглядит для сервера как совершенно новое, обработчикам события Reconnected передаётся новый ConnectionId.

connection.Reconnected += connectionId =>
{
    Debug.Assert(connection.State == HubConnectionState.Connected);

    // Notify users the connection was reestablished.
    // Start dequeuing messages queued while reconnecting if any.

    return Task.CompletedTask;
};

WithAutomaticReconnect() не настраивает HubConnection на повторные попытки при сбоях первоначального запуска, поэтому такие сбои необходимо обрабатывать вручную:

public static async Task<bool> ConnectWithRetryAsync(HubConnection connection, CancellationToken token)
{
    // Keep trying to until we can start or the token is canceled.
    while (true)
    {
        try
        {
            await connection.StartAsync(token);
            Debug.Assert(connection.State == HubConnectionState.Connected);
            return true;
        }
        catch when (token.IsCancellationRequested)
        {
            return false;
        }
        catch
        {
            // Failed to connect, trying again in 5000 ms.
            Debug.Assert(connection.State == HubConnectionState.Disconnected);
            await Task.Delay(5000);
        }
    }
}

Если клиенту не удаётся успешно переподключиться в течение первых четырёх попыток, HubConnection переходит в состояние Disconnected и вызывает событие Closed. Этот подход предоставляет возможность повторно перезапустить подключение вручную или сообщить пользователям, что подключение теперь окончательно потеряно.

connection.Closed += error =>
{
    Debug.Assert(connection.State == HubConnectionState.Disconnected);

    // Notify users the connection has been closed or manually try to restart the connection.

    return Task.CompletedTask;
};

Чтобы настроить настраиваемое количество попыток повторного подключения перед отключением или изменением времени повторного подключения, WithAutomaticReconnect принимает массив чисел, представляющих задержку в миллисекундах, чтобы ждать перед началом каждой попытки повторного подключения.

HubConnection connection = new HubConnectionBuilder()
    .WithUrl(new Uri("http://127.0.0.1:5000/chathub"))
    .WithAutomaticReconnect(new[] { TimeSpan.Zero, TimeSpan.Zero, TimeSpan.FromSeconds(10) })
    .Build();

    // .WithAutomaticReconnect(new[] { TimeSpan.Zero, TimeSpan.FromSeconds(2), TimeSpan.FromSeconds(10), TimeSpan.FromSeconds(30) }) yields the default behavior.

В предыдущем примере HubConnection настраивается так, чтобы он начинал пытаться выполнять повторные подключения сразу после потери соединения. Этот подход также относится к конфигурации по умолчанию.

• Если первая попытка повторного подключения завершается ошибкой, вторая попытка повторного подключения также запускается немедленно, а не ожидает 2 секунд, как определено в конфигурации по умолчанию.

• Если вторая попытка повторного подключения завершается сбоем, третья попытка повторного подключения начинается в 10 секунд, то это то же поведение, определенное в конфигурации по умолчанию.

• Пользовательское поведение затем снова отличается от поведения по умолчанию тем, что прекращается после третьей неудачной попытки переподключения. В конфигурации по умолчанию выполняется еще одна попытка повторного подключения через 30 секунд.

Для получения большего контроля над временем и количеством попыток WithAutomaticReconnect автоматического повторного подключения принимает объект, реализующий IRetryPolicy интерфейс, имеющий один метод с именем NextRetryDelay. NextRetryDelay принимает один аргумент с типом RetryContext. Имеет RetryContext три свойства: PreviousRetryCount (тип), long (типElapsedTimeTimeSpan) и RetryReason (типException).

• Перед первой попыткой повторного подключения и PreviousRetryCount, и ElapsedTime равны нулю (0), а RetryReason — это исключение, вызвавшее потерю соединения.

• После каждой неудачной повторной попытки PreviousRetryCount увеличивается на единицу, ElapsedTime обновляется, чтобы отразить время, затраченное на повторное подключение к текущему моменту, а RetryReason — это исключение, из-за которого последняя попытка повторного подключения завершилась ошибкой.

NextRetryDelay должен возвращать значение TimeSpan , представляющее время ожидания перед следующей попыткой повторного подключения или nullHubConnection если необходимо остановить повторное подключение.

public class RandomRetryPolicy : IRetryPolicy
{
    private readonly Random _random = new Random();

    public TimeSpan? NextRetryDelay(RetryContext retryContext)
    {
        // If we've been reconnecting for less than 60 seconds so far,
        // wait between 0 and 10 seconds before the next reconnect attempt.
        if (retryContext.ElapsedTime < TimeSpan.FromSeconds(60))
        {
            return TimeSpan.FromSeconds(_random.NextDouble() * 10);
        }
        else
        {
            // If we've been reconnecting for more than 60 seconds so far, stop reconnecting.
            return null;
        }
    }
}

HubConnection connection = new HubConnectionBuilder()
    .WithUrl(new Uri("http://127.0.0.1:5000/chathub"))
    .WithAutomaticReconnect(new RandomRetryPolicy())
    .Build();

Кроме того, можно написать код для повторного подключения клиента вручную, как показано в следующем разделе.