Skip to content

Commit

Permalink
Update comments
Browse files Browse the repository at this point in the history
  • Loading branch information
stevejgordon committed Oct 30, 2024
1 parent 27cd6b1 commit d1c4f20
Showing 1 changed file with 11 additions and 0 deletions.
11 changes: 11 additions & 0 deletions src/Elastic.Transport/Responses/TransportResponse.cs
Original file line number Diff line number Diff line change
Expand Up @@ -40,9 +40,20 @@ public override string ToString() => ApiCallDetails?.DebugInformation
/// <summary>
/// Allows other disposable resources to to be disposed along with the response.
/// </summary>
/// <remarks>
/// While it's slightly confusing to have this on the base type which is NOT IDisposable, it avoids
/// specialised type checking in the request invoker and response builder code. Currently, only used by
/// StreamResponse and kept internal. If we later make this public, we might need to refine this.
/// </remarks>
[JsonIgnore]
internal IEnumerable<IDisposable>? LinkedDisposables { get; set; }

/// <summary>
/// Allows the response to identify that the response stream should NOT be automatically disposed.
/// </summary>
/// <remarks>
/// Currently only used by StreamResponse and therefore internal.
/// </remarks>
[JsonIgnore]
internal virtual bool LeaveOpen { get; } = false;
}
Expand Down

0 comments on commit d1c4f20

Please sign in to comment.