| | | 1 | | // Copyright (c) ZeroC, Inc. |
| | | 2 | | |
| | | 3 | | using IceRpc.Features; |
| | | 4 | | using IceRpc.Transports; |
| | | 5 | | using Microsoft.Extensions.Logging; |
| | | 6 | | using Microsoft.Extensions.Logging.Abstractions; |
| | | 7 | | using System.Collections.Immutable; |
| | | 8 | | using System.Diagnostics; |
| | | 9 | | using System.Net.Security; |
| | | 10 | | using System.Security.Authentication; |
| | | 11 | | |
| | | 12 | | namespace IceRpc; |
| | | 13 | | |
| | | 14 | | /// <summary>Represents a client connection used to send requests to a server and receive the corresponding responses. |
| | | 15 | | /// </summary> |
| | | 16 | | /// <remarks>This client connection can also dispatch requests ("callbacks") received from the server. The client |
| | | 17 | | /// connection's underlying connection is recreated and reconnected automatically when it's closed by any event other |
| | | 18 | | /// than a call to <see cref="ShutdownAsync" /> or <see cref="DisposeAsync" />.</remarks> |
| | | 19 | | public sealed class ClientConnection : IInvoker, IAsyncDisposable |
| | | 20 | | { |
| | | 21 | | // The underlying protocol connection once successfully established. |
| | | 22 | | private (IProtocolConnection Connection, TransportConnectionInformation ConnectionInformation)? _activeConnection; |
| | | 23 | | |
| | | 24 | | private readonly IClientProtocolConnectionFactory _clientProtocolConnectionFactory; |
| | | 25 | | |
| | | 26 | | private readonly TimeSpan _connectTimeout; |
| | | 27 | | |
| | | 28 | | // A detached connection is a protocol connection that is connecting, shutting down or being disposed. Both |
| | | 29 | | // ShutdownAsync and DisposeAsync wait for detached connections to reach 0 using _detachedConnectionsTcs. Such a |
| | | 30 | | // connection is "detached" because it's not in _activeConnection. |
| | | 31 | | private int _detachedConnectionCount; |
| | | 32 | | |
| | 92 | 33 | | private readonly TaskCompletionSource _detachedConnectionsTcs = |
| | 92 | 34 | | new(TaskCreationOptions.RunContinuationsAsynchronously); |
| | | 35 | | |
| | | 36 | | // A cancellation token source that is canceled when DisposeAsync is called. |
| | 92 | 37 | | private readonly CancellationTokenSource _disposedCts = new(); |
| | | 38 | | private Task? _disposeTask; |
| | | 39 | | |
| | 92 | 40 | | private readonly Lock _mutex = new(); |
| | | 41 | | |
| | | 42 | | // A connection being established and its associated connect task. When non-null, _activeConnection is null. |
| | | 43 | | private (IProtocolConnection Connection, Task<TransportConnectionInformation> ConnectTask)? _pendingConnection; |
| | | 44 | | |
| | | 45 | | private Task? _shutdownTask; |
| | | 46 | | |
| | | 47 | | private readonly TimeSpan _shutdownTimeout; |
| | | 48 | | |
| | | 49 | | private readonly ServerAddress _serverAddress; |
| | | 50 | | |
| | | 51 | | /// <summary>Constructs a client connection.</summary> |
| | | 52 | | /// <param name="options">The client connection options.</param> |
| | | 53 | | /// <param name="duplexClientTransport">The duplex client transport. <see langword="null" /> is equivalent to <see |
| | | 54 | | /// cref="IDuplexClientTransport.Default" />.</param> |
| | | 55 | | /// <param name="multiplexedClientTransport">The multiplexed client transport. <see langword="null" /> is equivalent |
| | | 56 | | /// to <see cref="IMultiplexedClientTransport.Default" />.</param> |
| | | 57 | | /// <param name="logger">The logger. <see langword="null" /> is equivalent to <see cref="NullLogger.Instance" />. |
| | | 58 | | /// </param> |
| | 92 | 59 | | public ClientConnection( |
| | 92 | 60 | | ClientConnectionOptions options, |
| | 92 | 61 | | IDuplexClientTransport? duplexClientTransport = null, |
| | 92 | 62 | | IMultiplexedClientTransport? multiplexedClientTransport = null, |
| | 92 | 63 | | ILogger? logger = null) |
| | 92 | 64 | | { |
| | 92 | 65 | | _connectTimeout = options.ConnectTimeout; |
| | 92 | 66 | | _shutdownTimeout = options.ShutdownTimeout; |
| | | 67 | | |
| | 92 | 68 | | duplexClientTransport ??= IDuplexClientTransport.Default; |
| | 92 | 69 | | multiplexedClientTransport ??= IMultiplexedClientTransport.Default; |
| | | 70 | | |
| | 92 | 71 | | _serverAddress = options.ServerAddress ?? |
| | 92 | 72 | | throw new ArgumentException( |
| | 92 | 73 | | $"{nameof(ClientConnectionOptions.ServerAddress)} is not set", |
| | 92 | 74 | | nameof(options)); |
| | | 75 | | |
| | 92 | 76 | | if (_serverAddress.Transport is null) |
| | 51 | 77 | | { |
| | 51 | 78 | | _serverAddress = _serverAddress with |
| | 51 | 79 | | { |
| | 51 | 80 | | Transport = _serverAddress.Protocol == Protocol.Ice ? |
| | 51 | 81 | | duplexClientTransport.DefaultName : multiplexedClientTransport.DefaultName |
| | 51 | 82 | | }; |
| | 51 | 83 | | } |
| | | 84 | | |
| | 92 | 85 | | _clientProtocolConnectionFactory = new ClientProtocolConnectionFactory( |
| | 92 | 86 | | options, |
| | 92 | 87 | | options.ConnectTimeout, |
| | 92 | 88 | | options.ClientAuthenticationOptions, |
| | 92 | 89 | | duplexClientTransport, |
| | 92 | 90 | | multiplexedClientTransport, |
| | 92 | 91 | | logger); |
| | 92 | 92 | | } |
| | | 93 | | |
| | | 94 | | /// <summary>Constructs a client connection with the specified server address and client authentication options. |
| | | 95 | | /// All other properties use the <see cref="ClientConnectionOptions" /> defaults.</summary> |
| | | 96 | | /// <param name="serverAddress">The connection's server address.</param> |
| | | 97 | | /// <param name="clientAuthenticationOptions">The SSL client authentication options. When not <see langword="null" |
| | | 98 | | /// />, <see cref="ConnectAsync(CancellationToken)" /> will either establish a secure connection or fail.</param> |
| | | 99 | | /// <param name="duplexClientTransport">The duplex client transport. <see langword="null" /> is equivalent to <see |
| | | 100 | | /// cref="IDuplexClientTransport.Default" />.</param> |
| | | 101 | | /// <param name="multiplexedClientTransport">The multiplexed client transport. <see langword="null" /> is equivalent |
| | | 102 | | /// to <see cref="IMultiplexedClientTransport.Default" />.</param> |
| | | 103 | | /// <param name="logger">The logger. <see langword="null" /> is equivalent to <see cref="NullLogger.Instance" />. |
| | | 104 | | /// </param> |
| | | 105 | | public ClientConnection( |
| | | 106 | | ServerAddress serverAddress, |
| | | 107 | | SslClientAuthenticationOptions? clientAuthenticationOptions = null, |
| | | 108 | | IDuplexClientTransport? duplexClientTransport = null, |
| | | 109 | | IMultiplexedClientTransport? multiplexedClientTransport = null, |
| | | 110 | | ILogger? logger = null) |
| | 46 | 111 | | : this( |
| | 46 | 112 | | new ClientConnectionOptions |
| | 46 | 113 | | { |
| | 46 | 114 | | ClientAuthenticationOptions = clientAuthenticationOptions, |
| | 46 | 115 | | ServerAddress = serverAddress |
| | 46 | 116 | | }, |
| | 46 | 117 | | duplexClientTransport, |
| | 46 | 118 | | multiplexedClientTransport, |
| | 46 | 119 | | logger) |
| | 46 | 120 | | { |
| | 46 | 121 | | } |
| | | 122 | | |
| | | 123 | | /// <summary>Constructs a client connection with the specified server address URI and client authentication options. |
| | | 124 | | /// All other properties use the <see cref="ClientConnectionOptions" /> defaults.</summary> |
| | | 125 | | /// <param name="serverAddressUri">The connection's server address URI.</param> |
| | | 126 | | /// <param name="clientAuthenticationOptions">The SSL client authentication options. When not <see langword="null" |
| | | 127 | | /// />, <see cref="ConnectAsync(CancellationToken)" /> will either establish a secure connection or fail.</param> |
| | | 128 | | /// <param name="duplexClientTransport">The duplex client transport. <see langword="null" /> is equivalent to <see |
| | | 129 | | /// cref="IDuplexClientTransport.Default" />.</param> |
| | | 130 | | /// <param name="multiplexedClientTransport">The multiplexed client transport. <see langword="null" /> is equivalent |
| | | 131 | | /// to <see cref="IMultiplexedClientTransport.Default" />.</param> |
| | | 132 | | /// <param name="logger">The logger. <see langword="null" /> is equivalent to <see cref="NullLogger.Instance" />. |
| | | 133 | | /// </param> |
| | | 134 | | public ClientConnection( |
| | | 135 | | Uri serverAddressUri, |
| | | 136 | | SslClientAuthenticationOptions? clientAuthenticationOptions = null, |
| | | 137 | | IDuplexClientTransport? duplexClientTransport = null, |
| | | 138 | | IMultiplexedClientTransport? multiplexedClientTransport = null, |
| | | 139 | | ILogger? logger = null) |
| | 4 | 140 | | : this( |
| | 4 | 141 | | new ServerAddress(serverAddressUri), |
| | 4 | 142 | | clientAuthenticationOptions, |
| | 4 | 143 | | duplexClientTransport, |
| | 4 | 144 | | multiplexedClientTransport, |
| | 4 | 145 | | logger) |
| | 4 | 146 | | { |
| | 4 | 147 | | } |
| | | 148 | | |
| | | 149 | | /// <summary>Establishes the connection.</summary> |
| | | 150 | | /// <param name="cancellationToken">A cancellation token that receives the cancellation requests.</param> |
| | | 151 | | /// <returns>A task that provides the <see cref="TransportConnectionInformation" /> of the transport connection, |
| | | 152 | | /// once this connection is established.</returns> |
| | | 153 | | /// <exception cref="InvalidOperationException">Thrown when this client connection is shut down or shutting down. |
| | | 154 | | /// </exception> |
| | | 155 | | /// <exception cref="ObjectDisposedException">Thrown when this client connection is disposed.</exception> |
| | | 156 | | /// <remarks><para>This method can be called multiple times and concurrently. If the connection is not established, |
| | | 157 | | /// it will be connected or reconnected.</para> |
| | | 158 | | /// <para>The returned task can also complete with one of the following exceptions:</para> |
| | | 159 | | /// <list type="bullet"> |
| | | 160 | | /// <item><description><see cref="AuthenticationException" /> if authentication failed.</description></item> |
| | | 161 | | /// <item><description><see cref="IceRpcException" /> if the connection establishment failed.</description></item> |
| | | 162 | | /// <item><description><see cref="OperationCanceledException" /> if cancellation was requested through the |
| | | 163 | | /// cancellation token.</description></item> |
| | | 164 | | /// <item><description><see cref="TimeoutException" /> if this connection attempt or a previous attempt exceeded |
| | | 165 | | /// <see cref="ClientConnectionOptions.ConnectTimeout" />.</description></item> |
| | | 166 | | /// </list> |
| | | 167 | | /// </remarks> |
| | | 168 | | public Task<TransportConnectionInformation> ConnectAsync(CancellationToken cancellationToken = default) |
| | 59 | 169 | | { |
| | | 170 | | Task<TransportConnectionInformation> connectTask; |
| | | 171 | | |
| | | 172 | | lock (_mutex) |
| | 59 | 173 | | { |
| | 59 | 174 | | ObjectDisposedException.ThrowIf(_disposeTask is not null, this); |
| | 59 | 175 | | if (_shutdownTask is not null) |
| | 0 | 176 | | { |
| | 0 | 177 | | throw new InvalidOperationException("Cannot connect a client connection after shutting it down."); |
| | | 178 | | } |
| | | 179 | | |
| | 59 | 180 | | if (_activeConnection is not null) |
| | 1 | 181 | | { |
| | 1 | 182 | | return Task.FromResult(_activeConnection.Value.ConnectionInformation); |
| | | 183 | | } |
| | | 184 | | |
| | 58 | 185 | | if (_pendingConnection is null) |
| | 58 | 186 | | { |
| | 58 | 187 | | IProtocolConnection newConnection = _clientProtocolConnectionFactory.CreateConnection(_serverAddress); |
| | 58 | 188 | | _detachedConnectionCount++; |
| | 58 | 189 | | connectTask = CreateConnectTask(newConnection, cancellationToken); |
| | 58 | 190 | | _pendingConnection = (newConnection, connectTask); |
| | 58 | 191 | | } |
| | | 192 | | else |
| | 0 | 193 | | { |
| | 0 | 194 | | connectTask = _pendingConnection.Value.ConnectTask.WaitAsync(cancellationToken); |
| | 0 | 195 | | } |
| | 58 | 196 | | } |
| | | 197 | | |
| | 58 | 198 | | return PerformConnectAsync(); |
| | | 199 | | |
| | | 200 | | async Task<TransportConnectionInformation> PerformConnectAsync() |
| | 58 | 201 | | { |
| | | 202 | | try |
| | 58 | 203 | | { |
| | 58 | 204 | | return await connectTask.ConfigureAwait(false); |
| | | 205 | | } |
| | 3 | 206 | | catch (OperationCanceledException) |
| | 3 | 207 | | { |
| | | 208 | | // Canceled via the cancellation token given to ConnectAsync, but not necessarily this ConnectAsync |
| | | 209 | | // call. |
| | | 210 | | |
| | 3 | 211 | | cancellationToken.ThrowIfCancellationRequested(); |
| | | 212 | | |
| | 0 | 213 | | throw new IceRpcException( |
| | 0 | 214 | | IceRpcError.ConnectionAborted, |
| | 0 | 215 | | "The connection establishment was canceled by another concurrent attempt."); |
| | | 216 | | } |
| | 37 | 217 | | } |
| | 59 | 218 | | } |
| | | 219 | | |
| | | 220 | | /// <summary>Releases all resources allocated by the connection. The connection disposes all the underlying |
| | | 221 | | /// connections it created.</summary> |
| | | 222 | | /// <returns>A value task that completes when the disposal of all the underlying connections has |
| | | 223 | | /// completed.</returns> |
| | | 224 | | /// <remarks>The disposal of an underlying connection aborts invocations, cancels dispatches and disposes the |
| | | 225 | | /// underlying transport connection without waiting for the peer. To wait for invocations and dispatches to |
| | | 226 | | /// complete, call <see cref="ShutdownAsync" /> first. If the configured dispatcher does not complete promptly when |
| | | 227 | | /// its cancellation token is canceled, the disposal can hang.</remarks> |
| | | 228 | | public ValueTask DisposeAsync() |
| | 99 | 229 | | { |
| | | 230 | | lock (_mutex) |
| | 99 | 231 | | { |
| | 99 | 232 | | if (_disposeTask is null) |
| | 92 | 233 | | { |
| | 92 | 234 | | _shutdownTask ??= Task.CompletedTask; |
| | 92 | 235 | | if (_detachedConnectionCount == 0) |
| | 87 | 236 | | { |
| | 87 | 237 | | _ = _detachedConnectionsTcs.TrySetResult(); |
| | 87 | 238 | | } |
| | | 239 | | |
| | 92 | 240 | | _disposeTask = PerformDisposeAsync(); |
| | 92 | 241 | | } |
| | 99 | 242 | | } |
| | 99 | 243 | | return new(_disposeTask); |
| | | 244 | | |
| | | 245 | | async Task PerformDisposeAsync() |
| | 92 | 246 | | { |
| | 92 | 247 | | await Task.Yield(); // Exit mutex lock |
| | | 248 | | |
| | 92 | 249 | | _disposedCts.Cancel(); |
| | | 250 | | |
| | | 251 | | // Wait for shutdown before disposing connections. |
| | | 252 | | try |
| | 92 | 253 | | { |
| | 92 | 254 | | await _shutdownTask.ConfigureAwait(false); |
| | 90 | 255 | | } |
| | 2 | 256 | | catch |
| | 2 | 257 | | { |
| | | 258 | | // ignore exceptions. |
| | 2 | 259 | | } |
| | | 260 | | |
| | | 261 | | // Since a pending connection is "detached", it's disposed via the connectTask, not directly by this method. |
| | 92 | 262 | | if (_activeConnection is not null) |
| | 55 | 263 | | { |
| | 55 | 264 | | await _activeConnection.Value.Connection.DisposeAsync().ConfigureAwait(false); |
| | 55 | 265 | | } |
| | | 266 | | |
| | 92 | 267 | | await _detachedConnectionsTcs.Task.ConfigureAwait(false); |
| | | 268 | | |
| | 92 | 269 | | _disposedCts.Dispose(); |
| | 92 | 270 | | } |
| | 99 | 271 | | } |
| | | 272 | | |
| | | 273 | | /// <summary>Sends an outgoing request and returns the corresponding incoming response.</summary> |
| | | 274 | | /// <param name="request">The outgoing request being sent.</param> |
| | | 275 | | /// <param name="cancellationToken">A cancellation token that receives the cancellation requests.</param> |
| | | 276 | | /// <returns>The corresponding <see cref="IncomingResponse" />.</returns> |
| | | 277 | | /// <exception cref="InvalidOperationException">Thrown when none of the request's server addresses matches this |
| | | 278 | | /// connection's server address.</exception> |
| | | 279 | | /// <exception cref="IceRpcException">Thrown with error <see cref="IceRpcError.InvocationRefused" /> when this |
| | | 280 | | /// client connection is shut down.</exception> |
| | | 281 | | /// <exception cref="ObjectDisposedException">Thrown when this client connection is disposed.</exception> |
| | | 282 | | /// <remarks>If the connection is not established, it will be connected or reconnected.</remarks> |
| | | 283 | | public Task<IncomingResponse> InvokeAsync(OutgoingRequest request, CancellationToken cancellationToken = default) |
| | 46 | 284 | | { |
| | 46 | 285 | | if (request.Features.Get<IServerAddressFeature>() is IServerAddressFeature serverAddressFeature) |
| | 0 | 286 | | { |
| | 0 | 287 | | if (serverAddressFeature.ServerAddress is ServerAddress mainServerAddress) |
| | 0 | 288 | | { |
| | 0 | 289 | | CheckRequestServerAddresses(mainServerAddress, serverAddressFeature.AltServerAddresses); |
| | 0 | 290 | | } |
| | 0 | 291 | | } |
| | 46 | 292 | | else if (request.ServiceAddress.ServerAddress is ServerAddress mainServerAddress) |
| | 17 | 293 | | { |
| | 17 | 294 | | CheckRequestServerAddresses(mainServerAddress, request.ServiceAddress.AltServerAddresses); |
| | 11 | 295 | | } |
| | | 296 | | // It's ok if the request has no server address at all. |
| | | 297 | | |
| | 40 | 298 | | IProtocolConnection? activeConnection = null; |
| | | 299 | | |
| | | 300 | | lock (_mutex) |
| | 40 | 301 | | { |
| | 40 | 302 | | ObjectDisposedException.ThrowIf(_disposeTask is not null, this); |
| | | 303 | | |
| | 40 | 304 | | if (_shutdownTask is not null) |
| | 0 | 305 | | { |
| | 0 | 306 | | throw new IceRpcException(IceRpcError.InvocationRefused, "The client connection was shut down."); |
| | | 307 | | } |
| | | 308 | | |
| | 40 | 309 | | activeConnection = _activeConnection?.Connection; |
| | 40 | 310 | | } |
| | | 311 | | |
| | 40 | 312 | | return PerformInvokeAsync(activeConnection); |
| | | 313 | | |
| | | 314 | | void CheckRequestServerAddresses( |
| | | 315 | | ServerAddress mainServerAddress, |
| | | 316 | | ImmutableList<ServerAddress> altServerAddresses) |
| | 17 | 317 | | { |
| | 17 | 318 | | if (ServerAddressComparer.OptionalTransport.Equals(mainServerAddress, _serverAddress)) |
| | 10 | 319 | | { |
| | 10 | 320 | | return; |
| | | 321 | | } |
| | | 322 | | |
| | 22 | 323 | | foreach (ServerAddress serverAddress in altServerAddresses) |
| | 1 | 324 | | { |
| | 1 | 325 | | if (ServerAddressComparer.OptionalTransport.Equals(serverAddress, _serverAddress)) |
| | 1 | 326 | | { |
| | 1 | 327 | | return; |
| | | 328 | | } |
| | 0 | 329 | | } |
| | | 330 | | |
| | 6 | 331 | | throw new InvalidOperationException( |
| | 6 | 332 | | $"None of the request's server addresses matches this connection's server address: {_serverAddress}"); |
| | 11 | 333 | | } |
| | | 334 | | |
| | | 335 | | async Task<IncomingResponse> PerformInvokeAsync(IProtocolConnection? connection) |
| | 40 | 336 | | { |
| | | 337 | | // When InvokeAsync throws an IceRpcException(InvocationRefused) we retry unless the client connection is |
| | | 338 | | // being shutdown or disposed. |
| | 40 | 339 | | while (true) |
| | 40 | 340 | | { |
| | 40 | 341 | | connection ??= await GetActiveConnectionAsync(cancellationToken).ConfigureAwait(false); |
| | | 342 | | |
| | | 343 | | try |
| | 40 | 344 | | { |
| | 40 | 345 | | return await connection.InvokeAsync(request, cancellationToken).ConfigureAwait(false); |
| | | 346 | | } |
| | 0 | 347 | | catch (ObjectDisposedException) |
| | 0 | 348 | | { |
| | | 349 | | // This can occasionally happen if we find a connection that was just closed and then automatically |
| | | 350 | | // disposed by this client connection. |
| | 0 | 351 | | } |
| | 2 | 352 | | catch (IceRpcException exception) when (exception.IceRpcError == IceRpcError.InvocationRefused) |
| | 0 | 353 | | { |
| | | 354 | | // The connection is refusing new invocations. |
| | 0 | 355 | | } |
| | 2 | 356 | | catch (IceRpcException exception) when (exception.IceRpcError == IceRpcError.OperationAborted) |
| | 2 | 357 | | { |
| | | 358 | | lock (_mutex) |
| | 2 | 359 | | { |
| | 2 | 360 | | if (_disposeTask is null) |
| | 0 | 361 | | { |
| | 0 | 362 | | throw new IceRpcException( |
| | 0 | 363 | | IceRpcError.ConnectionAborted, |
| | 0 | 364 | | "The underlying connection was disposed while the invocation was in progress."); |
| | | 365 | | } |
| | | 366 | | else |
| | 2 | 367 | | { |
| | 2 | 368 | | throw; |
| | | 369 | | } |
| | | 370 | | } |
| | | 371 | | } |
| | | 372 | | |
| | | 373 | | // Make sure connection is no longer in _activeConnection before we retry. |
| | 0 | 374 | | _ = RemoveFromActiveAsync(connection); |
| | 0 | 375 | | connection = null; |
| | 0 | 376 | | } |
| | 36 | 377 | | } |
| | 40 | 378 | | } |
| | | 379 | | |
| | | 380 | | /// <summary>Gracefully shuts down the connection. The shutdown waits for pending invocations and dispatches to |
| | | 381 | | /// complete.</summary> |
| | | 382 | | /// <param name="cancellationToken">A cancellation token that receives the cancellation requests.</param> |
| | | 383 | | /// <returns>A task that completes once the shutdown is complete.</returns> |
| | | 384 | | /// <exception cref="InvalidOperationException">Thrown when this connection is already shut down or shutting down. |
| | | 385 | | /// </exception> |
| | | 386 | | /// <exception cref="ObjectDisposedException">Thrown when this connection is disposed.</exception> |
| | | 387 | | /// <remarks><para>The returned task can also complete with one of the following exceptions:</para> |
| | | 388 | | /// <list type="bullet"> |
| | | 389 | | /// <item><description><see cref="IceRpcException" /> with error <see cref="IceRpcError.OperationAborted" /> if this |
| | | 390 | | /// connection is disposed while being shut down.</description></item> |
| | | 391 | | /// <item><description><see cref="OperationCanceledException" /> if cancellation was requested through the |
| | | 392 | | /// cancellation token.</description></item> |
| | | 393 | | /// <item><description><see cref="TimeoutException" /> if this shutdown attempt or a previous attempt exceeded <see |
| | | 394 | | /// cref="ClientConnectionOptions.ShutdownTimeout" />.</description></item> |
| | | 395 | | /// </list> |
| | | 396 | | /// </remarks> |
| | | 397 | | public Task ShutdownAsync(CancellationToken cancellationToken = default) |
| | 17 | 398 | | { |
| | | 399 | | lock (_mutex) |
| | 17 | 400 | | { |
| | 17 | 401 | | ObjectDisposedException.ThrowIf(_disposeTask is not null, this); |
| | 17 | 402 | | if (_shutdownTask is not null) |
| | 0 | 403 | | { |
| | 0 | 404 | | throw new InvalidOperationException("The client connection is already shut down or shutting down."); |
| | | 405 | | } |
| | | 406 | | |
| | 17 | 407 | | if (_detachedConnectionCount == 0) |
| | 17 | 408 | | { |
| | 17 | 409 | | _ = _detachedConnectionsTcs.TrySetResult(); |
| | 17 | 410 | | } |
| | | 411 | | |
| | 17 | 412 | | _shutdownTask = PerformShutdownAsync(); |
| | 17 | 413 | | return _shutdownTask; |
| | | 414 | | } |
| | | 415 | | |
| | | 416 | | async Task PerformShutdownAsync() |
| | 17 | 417 | | { |
| | 17 | 418 | | await Task.Yield(); // exit mutex lock |
| | | 419 | | |
| | 17 | 420 | | using var cts = CancellationTokenSource.CreateLinkedTokenSource(cancellationToken, _disposedCts.Token); |
| | 17 | 421 | | cts.CancelAfter(_shutdownTimeout); |
| | | 422 | | |
| | | 423 | | try |
| | 17 | 424 | | { |
| | | 425 | | // Since a pending connection is "detached", it's shutdown and disposed via the connectTask, not |
| | | 426 | | // directly by this method. |
| | | 427 | | try |
| | 17 | 428 | | { |
| | 17 | 429 | | Task shutdownTask = _activeConnection is null ? |
| | 17 | 430 | | Task.CompletedTask : |
| | 17 | 431 | | _activeConnection.Value.Connection.ShutdownAsync(cts.Token); |
| | | 432 | | |
| | 17 | 433 | | await Task.WhenAll(shutdownTask, _detachedConnectionsTcs.Task.WaitAsync(cts.Token)) |
| | 17 | 434 | | .ConfigureAwait(false); |
| | 15 | 435 | | } |
| | 2 | 436 | | catch (OperationCanceledException) |
| | 2 | 437 | | { |
| | 2 | 438 | | throw; |
| | | 439 | | } |
| | 0 | 440 | | catch |
| | 0 | 441 | | { |
| | | 442 | | // Ignore other connection shutdown failures. |
| | | 443 | | |
| | | 444 | | // Throw OperationCanceledException if this WhenAll exception is hiding an OCE. |
| | 0 | 445 | | cts.Token.ThrowIfCancellationRequested(); |
| | 0 | 446 | | } |
| | 15 | 447 | | } |
| | 2 | 448 | | catch (OperationCanceledException) |
| | 2 | 449 | | { |
| | 2 | 450 | | cancellationToken.ThrowIfCancellationRequested(); |
| | | 451 | | |
| | 1 | 452 | | if (_disposedCts.IsCancellationRequested) |
| | 0 | 453 | | { |
| | 0 | 454 | | throw new IceRpcException( |
| | 0 | 455 | | IceRpcError.OperationAborted, |
| | 0 | 456 | | "The shutdown was aborted because the client connection was disposed."); |
| | | 457 | | } |
| | | 458 | | else |
| | 1 | 459 | | { |
| | 1 | 460 | | throw new TimeoutException( |
| | 1 | 461 | | $"The client connection shut down timed out after {_shutdownTimeout.TotalSeconds} s."); |
| | | 462 | | } |
| | | 463 | | } |
| | 15 | 464 | | } |
| | 17 | 465 | | } |
| | | 466 | | |
| | | 467 | | /// <summary>Creates the connection establishment task for a pending connection.</summary> |
| | | 468 | | /// <param name="connection">The new pending connection to connect.</param> |
| | | 469 | | /// <param name="cancellationToken">The cancellation token that can cancel this task.</param> |
| | | 470 | | /// <returns>A task that completes successfully when the connection is connected.</returns> |
| | | 471 | | private async Task<TransportConnectionInformation> CreateConnectTask( |
| | | 472 | | IProtocolConnection connection, |
| | | 473 | | CancellationToken cancellationToken) |
| | 84 | 474 | | { |
| | 84 | 475 | | await Task.Yield(); // exit mutex lock |
| | | 476 | | |
| | | 477 | | // This task "owns" a detachedConnectionCount and as a result _disposedCts can't be disposed. |
| | 84 | 478 | | using var cts = CancellationTokenSource.CreateLinkedTokenSource(cancellationToken, _disposedCts.Token); |
| | 84 | 479 | | cts.CancelAfter(_connectTimeout); |
| | | 480 | | |
| | | 481 | | TransportConnectionInformation connectionInformation; |
| | | 482 | | Task shutdownRequested; |
| | 84 | 483 | | Task? connectTask = null; |
| | | 484 | | |
| | | 485 | | try |
| | 84 | 486 | | { |
| | | 487 | | try |
| | 84 | 488 | | { |
| | 84 | 489 | | (connectionInformation, shutdownRequested) = await connection.ConnectAsync(cts.Token) |
| | 84 | 490 | | .ConfigureAwait(false); |
| | 63 | 491 | | } |
| | 5 | 492 | | catch (OperationCanceledException) |
| | 5 | 493 | | { |
| | 5 | 494 | | cancellationToken.ThrowIfCancellationRequested(); |
| | | 495 | | |
| | 2 | 496 | | if (_disposedCts.IsCancellationRequested) |
| | 1 | 497 | | { |
| | 1 | 498 | | throw new IceRpcException( |
| | 1 | 499 | | IceRpcError.OperationAborted, |
| | 1 | 500 | | "The connection establishment was aborted because the client connection was disposed."); |
| | | 501 | | } |
| | | 502 | | else |
| | 1 | 503 | | { |
| | 1 | 504 | | throw new TimeoutException( |
| | 1 | 505 | | $"The connection establishment timed out after {_connectTimeout.TotalSeconds} s."); |
| | | 506 | | } |
| | | 507 | | } |
| | 63 | 508 | | } |
| | 21 | 509 | | catch |
| | 21 | 510 | | { |
| | | 511 | | lock (_mutex) |
| | 21 | 512 | | { |
| | 21 | 513 | | Debug.Assert(_pendingConnection is not null && _pendingConnection.Value.Connection == connection); |
| | 21 | 514 | | Debug.Assert(_activeConnection is null); |
| | | 515 | | |
| | | 516 | | // connectTask is executing this method and about to throw. |
| | 21 | 517 | | connectTask = _pendingConnection.Value.ConnectTask; |
| | 21 | 518 | | _pendingConnection = null; |
| | 21 | 519 | | } |
| | | 520 | | |
| | 21 | 521 | | _ = DisposePendingConnectionAsync(connection, connectTask); |
| | 21 | 522 | | throw; |
| | | 523 | | } |
| | | 524 | | |
| | | 525 | | lock (_mutex) |
| | 63 | 526 | | { |
| | 63 | 527 | | Debug.Assert(_pendingConnection is not null && _pendingConnection.Value.Connection == connection); |
| | 63 | 528 | | Debug.Assert(_activeConnection is null); |
| | | 529 | | |
| | 63 | 530 | | if (_shutdownTask is null) |
| | 63 | 531 | | { |
| | | 532 | | // the connection is now "attached" in _activeConnection |
| | 63 | 533 | | _activeConnection = (connection, connectionInformation); |
| | 63 | 534 | | _detachedConnectionCount--; |
| | 63 | 535 | | } |
| | | 536 | | else |
| | 0 | 537 | | { |
| | 0 | 538 | | connectTask = _pendingConnection.Value.ConnectTask; |
| | 0 | 539 | | } |
| | 63 | 540 | | _pendingConnection = null; |
| | 63 | 541 | | } |
| | | 542 | | |
| | 63 | 543 | | if (connectTask is null) |
| | 63 | 544 | | { |
| | 63 | 545 | | _ = ShutdownWhenRequestedAsync(connection, shutdownRequested); |
| | 63 | 546 | | } |
| | | 547 | | else |
| | 0 | 548 | | { |
| | | 549 | | // As soon as this method completes successfully, we shut down then dispose the connection. |
| | 0 | 550 | | _ = DisposePendingConnectionAsync(connection, connectTask); |
| | 0 | 551 | | } |
| | 63 | 552 | | return connectionInformation; |
| | | 553 | | |
| | | 554 | | async Task DisposePendingConnectionAsync(IProtocolConnection connection, Task connectTask) |
| | 21 | 555 | | { |
| | | 556 | | try |
| | 21 | 557 | | { |
| | 21 | 558 | | await connectTask.ConfigureAwait(false); |
| | | 559 | | |
| | | 560 | | // Since we own a detachedConnectionCount, _disposedCts is not disposed. |
| | 0 | 561 | | using var cts = CancellationTokenSource.CreateLinkedTokenSource(_disposedCts.Token); |
| | 0 | 562 | | cts.CancelAfter(_shutdownTimeout); |
| | 0 | 563 | | await connection.ShutdownAsync(cts.Token).ConfigureAwait(false); |
| | 0 | 564 | | } |
| | 21 | 565 | | catch |
| | 21 | 566 | | { |
| | | 567 | | // Observe and ignore exceptions. |
| | 21 | 568 | | } |
| | | 569 | | |
| | 21 | 570 | | await connection.DisposeAsync().ConfigureAwait(false); |
| | | 571 | | |
| | | 572 | | lock (_mutex) |
| | 21 | 573 | | { |
| | 21 | 574 | | if (--_detachedConnectionCount == 0 && _shutdownTask is not null) |
| | 3 | 575 | | { |
| | 3 | 576 | | _detachedConnectionsTcs.SetResult(); |
| | 3 | 577 | | } |
| | 21 | 578 | | } |
| | 21 | 579 | | } |
| | | 580 | | |
| | | 581 | | async Task ShutdownWhenRequestedAsync(IProtocolConnection connection, Task shutdownRequested) |
| | 63 | 582 | | { |
| | 63 | 583 | | await shutdownRequested.ConfigureAwait(false); |
| | 19 | 584 | | await RemoveFromActiveAsync(connection).ConfigureAwait(false); |
| | 19 | 585 | | } |
| | 63 | 586 | | } |
| | | 587 | | |
| | | 588 | | /// <summary>Removes the connection from _activeConnection, and when successful, shuts down and disposes this |
| | | 589 | | /// connection.</summary> |
| | | 590 | | /// <param name="connection">The connected connection to shut down and dispose.</param> |
| | | 591 | | private Task RemoveFromActiveAsync(IProtocolConnection connection) |
| | 19 | 592 | | { |
| | | 593 | | lock (_mutex) |
| | 19 | 594 | | { |
| | 19 | 595 | | if (_shutdownTask is null && _activeConnection?.Connection == connection) |
| | 8 | 596 | | { |
| | 8 | 597 | | _activeConnection = null; // it's now our connection. |
| | 8 | 598 | | _detachedConnectionCount++; |
| | 8 | 599 | | } |
| | | 600 | | else |
| | 11 | 601 | | { |
| | | 602 | | // Another task owns this connection |
| | 11 | 603 | | return Task.CompletedTask; |
| | | 604 | | } |
| | 8 | 605 | | } |
| | | 606 | | |
| | 8 | 607 | | return ShutdownAndDisposeConnectionAsync(); |
| | | 608 | | |
| | | 609 | | async Task ShutdownAndDisposeConnectionAsync() |
| | 8 | 610 | | { |
| | | 611 | | // _disposedCts is not disposed since we own a detachedConnectionCount |
| | 8 | 612 | | using var cts = CancellationTokenSource.CreateLinkedTokenSource(_disposedCts.Token); |
| | 8 | 613 | | cts.CancelAfter(_shutdownTimeout); |
| | | 614 | | |
| | | 615 | | try |
| | 8 | 616 | | { |
| | 8 | 617 | | await connection.ShutdownAsync(cts.Token).ConfigureAwait(false); |
| | 4 | 618 | | } |
| | 4 | 619 | | catch |
| | 4 | 620 | | { |
| | | 621 | | // Ignore connection shutdown failures |
| | 4 | 622 | | } |
| | | 623 | | |
| | 8 | 624 | | await connection.DisposeAsync().ConfigureAwait(false); |
| | | 625 | | |
| | | 626 | | lock (_mutex) |
| | 8 | 627 | | { |
| | 8 | 628 | | if (--_detachedConnectionCount == 0 && _shutdownTask is not null) |
| | 2 | 629 | | { |
| | 2 | 630 | | _detachedConnectionsTcs.SetResult(); |
| | 2 | 631 | | } |
| | 8 | 632 | | } |
| | 8 | 633 | | } |
| | 19 | 634 | | } |
| | | 635 | | |
| | | 636 | | /// <summary>Gets an active connection, by creating and connecting (if necessary) a new protocol connection. |
| | | 637 | | /// </summary> |
| | | 638 | | /// <param name="cancellationToken">The cancellation token of the invocation calling this method.</param> |
| | | 639 | | /// <returns>A connected connection.</returns> |
| | | 640 | | /// <remarks>This method is called exclusively by <see cref="InvokeAsync" />.</remarks> |
| | | 641 | | private ValueTask<IProtocolConnection> GetActiveConnectionAsync(CancellationToken cancellationToken) |
| | 26 | 642 | | { |
| | | 643 | | (IProtocolConnection Connection, Task<TransportConnectionInformation> ConnectTask) pendingConnectionValue; |
| | | 644 | | |
| | | 645 | | lock (_mutex) |
| | 26 | 646 | | { |
| | 26 | 647 | | if (_disposeTask is not null) |
| | 0 | 648 | | { |
| | 0 | 649 | | throw new IceRpcException(IceRpcError.OperationAborted, "The client connection was disposed."); |
| | | 650 | | } |
| | 26 | 651 | | if (_shutdownTask is not null) |
| | 0 | 652 | | { |
| | 0 | 653 | | throw new IceRpcException(IceRpcError.InvocationRefused, "The client connection was shut down."); |
| | | 654 | | } |
| | | 655 | | |
| | 26 | 656 | | if (_activeConnection is not null) |
| | 0 | 657 | | { |
| | 0 | 658 | | return new(_activeConnection.Value.Connection); |
| | | 659 | | } |
| | | 660 | | |
| | 26 | 661 | | if (_pendingConnection is null) |
| | 26 | 662 | | { |
| | 26 | 663 | | IProtocolConnection connection = _clientProtocolConnectionFactory.CreateConnection(_serverAddress); |
| | 26 | 664 | | _detachedConnectionCount++; |
| | | 665 | | |
| | | 666 | | // We pass CancellationToken.None because the invocation cancellation should not cancel the connection |
| | | 667 | | // establishment. |
| | 26 | 668 | | Task<TransportConnectionInformation> connectTask = |
| | 26 | 669 | | CreateConnectTask(connection, CancellationToken.None); |
| | 26 | 670 | | _pendingConnection = (connection, connectTask); |
| | 26 | 671 | | } |
| | 26 | 672 | | pendingConnectionValue = _pendingConnection.Value; |
| | 26 | 673 | | } |
| | | 674 | | |
| | 26 | 675 | | return PerformGetActiveConnectionAsync(); |
| | | 676 | | |
| | | 677 | | async ValueTask<IProtocolConnection> PerformGetActiveConnectionAsync() |
| | 26 | 678 | | { |
| | | 679 | | // ConnectTask itself takes care of scheduling its exception observation when it fails. |
| | | 680 | | try |
| | 26 | 681 | | { |
| | 26 | 682 | | _ = await pendingConnectionValue.ConnectTask.WaitAsync(cancellationToken).ConfigureAwait(false); |
| | 26 | 683 | | } |
| | 0 | 684 | | catch (OperationCanceledException) |
| | 0 | 685 | | { |
| | 0 | 686 | | cancellationToken.ThrowIfCancellationRequested(); |
| | | 687 | | |
| | | 688 | | // Canceled by the cancellation token given to ClientConnection.ConnectAsync. |
| | 0 | 689 | | throw new IceRpcException( |
| | 0 | 690 | | IceRpcError.ConnectionAborted, |
| | 0 | 691 | | "The connection establishment was canceled by another concurrent attempt."); |
| | | 692 | | } |
| | 26 | 693 | | return pendingConnectionValue.Connection; |
| | 26 | 694 | | } |
| | 26 | 695 | | } |
| | | 696 | | } |