| | | 1 | | // Copyright (c) ZeroC, Inc. |
| | | 2 | | |
| | | 3 | | using System.Buffers; |
| | | 4 | | using System.Collections.Immutable; |
| | | 5 | | using System.IO.Pipelines; |
| | | 6 | | |
| | | 7 | | namespace IceRpc; |
| | | 8 | | |
| | | 9 | | /// <summary>Represents a response frame received by the application.</summary> |
| | | 10 | | public sealed class IncomingResponse : IncomingFrame |
| | | 11 | | { |
| | | 12 | | /// <summary>Gets the error message of this response.</summary> |
| | | 13 | | /// <value>The error message of this response. It is guaranteed to be non-<see langword="null" /> when <see |
| | | 14 | | /// cref="StatusCode" /> is different from <see cref="StatusCode.Ok" />, and <see langword="null" /> when <see |
| | | 15 | | /// cref="StatusCode" /> is <see cref="StatusCode.Ok" />.</value> |
| | 64 | 16 | | public string? ErrorMessage { get; } |
| | | 17 | | |
| | | 18 | | /// <summary>Gets the fields of this incoming response.</summary> |
| | | 19 | | /// <value>The fields of this incoming response. Defaults to <see cref="ImmutableDictionary{TKey, TValue}.Empty" |
| | | 20 | | /// />.</value> |
| | 6063 | 21 | | public IDictionary<ResponseFieldKey, ReadOnlySequence<byte>> Fields { get; private set; } |
| | | 22 | | |
| | | 23 | | /// <summary>Gets the <see cref="StatusCode" /> of this response.</summary> |
| | | 24 | | /// <value>The <see cref="IceRpc.StatusCode" /> of this response.</value> |
| | 415 | 25 | | public StatusCode StatusCode { get; } |
| | | 26 | | |
| | | 27 | | private readonly PipeReader? _fieldsPipeReader; |
| | | 28 | | |
| | | 29 | | /// <summary>Constructs an incoming response with empty fields.</summary> |
| | | 30 | | /// <param name="request">The corresponding outgoing request.</param> |
| | | 31 | | /// <param name="connectionContext">The connection context of the connection that received this response.</param> |
| | | 32 | | /// <param name="statusCode">The status code of this response.</param> |
| | | 33 | | /// <param name="errorMessage">The error message of this response.</param> |
| | | 34 | | /// <remarks>The constructor also associates this response with the request. If another response is already set on |
| | | 35 | | /// the request, its payload and payload continuation are completed.</remarks> |
| | | 36 | | public IncomingResponse( |
| | | 37 | | OutgoingRequest request, |
| | | 38 | | IConnectionContext connectionContext, |
| | | 39 | | StatusCode statusCode = StatusCode.Ok, |
| | | 40 | | string? errorMessage = null) |
| | 2622 | 41 | | : this( |
| | 2622 | 42 | | request, |
| | 2622 | 43 | | connectionContext, |
| | 2622 | 44 | | statusCode, |
| | 2622 | 45 | | errorMessage, |
| | 2622 | 46 | | ImmutableDictionary<ResponseFieldKey, ReadOnlySequence<byte>>.Empty, |
| | 2622 | 47 | | fieldsPipeReader: null) |
| | 2622 | 48 | | { |
| | 2622 | 49 | | } |
| | | 50 | | |
| | | 51 | | /// <summary>Constructs an incoming response.</summary> |
| | | 52 | | /// <param name="request">The corresponding outgoing request.</param> |
| | | 53 | | /// <param name="connectionContext">The connection context of the connection that received this response.</param> |
| | | 54 | | /// <param name="statusCode">The status code of this response.</param> |
| | | 55 | | /// <param name="errorMessage">The error message of this response.</param> |
| | | 56 | | /// <param name="fields">The fields of this response.</param> |
| | | 57 | | /// <remarks>The constructor also associates this response with the request. If another response is already set on |
| | | 58 | | /// the request, its payload and payload continuation are completed.</remarks> |
| | | 59 | | public IncomingResponse( |
| | | 60 | | OutgoingRequest request, |
| | | 61 | | IConnectionContext connectionContext, |
| | | 62 | | StatusCode statusCode, |
| | | 63 | | string? errorMessage, |
| | | 64 | | IDictionary<ResponseFieldKey, ReadOnlySequence<byte>> fields) |
| | 3 | 65 | | : this(request, connectionContext, statusCode, errorMessage, fields, fieldsPipeReader: null) |
| | 3 | 66 | | { |
| | 3 | 67 | | } |
| | | 68 | | |
| | | 69 | | /// <summary>Constructs an incoming response with a pipe reader holding the memory for the fields.</summary> |
| | | 70 | | /// <param name="request">The corresponding outgoing request.</param> |
| | | 71 | | /// <param name="connectionContext">The connection context of the connection that received this response.</param> |
| | | 72 | | /// <param name="statusCode">The status code of this response.</param> |
| | | 73 | | /// <param name="errorMessage">The error message of this response.</param> |
| | | 74 | | /// <param name="fields">The fields of this response.</param> |
| | | 75 | | /// <param name="fieldsPipeReader">The pipe reader that holds the memory of the fields. Use <see langword="null"/> |
| | | 76 | | /// when the fields memory is not held by a pipe reader.</param> |
| | | 77 | | /// <remarks>The constructor also associates this response with the request. If another response is already set on |
| | | 78 | | /// the request, its payload and payload continuation are completed.</remarks> |
| | | 79 | | internal IncomingResponse( |
| | | 80 | | OutgoingRequest request, |
| | | 81 | | IConnectionContext connectionContext, |
| | | 82 | | StatusCode statusCode, |
| | | 83 | | string? errorMessage, |
| | | 84 | | IDictionary<ResponseFieldKey, ReadOnlySequence<byte>> fields, |
| | | 85 | | PipeReader? fieldsPipeReader) |
| | 3014 | 86 | | : base(request.Protocol, connectionContext) |
| | 3014 | 87 | | { |
| | 3014 | 88 | | if (statusCode == StatusCode.Ok) |
| | 2907 | 89 | | { |
| | 2907 | 90 | | if (errorMessage is not null) |
| | 0 | 91 | | { |
| | 0 | 92 | | throw new ArgumentException( |
| | 0 | 93 | | $"The {nameof(errorMessage)} argument must be null when {nameof(statusCode)} is {nameof(StatusCode.O |
| | 0 | 94 | | nameof(errorMessage)); |
| | | 95 | | } |
| | 2907 | 96 | | } |
| | 107 | 97 | | else if (errorMessage is null) |
| | 0 | 98 | | { |
| | 0 | 99 | | throw new ArgumentException( |
| | 0 | 100 | | $"The {nameof(errorMessage)} argument must be non-null when {nameof(statusCode)} is greater than {nameof |
| | 0 | 101 | | nameof(errorMessage)); |
| | | 102 | | } |
| | | 103 | | |
| | 3014 | 104 | | StatusCode = statusCode; |
| | 3014 | 105 | | ErrorMessage = errorMessage; |
| | 3014 | 106 | | Fields = fields; |
| | 3014 | 107 | | _fieldsPipeReader = fieldsPipeReader; |
| | 3014 | 108 | | request.Response = this; |
| | 3014 | 109 | | } |
| | | 110 | | |
| | | 111 | | /// <summary>Completes the payload and releases the fields memory.</summary> |
| | | 112 | | /// <remarks>Dispose is internal because application code must dispose the outgoing request that owns this incoming |
| | | 113 | | /// response or create a different incoming response that disposes the previous response held by this outgoing |
| | | 114 | | /// request.</remarks> |
| | | 115 | | internal void Dispose() |
| | 3011 | 116 | | { |
| | 3011 | 117 | | Payload.Complete(); |
| | 3011 | 118 | | _fieldsPipeReader?.Complete(); |
| | 3011 | 119 | | Fields = ImmutableDictionary<ResponseFieldKey, ReadOnlySequence<byte>>.Empty; |
| | 3011 | 120 | | } |
| | | 121 | | } |