| | | 1 | | // Copyright (c) ZeroC, Inc. |
| | | 2 | | |
| | | 3 | | using System.IO.Pipelines; |
| | | 4 | | |
| | | 5 | | namespace IceRpc; |
| | | 6 | | |
| | | 7 | | /// <summary>Represents the base class for outgoing frames.</summary> |
| | | 8 | | public abstract class OutgoingFrame |
| | | 9 | | { |
| | | 10 | | /// <summary>Gets or sets the payload of this frame.</summary> |
| | | 11 | | /// <value>The payload of this frame. Defaults to a <see cref="PipeReader" /> that returns an empty |
| | | 12 | | /// sequence.</value> |
| | | 13 | | /// <remarks>IceRPC completes the payload <see cref="PipeReader" /> with the <see |
| | | 14 | | /// cref="PipeReader.Complete(Exception?)" /> method. It never calls <see |
| | | 15 | | /// cref="PipeReader.CompleteAsync(Exception?)" />. The implementation of <see |
| | | 16 | | /// cref="PipeReader.Complete(Exception?)" /> should not block.</remarks> |
| | 24535 | 17 | | public PipeReader Payload { get; set; } = EmptyPipeReader.Instance; |
| | | 18 | | |
| | | 19 | | /// <summary>Gets or sets the payload continuation of this frame. The payload continuation is a continuation of <see |
| | | 20 | | /// cref="Payload"/>. The receiver cannot distinguish any seam between payload and payload continuation in the <see |
| | | 21 | | /// cref="IncomingFrame.Payload" /> it receives.</summary> |
| | | 22 | | /// <value>The payload continuation of this frame. Defaults to <see langword="null" /> meaning no |
| | | 23 | | /// continuation.</value> |
| | | 24 | | /// <remarks>IceRPC completes the payload continuation <see cref="PipeReader" /> with the <see |
| | | 25 | | /// cref="PipeReader.Complete(Exception?)" /> method. It never calls <see |
| | | 26 | | /// cref="PipeReader.CompleteAsync(Exception?)" />. The implementation of <see |
| | | 27 | | /// cref="PipeReader.Complete(Exception?)" /> should not block.</remarks> |
| | | 28 | | public PipeReader? PayloadContinuation |
| | | 29 | | { |
| | 9921 | 30 | | get => _payloadContinuation; |
| | | 31 | | set |
| | 200 | 32 | | { |
| | 200 | 33 | | _payloadContinuation = Protocol.HasPayloadContinuation || value is null ? |
| | 200 | 34 | | value : throw new NotSupportedException( |
| | 200 | 35 | | $"The '{Protocol}' protocol does not support payload continuation."); |
| | 200 | 36 | | } |
| | | 37 | | } |
| | | 38 | | |
| | | 39 | | /// <summary>Gets the protocol of this frame.</summary> |
| | | 40 | | /// <value>The <see cref="IceRpc.Protocol" /> value of this frame.</value> |
| | 6170 | 41 | | public Protocol Protocol { get; } |
| | | 42 | | |
| | | 43 | | private PipeReader? _payloadContinuation; |
| | | 44 | | |
| | | 45 | | private Stack<Func<PipeWriter, PipeWriter>>? _payloadWriterInterceptorStack; |
| | | 46 | | |
| | | 47 | | /// <summary>Installs a payload writer interceptor in this outgoing frame. This interceptor is executed just |
| | | 48 | | /// before sending <see cref="Payload" />, and is typically used to compress both <see cref="Payload" /> and |
| | | 49 | | /// <see cref="PayloadContinuation" />.</summary> |
| | | 50 | | /// <param name="payloadWriterInterceptor">The payload writer interceptor to install.</param> |
| | | 51 | | /// <returns>This outgoing frame.</returns> |
| | | 52 | | /// <remarks>IceRPC completes the payload writer <see cref="PipeWriter" /> with the <see |
| | | 53 | | /// cref="PipeWriter.Complete(Exception?)" /> method. It never calls <see |
| | | 54 | | /// cref="PipeWriter.CompleteAsync(Exception?)" />. The implementation of <see |
| | | 55 | | /// cref="PipeWriter.Complete(Exception?)" /> should not block.</remarks> |
| | | 56 | | public OutgoingFrame Use(Func<PipeWriter, PipeWriter> payloadWriterInterceptor) |
| | 13 | 57 | | { |
| | 13 | 58 | | if (!Protocol.SupportsPayloadWriterInterceptors) |
| | 0 | 59 | | { |
| | 0 | 60 | | throw new NotSupportedException( |
| | 0 | 61 | | $"The '{Protocol}' protocol does not support payload writer interceptors."); |
| | | 62 | | } |
| | 13 | 63 | | _payloadWriterInterceptorStack ??= new(); |
| | 13 | 64 | | _payloadWriterInterceptorStack.Push(payloadWriterInterceptor); |
| | 13 | 65 | | return this; |
| | 13 | 66 | | } |
| | | 67 | | |
| | | 68 | | /// <summary>Returns the payload writer to use when sending the payload.</summary> |
| | | 69 | | internal PipeWriter GetPayloadWriter(PipeWriter writer) |
| | 1832 | 70 | | { |
| | 1832 | 71 | | if (_payloadWriterInterceptorStack is not null) |
| | 13 | 72 | | { |
| | 65 | 73 | | foreach (Func<PipeWriter, PipeWriter> interceptor in _payloadWriterInterceptorStack) |
| | 13 | 74 | | { |
| | 13 | 75 | | writer = interceptor(writer); |
| | 13 | 76 | | } |
| | 13 | 77 | | } |
| | 1832 | 78 | | return writer; |
| | 1832 | 79 | | } |
| | | 80 | | |
| | | 81 | | /// <summary>Constructs an outgoing frame.</summary> |
| | | 82 | | /// <param name="protocol">The protocol used to send the frame.</param> |
| | 11998 | 83 | | private protected OutgoingFrame(Protocol protocol) => Protocol = protocol; |
| | | 84 | | } |