| | | 1 | | // Licensed to the .NET Foundation under one or more agreements. |
| | | 2 | | // The .NET Foundation licenses this file to you under the MIT license. |
| | | 3 | | |
| | | 4 | | using System.Collections.Generic; |
| | | 5 | | using System.Diagnostics; |
| | | 6 | | using System.Diagnostics.CodeAnalysis; |
| | | 7 | | using System.Diagnostics.Metrics; |
| | | 8 | | using System.IO; |
| | | 9 | | using System.Net.Http.Metrics; |
| | | 10 | | using System.Net.Security; |
| | | 11 | | using System.Runtime.ExceptionServices; |
| | | 12 | | using System.Runtime.Versioning; |
| | | 13 | | using System.Text; |
| | | 14 | | using System.Threading; |
| | | 15 | | using System.Threading.Tasks; |
| | | 16 | | |
| | | 17 | | namespace System.Net.Http |
| | | 18 | | { |
| | | 19 | | [UnsupportedOSPlatform("browser")] |
| | | 20 | | public sealed class SocketsHttpHandler : HttpMessageHandler |
| | | 21 | | { |
| | 0 | 22 | | private readonly HttpConnectionSettings _settings = new HttpConnectionSettings(); |
| | | 23 | | private HttpMessageHandlerStage? _handler; |
| | | 24 | | private Task<HttpMessageHandlerStage>? _handlerChainSetupTask; |
| | | 25 | | private Func<HttpConnectionSettings, HttpMessageHandlerStage, HttpMessageHandlerStage>? _decompressionHandlerFac |
| | | 26 | | private bool _disposed; |
| | | 27 | | |
| | | 28 | | // Accessed via UnsafeAccessor from HttpWebRequest. |
| | 0 | 29 | | internal HttpConnectionSettings Settings => _settings; |
| | | 30 | | |
| | | 31 | | private void CheckDisposedOrStarted() |
| | 0 | 32 | | { |
| | 0 | 33 | | ObjectDisposedException.ThrowIf(_disposed, this); |
| | 0 | 34 | | if (_handler != null) |
| | 0 | 35 | | { |
| | 0 | 36 | | throw new InvalidOperationException(SR.net_http_operation_started); |
| | | 37 | | } |
| | 0 | 38 | | } |
| | | 39 | | |
| | | 40 | | /// <summary> |
| | | 41 | | /// Gets a value that indicates whether the handler is supported on the current platform. |
| | | 42 | | /// </summary> |
| | | 43 | | [UnsupportedOSPlatformGuard("browser")] |
| | 0 | 44 | | public static bool IsSupported => !OperatingSystem.IsBrowser() && !OperatingSystem.IsWasi(); |
| | | 45 | | |
| | | 46 | | public bool UseCookies |
| | | 47 | | { |
| | 0 | 48 | | get => _settings._useCookies; |
| | | 49 | | set |
| | 0 | 50 | | { |
| | 0 | 51 | | CheckDisposedOrStarted(); |
| | 0 | 52 | | _settings._useCookies = value; |
| | 0 | 53 | | } |
| | | 54 | | } |
| | | 55 | | |
| | | 56 | | [AllowNull] |
| | | 57 | | public CookieContainer CookieContainer |
| | | 58 | | { |
| | 0 | 59 | | get => _settings._cookieContainer ??= new CookieContainer(); |
| | | 60 | | set |
| | 0 | 61 | | { |
| | 0 | 62 | | CheckDisposedOrStarted(); |
| | 0 | 63 | | _settings._cookieContainer = value; |
| | 0 | 64 | | } |
| | | 65 | | } |
| | | 66 | | |
| | | 67 | | public DecompressionMethods AutomaticDecompression |
| | | 68 | | { |
| | 0 | 69 | | get => _settings._automaticDecompression; |
| | | 70 | | set |
| | 0 | 71 | | { |
| | 0 | 72 | | CheckDisposedOrStarted(); |
| | 0 | 73 | | EnsureDecompressionHandlerFactory(); |
| | 0 | 74 | | _settings._automaticDecompression = value; |
| | 0 | 75 | | } |
| | | 76 | | } |
| | | 77 | | |
| | | 78 | | public bool UseProxy |
| | | 79 | | { |
| | 0 | 80 | | get => _settings._useProxy; |
| | | 81 | | set |
| | 0 | 82 | | { |
| | 0 | 83 | | CheckDisposedOrStarted(); |
| | 0 | 84 | | _settings._useProxy = value; |
| | 0 | 85 | | } |
| | | 86 | | } |
| | | 87 | | |
| | | 88 | | public IWebProxy? Proxy |
| | | 89 | | { |
| | 0 | 90 | | get => _settings._proxy; |
| | | 91 | | set |
| | 0 | 92 | | { |
| | 0 | 93 | | CheckDisposedOrStarted(); |
| | 0 | 94 | | _settings._proxy = value; |
| | 0 | 95 | | } |
| | | 96 | | } |
| | | 97 | | |
| | | 98 | | public ICredentials? DefaultProxyCredentials |
| | | 99 | | { |
| | 0 | 100 | | get => _settings._defaultProxyCredentials; |
| | | 101 | | set |
| | 0 | 102 | | { |
| | 0 | 103 | | CheckDisposedOrStarted(); |
| | 0 | 104 | | _settings._defaultProxyCredentials = value; |
| | 0 | 105 | | } |
| | | 106 | | } |
| | | 107 | | |
| | | 108 | | public bool PreAuthenticate |
| | | 109 | | { |
| | 0 | 110 | | get => _settings._preAuthenticate; |
| | | 111 | | set |
| | 0 | 112 | | { |
| | 0 | 113 | | CheckDisposedOrStarted(); |
| | 0 | 114 | | _settings._preAuthenticate = value; |
| | 0 | 115 | | } |
| | | 116 | | } |
| | | 117 | | |
| | | 118 | | public ICredentials? Credentials |
| | | 119 | | { |
| | 0 | 120 | | get => _settings._credentials; |
| | | 121 | | set |
| | 0 | 122 | | { |
| | 0 | 123 | | CheckDisposedOrStarted(); |
| | 0 | 124 | | _settings._credentials = value; |
| | 0 | 125 | | } |
| | | 126 | | } |
| | | 127 | | |
| | | 128 | | public bool AllowAutoRedirect |
| | | 129 | | { |
| | 0 | 130 | | get => _settings._allowAutoRedirect; |
| | | 131 | | set |
| | 0 | 132 | | { |
| | 0 | 133 | | CheckDisposedOrStarted(); |
| | 0 | 134 | | _settings._allowAutoRedirect = value; |
| | 0 | 135 | | } |
| | | 136 | | } |
| | | 137 | | |
| | | 138 | | public int MaxAutomaticRedirections |
| | | 139 | | { |
| | 0 | 140 | | get => _settings._maxAutomaticRedirections; |
| | | 141 | | set |
| | 0 | 142 | | { |
| | 0 | 143 | | ArgumentOutOfRangeException.ThrowIfNegativeOrZero(value); |
| | | 144 | | |
| | 0 | 145 | | CheckDisposedOrStarted(); |
| | 0 | 146 | | _settings._maxAutomaticRedirections = value; |
| | 0 | 147 | | } |
| | | 148 | | } |
| | | 149 | | |
| | | 150 | | public int MaxConnectionsPerServer |
| | | 151 | | { |
| | 0 | 152 | | get => _settings._maxConnectionsPerServer; |
| | | 153 | | set |
| | 0 | 154 | | { |
| | 0 | 155 | | ArgumentOutOfRangeException.ThrowIfNegativeOrZero(value); |
| | | 156 | | |
| | 0 | 157 | | CheckDisposedOrStarted(); |
| | 0 | 158 | | _settings._maxConnectionsPerServer = value; |
| | 0 | 159 | | } |
| | | 160 | | } |
| | | 161 | | |
| | | 162 | | public int MaxResponseDrainSize |
| | | 163 | | { |
| | 0 | 164 | | get => _settings._maxResponseDrainSize; |
| | | 165 | | set |
| | 0 | 166 | | { |
| | 0 | 167 | | ArgumentOutOfRangeException.ThrowIfNegative(value); |
| | | 168 | | |
| | 0 | 169 | | CheckDisposedOrStarted(); |
| | 0 | 170 | | _settings._maxResponseDrainSize = value; |
| | 0 | 171 | | } |
| | | 172 | | } |
| | | 173 | | |
| | | 174 | | public TimeSpan ResponseDrainTimeout |
| | | 175 | | { |
| | 0 | 176 | | get => _settings._maxResponseDrainTime; |
| | | 177 | | set |
| | 0 | 178 | | { |
| | 0 | 179 | | if ((value < TimeSpan.Zero && value != Timeout.InfiniteTimeSpan) || |
| | 0 | 180 | | (value.TotalMilliseconds > int.MaxValue)) |
| | 0 | 181 | | { |
| | 0 | 182 | | throw new ArgumentOutOfRangeException(nameof(value)); |
| | | 183 | | } |
| | | 184 | | |
| | 0 | 185 | | CheckDisposedOrStarted(); |
| | 0 | 186 | | _settings._maxResponseDrainTime = value; |
| | 0 | 187 | | } |
| | | 188 | | } |
| | | 189 | | |
| | | 190 | | public int MaxResponseHeadersLength |
| | | 191 | | { |
| | 0 | 192 | | get => _settings._maxResponseHeadersLength; |
| | | 193 | | set |
| | 0 | 194 | | { |
| | 0 | 195 | | ArgumentOutOfRangeException.ThrowIfNegativeOrZero(value); |
| | | 196 | | |
| | 0 | 197 | | CheckDisposedOrStarted(); |
| | 0 | 198 | | _settings._maxResponseHeadersLength = value; |
| | 0 | 199 | | } |
| | | 200 | | } |
| | | 201 | | |
| | | 202 | | [AllowNull] |
| | | 203 | | public SslClientAuthenticationOptions SslOptions |
| | | 204 | | { |
| | 0 | 205 | | get => _settings._sslOptions ??= new SslClientAuthenticationOptions(); |
| | | 206 | | set |
| | 0 | 207 | | { |
| | 0 | 208 | | CheckDisposedOrStarted(); |
| | 0 | 209 | | _settings._sslOptions = value; |
| | 0 | 210 | | } |
| | | 211 | | } |
| | | 212 | | |
| | | 213 | | public TimeSpan PooledConnectionLifetime |
| | | 214 | | { |
| | 0 | 215 | | get => _settings._pooledConnectionLifetime; |
| | | 216 | | set |
| | 0 | 217 | | { |
| | 0 | 218 | | if (value < TimeSpan.Zero && value != Timeout.InfiniteTimeSpan) |
| | 0 | 219 | | { |
| | 0 | 220 | | throw new ArgumentOutOfRangeException(nameof(value)); |
| | | 221 | | } |
| | | 222 | | |
| | 0 | 223 | | CheckDisposedOrStarted(); |
| | 0 | 224 | | _settings._pooledConnectionLifetime = value; |
| | 0 | 225 | | } |
| | | 226 | | } |
| | | 227 | | |
| | | 228 | | public TimeSpan PooledConnectionIdleTimeout |
| | | 229 | | { |
| | 0 | 230 | | get => _settings._pooledConnectionIdleTimeout; |
| | | 231 | | set |
| | 0 | 232 | | { |
| | 0 | 233 | | if (value < TimeSpan.Zero && value != Timeout.InfiniteTimeSpan) |
| | 0 | 234 | | { |
| | 0 | 235 | | throw new ArgumentOutOfRangeException(nameof(value)); |
| | | 236 | | } |
| | | 237 | | |
| | 0 | 238 | | CheckDisposedOrStarted(); |
| | 0 | 239 | | _settings._pooledConnectionIdleTimeout = value; |
| | 0 | 240 | | } |
| | | 241 | | } |
| | | 242 | | |
| | | 243 | | public TimeSpan ConnectTimeout |
| | | 244 | | { |
| | 0 | 245 | | get => _settings._connectTimeout; |
| | | 246 | | set |
| | 0 | 247 | | { |
| | 0 | 248 | | if ((value <= TimeSpan.Zero && value != Timeout.InfiniteTimeSpan) || |
| | 0 | 249 | | (value.TotalMilliseconds > int.MaxValue)) |
| | 0 | 250 | | { |
| | 0 | 251 | | throw new ArgumentOutOfRangeException(nameof(value)); |
| | | 252 | | } |
| | | 253 | | |
| | 0 | 254 | | CheckDisposedOrStarted(); |
| | 0 | 255 | | _settings._connectTimeout = value; |
| | 0 | 256 | | } |
| | | 257 | | } |
| | | 258 | | |
| | | 259 | | public TimeSpan Expect100ContinueTimeout |
| | | 260 | | { |
| | 0 | 261 | | get => _settings._expect100ContinueTimeout; |
| | | 262 | | set |
| | 0 | 263 | | { |
| | 0 | 264 | | if ((value < TimeSpan.Zero && value != Timeout.InfiniteTimeSpan) || |
| | 0 | 265 | | (value.TotalMilliseconds > int.MaxValue)) |
| | 0 | 266 | | { |
| | 0 | 267 | | throw new ArgumentOutOfRangeException(nameof(value)); |
| | | 268 | | } |
| | | 269 | | |
| | 0 | 270 | | CheckDisposedOrStarted(); |
| | 0 | 271 | | _settings._expect100ContinueTimeout = value; |
| | 0 | 272 | | } |
| | | 273 | | } |
| | | 274 | | |
| | | 275 | | /// <summary> |
| | | 276 | | /// Defines the initial HTTP2 stream receive window size for all connections opened by the this <see cref="Socke |
| | | 277 | | /// </summary> |
| | | 278 | | /// <remarks> |
| | | 279 | | /// Larger the values may lead to faster download speed, but potentially higher memory footprint. |
| | | 280 | | /// The property must be set to a value between 65535 and the configured maximum window size, which is 16777216 |
| | | 281 | | /// </remarks> |
| | | 282 | | public int InitialHttp2StreamWindowSize |
| | | 283 | | { |
| | 0 | 284 | | get => _settings._initialHttp2StreamWindowSize; |
| | | 285 | | set |
| | 0 | 286 | | { |
| | 0 | 287 | | if (value < HttpHandlerDefaults.DefaultInitialHttp2StreamWindowSize || value > GlobalHttpSettings.Socket |
| | 0 | 288 | | { |
| | 0 | 289 | | string message = SR.Format( |
| | 0 | 290 | | SR.net_http_http2_invalidinitialstreamwindowsize, |
| | 0 | 291 | | HttpHandlerDefaults.DefaultInitialHttp2StreamWindowSize, |
| | 0 | 292 | | GlobalHttpSettings.SocketsHttpHandler.MaxHttp2StreamWindowSize); |
| | | 293 | | |
| | 0 | 294 | | throw new ArgumentOutOfRangeException(nameof(InitialHttp2StreamWindowSize), message); |
| | | 295 | | } |
| | 0 | 296 | | CheckDisposedOrStarted(); |
| | 0 | 297 | | _settings._initialHttp2StreamWindowSize = value; |
| | 0 | 298 | | } |
| | | 299 | | } |
| | | 300 | | |
| | | 301 | | /// <summary> |
| | | 302 | | /// Gets or sets the maximum number of concurrent HTTP/2 streams a new connection may use before it observes |
| | | 303 | | /// the server's <c>SETTINGS_MAX_CONCURRENT_STREAMS</c> value. |
| | | 304 | | /// </summary> |
| | | 305 | | /// <remarks> |
| | | 306 | | /// <para> |
| | | 307 | | /// HTTP/2 lets the client start sending requests as soon as the connection is established, before the server |
| | | 308 | | /// has advertised how many concurrent streams it accepts. Until that <c>SETTINGS</c> frame arrives, the client |
| | | 309 | | /// optimistically allows up to this many streams, after which the server's value takes over. |
| | | 310 | | /// </para> |
| | | 311 | | /// <para> |
| | | 312 | | /// The default suits virtually all deployments and most users never need to change it. It is intended for the |
| | | 313 | | /// small subset of deployments where the server is known ahead of time to use a lower concurrency limit, and |
| | | 314 | | /// starting a connection with a matching value avoids the brief burst of requests above that limit. |
| | | 315 | | /// </para> |
| | | 316 | | /// <para> |
| | | 317 | | /// If an earlier connection to the same host advertised a lower limit, |
| | | 318 | | /// that lower value is used instead for new connections to that host. |
| | | 319 | | /// </para> |
| | | 320 | | /// <para> |
| | | 321 | | /// The value must be greater than or equal to 1. Defaults to 100. |
| | | 322 | | /// </para> |
| | | 323 | | /// </remarks> |
| | | 324 | | /// <exception cref="ArgumentOutOfRangeException">The value is zero or negative.</exception> |
| | | 325 | | public int InitialHttp2MaxConcurrentStreams |
| | | 326 | | { |
| | 0 | 327 | | get => _settings._initialHttp2MaxConcurrentStreams; |
| | | 328 | | set |
| | 0 | 329 | | { |
| | 0 | 330 | | ArgumentOutOfRangeException.ThrowIfNegativeOrZero(value); |
| | | 331 | | |
| | 0 | 332 | | CheckDisposedOrStarted(); |
| | 0 | 333 | | _settings._initialHttp2MaxConcurrentStreams = value; |
| | 0 | 334 | | } |
| | | 335 | | } |
| | | 336 | | |
| | | 337 | | /// <summary> |
| | | 338 | | /// Gets or sets the keep alive ping delay. The client will send a keep alive ping to the server if it |
| | | 339 | | /// doesn't receive any frames on a connection for this period of time. This property is used together with |
| | | 340 | | /// <see cref="SocketsHttpHandler.KeepAlivePingTimeout"/> to close broken connections. |
| | | 341 | | /// <para> |
| | | 342 | | /// Delay value must be greater than or equal to 1 second. Set to <see cref="Timeout.InfiniteTimeSpan"/> to |
| | | 343 | | /// disable the keep alive ping. |
| | | 344 | | /// Defaults to <see cref="Timeout.InfiniteTimeSpan"/>. |
| | | 345 | | /// </para> |
| | | 346 | | /// </summary> |
| | | 347 | | public TimeSpan KeepAlivePingDelay |
| | | 348 | | { |
| | 0 | 349 | | get => _settings._keepAlivePingDelay; |
| | | 350 | | set |
| | 0 | 351 | | { |
| | 0 | 352 | | if (value.Ticks < TimeSpan.TicksPerSecond && value != Timeout.InfiniteTimeSpan) |
| | 0 | 353 | | { |
| | 0 | 354 | | throw new ArgumentOutOfRangeException(nameof(value), value, SR.Format(SR.net_http_value_must_be_grea |
| | | 355 | | } |
| | | 356 | | |
| | 0 | 357 | | CheckDisposedOrStarted(); |
| | 0 | 358 | | _settings._keepAlivePingDelay = value; |
| | 0 | 359 | | } |
| | | 360 | | } |
| | | 361 | | |
| | | 362 | | /// <summary> |
| | | 363 | | /// Gets or sets the keep alive ping timeout. Keep alive pings are sent when a period of inactivity exceeds |
| | | 364 | | /// the configured <see cref="KeepAlivePingDelay"/> value. The client will close the connection if it |
| | | 365 | | /// doesn't receive any frames within the timeout. |
| | | 366 | | /// <para> |
| | | 367 | | /// Timeout must be greater than or equal to 1 second. Set to <see cref="Timeout.InfiniteTimeSpan"/> to |
| | | 368 | | /// disable the keep alive ping timeout. |
| | | 369 | | /// Defaults to 20 seconds. |
| | | 370 | | /// </para> |
| | | 371 | | /// </summary> |
| | | 372 | | public TimeSpan KeepAlivePingTimeout |
| | | 373 | | { |
| | 0 | 374 | | get => _settings._keepAlivePingTimeout; |
| | | 375 | | set |
| | 0 | 376 | | { |
| | 0 | 377 | | if (value.Ticks < TimeSpan.TicksPerSecond && value != Timeout.InfiniteTimeSpan) |
| | 0 | 378 | | { |
| | 0 | 379 | | throw new ArgumentOutOfRangeException(nameof(value), value, SR.Format(SR.net_http_value_must_be_grea |
| | | 380 | | } |
| | | 381 | | |
| | 0 | 382 | | CheckDisposedOrStarted(); |
| | 0 | 383 | | _settings._keepAlivePingTimeout = value; |
| | 0 | 384 | | } |
| | | 385 | | } |
| | | 386 | | |
| | | 387 | | /// <summary> |
| | | 388 | | /// Gets or sets the keep alive ping behaviour. Keep alive pings are sent when a period of inactivity exceeds |
| | | 389 | | /// the configured <see cref="KeepAlivePingDelay"/> value. |
| | | 390 | | /// </summary> |
| | | 391 | | public HttpKeepAlivePingPolicy KeepAlivePingPolicy |
| | | 392 | | { |
| | 0 | 393 | | get => _settings._keepAlivePingPolicy; |
| | | 394 | | set |
| | 0 | 395 | | { |
| | 0 | 396 | | CheckDisposedOrStarted(); |
| | 0 | 397 | | _settings._keepAlivePingPolicy = value; |
| | 0 | 398 | | } |
| | | 399 | | } |
| | | 400 | | |
| | | 401 | | /// <summary> |
| | | 402 | | /// Gets or sets a value that indicates whether additional HTTP/2 connections can be established to the same ser |
| | | 403 | | /// </summary> |
| | | 404 | | /// <remarks> |
| | | 405 | | /// Enabling multiple connections to the same server explicitly goes against <see href="https://www.rfc-editor.o |
| | | 406 | | /// </remarks> |
| | | 407 | | public bool EnableMultipleHttp2Connections |
| | | 408 | | { |
| | 0 | 409 | | get => _settings._enableMultipleHttp2Connections; |
| | | 410 | | set |
| | 0 | 411 | | { |
| | 0 | 412 | | CheckDisposedOrStarted(); |
| | | 413 | | |
| | 0 | 414 | | _settings._enableMultipleHttp2Connections = value; |
| | 0 | 415 | | } |
| | | 416 | | } |
| | | 417 | | |
| | | 418 | | /// <summary> |
| | | 419 | | /// Gets or sets a value that indicates whether additional HTTP/3 connections can be established to the same ser |
| | | 420 | | /// </summary> |
| | | 421 | | /// <remarks> |
| | | 422 | | /// Enabling multiple connections to the same server explicitly goes against <see href="https://www.rfc-editor.o |
| | | 423 | | /// </remarks> |
| | | 424 | | public bool EnableMultipleHttp3Connections |
| | | 425 | | { |
| | 0 | 426 | | get => _settings._enableMultipleHttp3Connections; |
| | | 427 | | set |
| | 0 | 428 | | { |
| | 0 | 429 | | CheckDisposedOrStarted(); |
| | | 430 | | |
| | 0 | 431 | | _settings._enableMultipleHttp3Connections = value; |
| | 0 | 432 | | } |
| | | 433 | | } |
| | | 434 | | |
| | | 435 | | internal const bool SupportsAutomaticDecompression = true; |
| | | 436 | | internal const bool SupportsProxy = true; |
| | | 437 | | internal const bool SupportsRedirectConfiguration = true; |
| | | 438 | | |
| | | 439 | | /// <summary> |
| | | 440 | | /// When non-null, a custom callback used to open new connections. |
| | | 441 | | /// </summary> |
| | | 442 | | public Func<SocketsHttpConnectionContext, CancellationToken, ValueTask<Stream>>? ConnectCallback |
| | | 443 | | { |
| | 0 | 444 | | get => _settings._connectCallback; |
| | | 445 | | set |
| | 0 | 446 | | { |
| | 0 | 447 | | CheckDisposedOrStarted(); |
| | 0 | 448 | | _settings._connectCallback = value; |
| | 0 | 449 | | } |
| | | 450 | | } |
| | | 451 | | |
| | | 452 | | /// <summary> |
| | | 453 | | /// Gets or sets a custom callback that provides access to the plaintext HTTP protocol stream. |
| | | 454 | | /// </summary> |
| | | 455 | | public Func<SocketsHttpPlaintextStreamFilterContext, CancellationToken, ValueTask<Stream>>? PlaintextStreamFilte |
| | | 456 | | { |
| | 0 | 457 | | get => _settings._plaintextStreamFilter; |
| | | 458 | | set |
| | 0 | 459 | | { |
| | 0 | 460 | | CheckDisposedOrStarted(); |
| | 0 | 461 | | _settings._plaintextStreamFilter = value; |
| | 0 | 462 | | } |
| | | 463 | | } |
| | | 464 | | |
| | | 465 | | /// <summary> |
| | | 466 | | /// Gets or sets a callback that decides whether a pooled connection should be evicted. |
| | | 467 | | /// </summary> |
| | | 468 | | /// <remarks> |
| | | 469 | | /// <para> |
| | | 470 | | /// When set, the callback is invoked for pooled connections with a |
| | | 471 | | /// <see cref="SocketsHttpConnectionEvictionContext"/> describing the connection. Returning <see langword="true" |
| | | 472 | | /// marks the connection for eviction: it will not be used to serve new requests and is retired once it |
| | | 473 | | /// becomes idle (an in-flight request on the connection is allowed to complete first). |
| | | 474 | | /// </para> |
| | | 475 | | /// <para> |
| | | 476 | | /// The callback is not guaranteed to run for every request, and it may run concurrently with the connection |
| | | 477 | | /// serving requests as well as concurrently for different connections. Because it is asynchronous, a caller |
| | | 478 | | /// may perform work such as a name resolution inside it; however, it is invoked for each pooled connection, so |
| | | 479 | | /// keeping it inexpensive (for example, consulting a cached resolution result) is recommended. The supplied |
| | | 480 | | /// <see cref="CancellationToken"/> is canceled if the connection is disposed while the callback is running. |
| | | 481 | | /// </para> |
| | | 482 | | /// <para> |
| | | 483 | | /// This callback complements <see cref="PooledConnectionLifetime"/>. Because a caller can use it to evict |
| | | 484 | | /// connections in response to their own DNS resolution, it makes it possible to set |
| | | 485 | | /// <see cref="PooledConnectionLifetime"/> to <see cref="Timeout.InfiniteTimeSpan"/> and |
| | | 486 | | /// retain otherwise healthy connections rather than recycling them purely to observe address changes. |
| | | 487 | | /// </para> |
| | | 488 | | /// </remarks> |
| | | 489 | | [Experimental(Experimentals.SocketsHttpHandlerExperimentalDiagId, UrlFormat = Experimentals.SharedUrlFormat)] |
| | | 490 | | public Func<SocketsHttpConnectionEvictionContext, CancellationToken, Task<bool>>? ShouldEvictConnection |
| | | 491 | | { |
| | 0 | 492 | | get => _settings._shouldEvictConnection; |
| | | 493 | | set |
| | 0 | 494 | | { |
| | 0 | 495 | | CheckDisposedOrStarted(); |
| | 0 | 496 | | _settings._shouldEvictConnection = value; |
| | 0 | 497 | | } |
| | | 498 | | } |
| | | 499 | | |
| | | 500 | | /// <summary> |
| | | 501 | | /// Gets a writable dictionary (that is, a map) of custom properties for the HttpClient requests. The dictionary |
| | | 502 | | /// </summary> |
| | | 503 | | public IDictionary<string, object?> Properties => |
| | 0 | 504 | | _settings._properties ??= new Dictionary<string, object?>(); |
| | | 505 | | |
| | | 506 | | /// <summary> |
| | | 507 | | /// Gets or sets a callback that returns the <see cref="Encoding"/> to encode the value for the specified reques |
| | | 508 | | /// or <see langword="null"/> to use the default behavior. |
| | | 509 | | /// </summary> |
| | | 510 | | public HeaderEncodingSelector<HttpRequestMessage>? RequestHeaderEncodingSelector |
| | | 511 | | { |
| | 0 | 512 | | get => _settings._requestHeaderEncodingSelector; |
| | | 513 | | set |
| | 0 | 514 | | { |
| | 0 | 515 | | CheckDisposedOrStarted(); |
| | 0 | 516 | | _settings._requestHeaderEncodingSelector = value; |
| | 0 | 517 | | } |
| | | 518 | | } |
| | | 519 | | |
| | | 520 | | /// <summary> |
| | | 521 | | /// Gets or sets a callback that returns the <see cref="Encoding"/> to decode the value for the specified respon |
| | | 522 | | /// or <see langword="null"/> to use the default behavior. |
| | | 523 | | /// </summary> |
| | | 524 | | public HeaderEncodingSelector<HttpRequestMessage>? ResponseHeaderEncodingSelector |
| | | 525 | | { |
| | 0 | 526 | | get => _settings._responseHeaderEncodingSelector; |
| | | 527 | | set |
| | 0 | 528 | | { |
| | 0 | 529 | | CheckDisposedOrStarted(); |
| | 0 | 530 | | _settings._responseHeaderEncodingSelector = value; |
| | 0 | 531 | | } |
| | | 532 | | } |
| | | 533 | | |
| | | 534 | | /// <summary> |
| | | 535 | | /// Gets or sets the <see cref="DistributedContextPropagator"/> to use when propagating the distributed trace an |
| | | 536 | | /// Use <see langword="null"/> to disable propagation. |
| | | 537 | | /// Defaults to <see cref="DistributedContextPropagator.Current"/>. |
| | | 538 | | /// </summary> |
| | | 539 | | [CLSCompliant(false)] |
| | | 540 | | public DistributedContextPropagator? ActivityHeadersPropagator |
| | | 541 | | { |
| | 0 | 542 | | get => _settings._activityHeadersPropagator; |
| | | 543 | | set |
| | 0 | 544 | | { |
| | 0 | 545 | | CheckDisposedOrStarted(); |
| | 0 | 546 | | _settings._activityHeadersPropagator = value; |
| | 0 | 547 | | } |
| | | 548 | | } |
| | | 549 | | |
| | | 550 | | /// <summary> |
| | | 551 | | /// Gets or sets the <see cref="IMeterFactory"/> to create a custom <see cref="Meter"/> for the <see cref="Socke |
| | | 552 | | /// </summary> |
| | | 553 | | /// <remarks> |
| | | 554 | | /// When <see cref="MeterFactory"/> is set to a non-<see langword="null"/> value, all metrics emitted by the <se |
| | | 555 | | /// will be recorded using the <see cref="Meter"/> provided by the <see cref="IMeterFactory"/>. |
| | | 556 | | /// </remarks> |
| | | 557 | | [CLSCompliant(false)] |
| | | 558 | | public IMeterFactory? MeterFactory |
| | | 559 | | { |
| | 0 | 560 | | get => _settings._meterFactory; |
| | | 561 | | set |
| | 0 | 562 | | { |
| | 0 | 563 | | CheckDisposedOrStarted(); |
| | 0 | 564 | | _settings._meterFactory = value; |
| | 0 | 565 | | } |
| | | 566 | | } |
| | | 567 | | |
| | | 568 | | internal ClientCertificateOption ClientCertificateOptions |
| | | 569 | | { |
| | 0 | 570 | | get => _settings._clientCertificateOptions; |
| | | 571 | | set |
| | 0 | 572 | | { |
| | 0 | 573 | | CheckDisposedOrStarted(); |
| | 0 | 574 | | _settings._clientCertificateOptions = value; |
| | 0 | 575 | | } |
| | | 576 | | } |
| | | 577 | | |
| | | 578 | | protected override void Dispose(bool disposing) |
| | 0 | 579 | | { |
| | 0 | 580 | | if (disposing && !_disposed) |
| | 0 | 581 | | { |
| | 0 | 582 | | _disposed = true; |
| | 0 | 583 | | _handler?.Dispose(); |
| | 0 | 584 | | } |
| | | 585 | | |
| | 0 | 586 | | base.Dispose(disposing); |
| | 0 | 587 | | } |
| | | 588 | | |
| | | 589 | | private HttpMessageHandlerStage SetupHandlerChain() |
| | 0 | 590 | | { |
| | | 591 | | // Clone the settings to get a relatively consistent view that won't change after this point. |
| | | 592 | | // (This isn't entirely complete, as some of the collections it contains aren't currently deeply cloned.) |
| | 0 | 593 | | HttpConnectionSettings settings = _settings.CloneAndNormalize(); |
| | | 594 | | |
| | 0 | 595 | | HttpConnectionPoolManager poolManager = new HttpConnectionPoolManager(settings); |
| | 0 | 596 | | HttpMessageHandlerStage handler = new HttpConnectionHandler(poolManager, doRequestAuth: settings._credential |
| | | 597 | | |
| | | 598 | | // MetricsHandler should be descendant of DiagnosticsHandler in the handler chain to make sure the 'http.req |
| | | 599 | | // metric is recorded before stopping the request Activity. This is needed to make sure that our telemetry s |
| | 0 | 600 | | if (GlobalHttpSettings.MetricsHandler.IsGloballyEnabled) |
| | 0 | 601 | | { |
| | 0 | 602 | | handler = new MetricsHandler(handler, settings._meterFactory, settings._proxy, out Meter meter); |
| | 0 | 603 | | settings._metrics = new SocketsHttpHandlerMetrics(meter); |
| | 0 | 604 | | } |
| | | 605 | | |
| | | 606 | | // DiagnosticsHandler is inserted before RedirectHandler so that trace propagation is done on redirects as w |
| | 0 | 607 | | if (GlobalHttpSettings.DiagnosticsHandler.EnableActivityPropagation && settings._activityHeadersPropagator i |
| | 0 | 608 | | { |
| | 0 | 609 | | handler = new DiagnosticsHandler(handler, propagator, settings._proxy, settings._allowAutoRedirect); |
| | 0 | 610 | | } |
| | | 611 | | |
| | 0 | 612 | | if (settings._allowAutoRedirect) |
| | 0 | 613 | | { |
| | | 614 | | // Just as with WinHttpHandler, for security reasons, we do not support authentication on redirects |
| | | 615 | | // if the credential is anything other than a CredentialCache. |
| | | 616 | | // We allow credentials in a CredentialCache since they are specifically tied to URIs. |
| | 0 | 617 | | handler = new RedirectHandler(settings._maxAutomaticRedirections, handler, disableAuthOnRedirect: settin |
| | 0 | 618 | | } |
| | | 619 | | |
| | 0 | 620 | | if ((settings._automaticDecompression & SupportedDecompressionMethods) != DecompressionMethods.None) |
| | 0 | 621 | | { |
| | 0 | 622 | | Debug.Assert(_decompressionHandlerFactory is not null); |
| | 0 | 623 | | handler = _decompressionHandlerFactory(settings, handler); |
| | 0 | 624 | | } |
| | | 625 | | |
| | | 626 | | // Ensure a single handler is used for all requests. |
| | 0 | 627 | | if (Interlocked.CompareExchange(ref _handler, handler, null) != null) |
| | 0 | 628 | | { |
| | 0 | 629 | | handler.Dispose(); |
| | 0 | 630 | | } |
| | | 631 | | |
| | 0 | 632 | | return _handler; |
| | 0 | 633 | | } |
| | | 634 | | |
| | | 635 | | // Allows for DecompressionHandler (and its compression dependencies) to be trimmed when |
| | | 636 | | // AutomaticDecompression is not being used. |
| | | 637 | | private void EnsureDecompressionHandlerFactory() |
| | 0 | 638 | | { |
| | 0 | 639 | | _decompressionHandlerFactory ??= (settings, handler) => new DecompressionHandler(settings._automaticDecompre |
| | 0 | 640 | | } |
| | | 641 | | |
| | | 642 | | // Not stored as a constant on the DecompressionHandler to allow it to get trimmed. |
| | | 643 | | private const DecompressionMethods SupportedDecompressionMethods = DecompressionMethods.GZip | DecompressionMeth |
| | | 644 | | |
| | | 645 | | protected internal override HttpResponseMessage Send(HttpRequestMessage request, |
| | | 646 | | CancellationToken cancellationToken) |
| | 0 | 647 | | { |
| | 0 | 648 | | ArgumentNullException.ThrowIfNull(request); |
| | | 649 | | |
| | 0 | 650 | | if (request.Version.Major >= 2) |
| | 0 | 651 | | { |
| | 0 | 652 | | throw new NotSupportedException(SR.Format(SR.net_http_http2_sync_not_supported, GetType())); |
| | | 653 | | } |
| | | 654 | | |
| | | 655 | | // Do not allow upgrades for synchronous requests, that might lead to asynchronous code-paths. |
| | 0 | 656 | | if (request.VersionPolicy == HttpVersionPolicy.RequestVersionOrHigher) |
| | 0 | 657 | | { |
| | 0 | 658 | | throw new NotSupportedException(SR.Format(SR.net_http_upgrade_not_enabled_sync, nameof(Send), request.Ve |
| | | 659 | | } |
| | | 660 | | |
| | 0 | 661 | | ObjectDisposedException.ThrowIf(_disposed, this); |
| | | 662 | | |
| | 0 | 663 | | cancellationToken.ThrowIfCancellationRequested(); |
| | | 664 | | |
| | 0 | 665 | | Exception? error = ValidateAndNormalizeRequest(request); |
| | 0 | 666 | | if (error != null) |
| | 0 | 667 | | { |
| | 0 | 668 | | throw error; |
| | | 669 | | } |
| | | 670 | | |
| | 0 | 671 | | HttpMessageHandlerStage handler = _handler ?? SetupHandlerChain(); |
| | | 672 | | |
| | 0 | 673 | | return handler.Send(request, cancellationToken); |
| | 0 | 674 | | } |
| | | 675 | | |
| | | 676 | | protected internal override Task<HttpResponseMessage> SendAsync(HttpRequestMessage request, CancellationToken ca |
| | 0 | 677 | | { |
| | 0 | 678 | | ArgumentNullException.ThrowIfNull(request); |
| | | 679 | | |
| | 0 | 680 | | ObjectDisposedException.ThrowIf(_disposed, this); |
| | | 681 | | |
| | 0 | 682 | | if (cancellationToken.IsCancellationRequested) |
| | 0 | 683 | | { |
| | 0 | 684 | | return Task.FromCanceled<HttpResponseMessage>(cancellationToken); |
| | | 685 | | } |
| | | 686 | | |
| | 0 | 687 | | Exception? error = ValidateAndNormalizeRequest(request); |
| | 0 | 688 | | if (error != null) |
| | 0 | 689 | | { |
| | 0 | 690 | | return Task.FromException<HttpResponseMessage>(error); |
| | | 691 | | } |
| | | 692 | | |
| | 0 | 693 | | return _handler is { } handler |
| | 0 | 694 | | ? handler.SendAsync(request, cancellationToken) |
| | 0 | 695 | | : CreateHandlerAndSendAsync(request, cancellationToken); |
| | | 696 | | |
| | | 697 | | // SetupHandlerChain may block for a few seconds in some environments. |
| | | 698 | | // E.g. during the first access of HttpClient.DefaultProxy - https://github.com/dotnet/runtime/issues/115301 |
| | | 699 | | // The setup procedure is enqueued to thread pool to prevent the caller from blocking. |
| | | 700 | | async Task<HttpResponseMessage> CreateHandlerAndSendAsync(HttpRequestMessage request, CancellationToken canc |
| | 0 | 701 | | { |
| | 0 | 702 | | _handlerChainSetupTask ??= Task.Run(SetupHandlerChain); |
| | 0 | 703 | | HttpMessageHandlerStage handler = await _handlerChainSetupTask.ConfigureAwait(false); |
| | 0 | 704 | | return await handler.SendAsync(request, cancellationToken).ConfigureAwait(false); |
| | 0 | 705 | | } |
| | 0 | 706 | | } |
| | | 707 | | |
| | | 708 | | private static Exception? ValidateAndNormalizeRequest(HttpRequestMessage request) |
| | 0 | 709 | | { |
| | 0 | 710 | | if (request.Version != HttpVersion.Version10 && request.Version != HttpVersion.Version11 && request.Version |
| | 0 | 711 | | { |
| | 0 | 712 | | return ExceptionDispatchInfo.SetCurrentStackTrace(new NotSupportedException(SR.net_http_unsupported_vers |
| | | 713 | | } |
| | | 714 | | |
| | | 715 | | // Add headers to define content transfer, if not present |
| | 0 | 716 | | if (request.HasHeaders && request.Headers.TransferEncodingChunked.GetValueOrDefault()) |
| | 0 | 717 | | { |
| | 0 | 718 | | if (request.Content == null) |
| | 0 | 719 | | { |
| | 0 | 720 | | return ExceptionDispatchInfo.SetCurrentStackTrace(new HttpRequestException(SR.net_http_client_execut |
| | 0 | 721 | | ExceptionDispatchInfo.SetCurrentStackTrace(new InvalidOperationException(SR.net_http_chunked_not |
| | | 722 | | } |
| | | 723 | | |
| | | 724 | | // Since the user explicitly set TransferEncodingChunked to true, we need to remove |
| | | 725 | | // the Content-Length header if present, as sending both is invalid. |
| | 0 | 726 | | request.Content.Headers.ContentLength = null; |
| | 0 | 727 | | } |
| | 0 | 728 | | else if (request.Content != null && request.Content.Headers.ContentLength == null) |
| | 0 | 729 | | { |
| | | 730 | | // We have content, but neither Transfer-Encoding nor Content-Length is set. |
| | 0 | 731 | | request.Headers.TransferEncodingChunked = true; |
| | 0 | 732 | | } |
| | | 733 | | |
| | 0 | 734 | | if (request.Version.Minor == 0 && request.Version.Major == 1 && request.HasHeaders) |
| | 0 | 735 | | { |
| | | 736 | | // HTTP 1.0 does not support chunking |
| | 0 | 737 | | if (request.Headers.TransferEncodingChunked == true) |
| | 0 | 738 | | { |
| | 0 | 739 | | return ExceptionDispatchInfo.SetCurrentStackTrace(new NotSupportedException(SR.net_http_unsupported_ |
| | | 740 | | } |
| | | 741 | | |
| | | 742 | | // HTTP 1.0 does not support Expect: 100-continue; just disable it. |
| | 0 | 743 | | if (request.Headers.ExpectContinue == true) |
| | 0 | 744 | | { |
| | 0 | 745 | | request.Headers.ExpectContinue = false; |
| | 0 | 746 | | } |
| | 0 | 747 | | } |
| | | 748 | | |
| | 0 | 749 | | Uri? requestUri = request.RequestUri; |
| | 0 | 750 | | if (requestUri is null || !requestUri.IsAbsoluteUri) |
| | 0 | 751 | | { |
| | 0 | 752 | | return ExceptionDispatchInfo.SetCurrentStackTrace(new InvalidOperationException(SR.net_http_client_inval |
| | | 753 | | } |
| | | 754 | | |
| | 0 | 755 | | if (!HttpUtilities.IsSupportedScheme(requestUri.Scheme)) |
| | 0 | 756 | | { |
| | 0 | 757 | | return ExceptionDispatchInfo.SetCurrentStackTrace(new NotSupportedException(SR.Format(SR.net_http_unsupp |
| | | 758 | | } |
| | | 759 | | |
| | 0 | 760 | | return null; |
| | 0 | 761 | | } |
| | | 762 | | } |
| | | 763 | | } |
| | | 764 | | |