| | | 1 | | // Copyright (c) ZeroC, Inc. |
| | | 2 | | |
| | | 3 | | using System.Buffers; |
| | | 4 | | using System.Diagnostics; |
| | | 5 | | using System.IO.Pipelines; |
| | | 6 | | |
| | | 7 | | namespace IceRpc.Transports.Slic.Internal; |
| | | 8 | | |
| | | 9 | | /// <summary>A helper class to write data to a duplex connection. Its methods shouldn't be called concurrently. The data |
| | | 10 | | /// written to this writer is copied and buffered with an internal pipe. The data from the pipe is written on the duplex |
| | | 11 | | /// connection with a background task.</summary> |
| | | 12 | | internal class SlicDuplexConnectionWriter : IBufferWriter<byte>, IAsyncDisposable |
| | | 13 | | { |
| | 3008 | 14 | | internal Task WriterTask { get; private init; } |
| | | 15 | | |
| | | 16 | | private readonly IDuplexConnection _connection; |
| | 1369 | 17 | | private readonly CancellationTokenSource _disposeCts = new(); |
| | | 18 | | private Task? _disposeTask; |
| | | 19 | | private readonly Pipe _pipe; |
| | | 20 | | |
| | 178617 | 21 | | public void Advance(int bytes) => _pipe.Writer.Advance(bytes); |
| | | 22 | | |
| | | 23 | | /// <inheritdoc/> |
| | | 24 | | public ValueTask DisposeAsync() |
| | 1367 | 25 | | { |
| | 1367 | 26 | | _disposeTask ??= PerformDisposeAsync(); |
| | 1367 | 27 | | return new(_disposeTask); |
| | | 28 | | |
| | | 29 | | async Task PerformDisposeAsync() |
| | 1367 | 30 | | { |
| | 1367 | 31 | | _disposeCts.Cancel(); |
| | | 32 | | |
| | 1367 | 33 | | await WriterTask.ConfigureAwait(false); |
| | | 34 | | |
| | 1367 | 35 | | _pipe.Reader.Complete(); |
| | 1367 | 36 | | _pipe.Writer.Complete(); |
| | | 37 | | |
| | 1367 | 38 | | _disposeCts.Dispose(); |
| | 1367 | 39 | | } |
| | 1367 | 40 | | } |
| | | 41 | | |
| | | 42 | | /// <inheritdoc/> |
| | 0 | 43 | | public Memory<byte> GetMemory(int sizeHint = 0) => _pipe.Writer.GetMemory(sizeHint); |
| | | 44 | | |
| | | 45 | | /// <inheritdoc/> |
| | 178617 | 46 | | public Span<byte> GetSpan(int sizeHint = 0) => _pipe.Writer.GetSpan(sizeHint); |
| | | 47 | | |
| | | 48 | | /// <summary>Constructs a duplex connection writer.</summary> |
| | | 49 | | /// <param name="connection">The duplex connection to write to.</param> |
| | | 50 | | /// <param name="pool">The memory pool to use.</param> |
| | | 51 | | /// <param name="minimumSegmentSize">The minimum segment size for buffers allocated from <paramref |
| | | 52 | | /// name="pool"/>.</param> |
| | 1369 | 53 | | internal SlicDuplexConnectionWriter(IDuplexConnection connection, MemoryPool<byte> pool, int minimumSegmentSize) |
| | 1369 | 54 | | { |
| | 1369 | 55 | | _connection = connection; |
| | | 56 | | |
| | | 57 | | // We set pauseWriterThreshold to 0 because Slic implements flow-control at the stream level. So there's no need |
| | | 58 | | // to limit the amount of data buffered by the writer pipe. The amount of data buffered is limited to |
| | | 59 | | // (MaxBidirectionalStreams + MaxUnidirectionalStreams) * PeerPauseWriterThreshold bytes. |
| | 1369 | 60 | | _pipe = new Pipe(new PipeOptions( |
| | 1369 | 61 | | pool: pool, |
| | 1369 | 62 | | minimumSegmentSize: minimumSegmentSize, |
| | 1369 | 63 | | pauseWriterThreshold: 0, |
| | 1369 | 64 | | useSynchronizationContext: false)); |
| | | 65 | | |
| | 1369 | 66 | | WriterTask = Task.Run( |
| | 1369 | 67 | | async () => |
| | 1369 | 68 | | { |
| | 1369 | 69 | | try |
| | 1369 | 70 | | { |
| | 9975 | 71 | | while (true) |
| | 9975 | 72 | | { |
| | 9975 | 73 | | ReadResult readResult = await _pipe.Reader.ReadAsync(_disposeCts.Token).ConfigureAwait(false); |
| | 1369 | 74 | | |
| | 8898 | 75 | | if (!readResult.Buffer.IsEmpty) |
| | 8716 | 76 | | { |
| | 8716 | 77 | | await _connection.WriteAsync(readResult.Buffer, _disposeCts.Token).ConfigureAwait(false); |
| | 8696 | 78 | | _pipe.Reader.AdvanceTo(readResult.Buffer.End); |
| | 8696 | 79 | | } |
| | 1369 | 80 | | |
| | 8878 | 81 | | if (readResult.IsCompleted) |
| | 272 | 82 | | { |
| | 272 | 83 | | await _connection.ShutdownWriteAsync(_disposeCts.Token).ConfigureAwait(false); |
| | 268 | 84 | | break; |
| | 1369 | 85 | | } |
| | 8606 | 86 | | } |
| | 268 | 87 | | _pipe.Reader.Complete(); |
| | 268 | 88 | | } |
| | 1093 | 89 | | catch (OperationCanceledException) |
| | 1093 | 90 | | { |
| | 1369 | 91 | | // DisposeAsync was called. |
| | 1093 | 92 | | } |
| | 6 | 93 | | catch (Exception exception) |
| | 6 | 94 | | { |
| | 6 | 95 | | _pipe.Reader.Complete(exception); |
| | 6 | 96 | | } |
| | 2736 | 97 | | }); |
| | 1369 | 98 | | } |
| | | 99 | | |
| | | 100 | | internal void Flush() |
| | 25592 | 101 | | { |
| | 25592 | 102 | | ValueTask<FlushResult> flushResult = _pipe.Writer.FlushAsync(CancellationToken.None); |
| | | 103 | | |
| | | 104 | | // PauseWriterThreshold is 0 so FlushAsync should always complete synchronously. |
| | 25592 | 105 | | Debug.Assert(flushResult.IsCompletedSuccessfully); |
| | 25592 | 106 | | } |
| | | 107 | | |
| | | 108 | | /// <summary>Requests the shut down of the duplex connection writes after the buffered data is written on the |
| | | 109 | | /// duplex connection.</summary> |
| | | 110 | | internal void Shutdown() => |
| | | 111 | | // Completing the pipe writer makes the background write task complete successfully. |
| | 272 | 112 | | _pipe.Writer.Complete(); |
| | | 113 | | } |