| | | 1 | | // Copyright (c) ZeroC, Inc. |
| | | 2 | | |
| | | 3 | | using System.Buffers; |
| | | 4 | | using System.Diagnostics; |
| | | 5 | | |
| | | 6 | | namespace IceRpc.Transports.Slic.Internal; |
| | | 7 | | |
| | | 8 | | /// <summary>Decorates <see cref="ReadAsync" /> to fail if no byte is received for over idle timeout. Also optionally |
| | | 9 | | /// decorates both <see cref="ReadAsync"/> and <see cref="WriteAsync" /> to schedule pings that prevent both the local |
| | | 10 | | /// and remote idle timers from expiring.</summary> |
| | | 11 | | internal class SlicDuplexConnectionDecorator : IDuplexConnection |
| | | 12 | | { |
| | | 13 | | private readonly IDuplexConnection _decoratee; |
| | 755 | 14 | | private TimeSpan _idleTimeout = Timeout.InfiniteTimeSpan; |
| | 755 | 15 | | private readonly CancellationTokenSource _readCts = new(); |
| | | 16 | | |
| | | 17 | | private readonly Timer? _readTimer; |
| | | 18 | | private readonly Timer? _writeTimer; |
| | | 19 | | |
| | | 20 | | public Task<TransportConnectionInformation> ConnectAsync(CancellationToken cancellationToken) => |
| | 733 | 21 | | _decoratee.ConnectAsync(cancellationToken); |
| | | 22 | | |
| | | 23 | | public void Dispose() |
| | 754 | 24 | | { |
| | 754 | 25 | | _decoratee.Dispose(); |
| | 754 | 26 | | _readCts.Dispose(); |
| | | 27 | | |
| | | 28 | | // Using Dispose is fine, there's no need to wait for the keep alive action to terminate if it's running. |
| | 754 | 29 | | _readTimer?.Dispose(); |
| | 754 | 30 | | _writeTimer?.Dispose(); |
| | 754 | 31 | | } |
| | | 32 | | |
| | | 33 | | public ValueTask<int> ReadAsync(Memory<byte> buffer, CancellationToken cancellationToken) |
| | 29368 | 34 | | { |
| | 29368 | 35 | | return _idleTimeout == Timeout.InfiniteTimeSpan ? |
| | 29368 | 36 | | _decoratee.ReadAsync(buffer, cancellationToken) : |
| | 29368 | 37 | | PerformReadAsync(); |
| | | 38 | | |
| | | 39 | | async ValueTask<int> PerformReadAsync() |
| | 28653 | 40 | | { |
| | | 41 | | try |
| | 28653 | 42 | | { |
| | 28653 | 43 | | using CancellationTokenRegistration _ = cancellationToken.UnsafeRegister( |
| | 304 | 44 | | cts => ((CancellationTokenSource)cts!).Cancel(), |
| | 28653 | 45 | | _readCts); |
| | 28653 | 46 | | _readCts.CancelAfter(_idleTimeout); // enable idle timeout before reading |
| | | 47 | | |
| | 28653 | 48 | | int bytesRead = await _decoratee.ReadAsync(buffer, _readCts.Token).ConfigureAwait(false); |
| | | 49 | | |
| | | 50 | | // After each successful read, we schedule one ping some time in the future. |
| | 28144 | 51 | | if (bytesRead > 0) |
| | 28008 | 52 | | { |
| | 28008 | 53 | | ResetReadTimer(); |
| | 28008 | 54 | | } |
| | | 55 | | // When 0, the other side called ShutdownWriteAsync, so there is no point to send a ping since we can't |
| | | 56 | | // get back a pong. |
| | | 57 | | |
| | 28144 | 58 | | return bytesRead; |
| | | 59 | | } |
| | 254 | 60 | | catch (OperationCanceledException) |
| | 254 | 61 | | { |
| | 254 | 62 | | cancellationToken.ThrowIfCancellationRequested(); |
| | | 63 | | |
| | 1 | 64 | | throw new IceRpcException( |
| | 1 | 65 | | IceRpcError.ConnectionIdle, |
| | 1 | 66 | | $"The connection did not receive any bytes for over {_idleTimeout.TotalSeconds} s."); |
| | | 67 | | } |
| | | 68 | | finally |
| | 28653 | 69 | | { |
| | 28653 | 70 | | _readCts.CancelAfter(Timeout.InfiniteTimeSpan); // disable idle timeout if not canceled |
| | 28653 | 71 | | } |
| | 28144 | 72 | | } |
| | 29368 | 73 | | } |
| | | 74 | | |
| | | 75 | | public Task ShutdownWriteAsync(CancellationToken cancellationToken) => |
| | 143 | 76 | | _decoratee.ShutdownWriteAsync(cancellationToken); |
| | | 77 | | |
| | | 78 | | public ValueTask WriteAsync(ReadOnlySequence<byte> buffer, CancellationToken cancellationToken) |
| | 6483 | 79 | | { |
| | 6483 | 80 | | return _idleTimeout == Timeout.InfiniteTimeSpan ? |
| | 6483 | 81 | | _decoratee.WriteAsync(buffer, cancellationToken) : |
| | 6483 | 82 | | PerformWriteAsync(); |
| | | 83 | | |
| | | 84 | | async ValueTask PerformWriteAsync() |
| | 6126 | 85 | | { |
| | 6126 | 86 | | await _decoratee.WriteAsync(buffer, cancellationToken).ConfigureAwait(false); |
| | | 87 | | |
| | | 88 | | // After each successful write, we schedule one ping some time in the future. Since each ping is itself a |
| | | 89 | | // write, if there is no application activity at all, we'll send successive pings at regular intervals. |
| | 6124 | 90 | | ResetWriteTimer(); |
| | 6124 | 91 | | } |
| | 6483 | 92 | | } |
| | | 93 | | |
| | | 94 | | /// <summary>Constructs a decorator that does nothing until it is enabled by a call to <see cref="Enable"/>. |
| | | 95 | | /// </summary> |
| | 1510 | 96 | | internal SlicDuplexConnectionDecorator(IDuplexConnection decoratee) => _decoratee = decoratee; |
| | | 97 | | |
| | | 98 | | /// <summary>Constructs a decorator that does nothing until it is enabled by a call to <see cref="Enable"/>. |
| | | 99 | | /// </summary> |
| | | 100 | | internal SlicDuplexConnectionDecorator( |
| | | 101 | | IDuplexConnection decoratee, |
| | | 102 | | Action sendReadPing, |
| | | 103 | | Action sendWritePing) |
| | 379 | 104 | | : this(decoratee) |
| | 379 | 105 | | { |
| | 394 | 106 | | _readTimer = new Timer(_ => sendReadPing()); |
| | 380 | 107 | | _writeTimer = new Timer(_ => sendWritePing()); |
| | 379 | 108 | | } |
| | | 109 | | |
| | | 110 | | /// <summary>Sets the idle timeout and schedules pings once the connection is established.</summary>. |
| | | 111 | | internal void Enable(TimeSpan idleTimeout) |
| | 676 | 112 | | { |
| | 676 | 113 | | Debug.Assert(idleTimeout != Timeout.InfiniteTimeSpan); |
| | 676 | 114 | | _idleTimeout = idleTimeout; |
| | | 115 | | |
| | 676 | 116 | | ResetReadTimer(); |
| | 676 | 117 | | ResetWriteTimer(); |
| | 676 | 118 | | } |
| | | 119 | | |
| | | 120 | | /// <summary>Resets the read timer. We send a "read" ping when this timer expires.</summary> |
| | | 121 | | /// <remarks>This method is no-op unless this decorator is constructed with send ping actions.</remarks> |
| | 28684 | 122 | | private void ResetReadTimer() => _readTimer?.Change(_idleTimeout * 0.5, Timeout.InfiniteTimeSpan); |
| | | 123 | | |
| | | 124 | | /// <summary>Resets the write timer. We send a "write" ping when this timer expires.</summary> |
| | | 125 | | /// <remarks>This method is no-op unless this decorator is constructed with send ping actions.</remarks> |
| | | 126 | | // The write timer factor (0.6) was chosen to be greater than the read timer factor (0.5). This way, when the |
| | | 127 | | // connection is completely idle, the read timer expires before the write timer and has time to send a ping that |
| | | 128 | | // resets the write timer. This reduces the likelihood of duplicate "keep alive" pings. |
| | 6800 | 129 | | private void ResetWriteTimer() => _writeTimer?.Change(_idleTimeout * 0.6, Timeout.InfiniteTimeSpan); |
| | | 130 | | } |