| | | 1 | | // Copyright (c) ZeroC, Inc. |
| | | 2 | | |
| | | 3 | | using IceRpc.Internal; |
| | | 4 | | using IceRpc.Transports; |
| | | 5 | | using IceRpc.Transports.Internal; |
| | | 6 | | using Microsoft.Extensions.Logging; |
| | | 7 | | using Microsoft.Extensions.Logging.Abstractions; |
| | | 8 | | using System.Diagnostics; |
| | | 9 | | using System.Net; |
| | | 10 | | using System.Net.Security; |
| | | 11 | | using System.Security.Authentication; |
| | | 12 | | |
| | | 13 | | namespace IceRpc; |
| | | 14 | | |
| | | 15 | | /// <summary>A server accepts connections from clients and dispatches the requests it receives over these connections. |
| | | 16 | | /// </summary> |
| | | 17 | | public sealed class Server : IAsyncDisposable |
| | | 18 | | { |
| | 94 | 19 | | private readonly LinkedList<IProtocolConnection> _connections = new(); |
| | | 20 | | |
| | | 21 | | private readonly TimeSpan _connectTimeout; |
| | | 22 | | |
| | | 23 | | // A detached connection is a protocol connection that we've decided to connect, or that is connecting, shutting |
| | | 24 | | // down or being disposed. It counts towards _maxConnections and both Server.ShutdownAsync and DisposeAsync wait for |
| | | 25 | | // detached connections to reach 0 using _detachedConnectionsTcs. Such a connection is "detached" because it's not |
| | | 26 | | // in _connections. |
| | | 27 | | private int _detachedConnectionCount; |
| | | 28 | | |
| | 94 | 29 | | private readonly TaskCompletionSource _detachedConnectionsTcs = |
| | 94 | 30 | | new(TaskCreationOptions.RunContinuationsAsynchronously); |
| | | 31 | | |
| | | 32 | | // A cancellation token source that is canceled by DisposeAsync. |
| | 94 | 33 | | private readonly CancellationTokenSource _disposedCts = new(); |
| | | 34 | | |
| | | 35 | | private Task? _disposeTask; |
| | | 36 | | |
| | | 37 | | private readonly Func<IConnectorListener> _listenerFactory; |
| | | 38 | | |
| | | 39 | | private Task? _listenTask; |
| | | 40 | | |
| | | 41 | | private readonly int _maxConnections; |
| | | 42 | | |
| | | 43 | | private readonly int _maxPendingConnections; |
| | | 44 | | |
| | 94 | 45 | | private readonly Lock _mutex = new(); |
| | | 46 | | |
| | | 47 | | private readonly ServerAddress _serverAddress; |
| | | 48 | | |
| | | 49 | | // A cancellation token source canceled by ShutdownAsync and DisposeAsync. |
| | | 50 | | private readonly CancellationTokenSource _shutdownCts; |
| | | 51 | | |
| | | 52 | | private Task? _shutdownTask; |
| | | 53 | | |
| | | 54 | | private readonly TimeSpan _shutdownTimeout; |
| | | 55 | | |
| | | 56 | | /// <summary>Constructs a server.</summary> |
| | | 57 | | /// <param name="options">The server options.</param> |
| | | 58 | | /// <param name="duplexServerTransport">The transport used to create ice protocol connections. The <see |
| | | 59 | | /// langword="null" /> value is equivalent to <see cref="IDuplexServerTransport.Default" />.</param> |
| | | 60 | | /// <param name="multiplexedServerTransport">The transport used to create icerpc protocol connections. The <see |
| | | 61 | | /// langword="null" /> value is equivalent to <see cref="IMultiplexedServerTransport.Default" />.</param> |
| | | 62 | | /// <param name="logger">The logger. <see langword="null" /> is equivalent to <see cref="NullLogger.Instance" |
| | | 63 | | /// />.</param> |
| | 94 | 64 | | public Server( |
| | 94 | 65 | | ServerOptions options, |
| | 94 | 66 | | IDuplexServerTransport? duplexServerTransport = null, |
| | 94 | 67 | | IMultiplexedServerTransport? multiplexedServerTransport = null, |
| | 94 | 68 | | ILogger? logger = null) |
| | 94 | 69 | | { |
| | 94 | 70 | | if (options.ConnectionOptions.Dispatcher is null) |
| | 0 | 71 | | { |
| | 0 | 72 | | throw new ArgumentException($"{nameof(ServerOptions.ConnectionOptions.Dispatcher)} cannot be null"); |
| | | 73 | | } |
| | | 74 | | |
| | 94 | 75 | | logger ??= NullLogger.Instance; |
| | | 76 | | |
| | 94 | 77 | | _shutdownCts = CancellationTokenSource.CreateLinkedTokenSource(_disposedCts.Token); |
| | | 78 | | |
| | 94 | 79 | | duplexServerTransport ??= IDuplexServerTransport.Default; |
| | 94 | 80 | | multiplexedServerTransport ??= IMultiplexedServerTransport.Default; |
| | 94 | 81 | | _maxConnections = options.MaxConnections; |
| | 94 | 82 | | _maxPendingConnections = options.MaxPendingConnections; |
| | | 83 | | |
| | 94 | 84 | | _connectTimeout = options.ConnectTimeout; |
| | 94 | 85 | | _shutdownTimeout = options.ShutdownTimeout; |
| | | 86 | | |
| | 94 | 87 | | _serverAddress = options.ServerAddress; |
| | 94 | 88 | | if (_serverAddress.Transport is null) |
| | 83 | 89 | | { |
| | 83 | 90 | | _serverAddress = _serverAddress with |
| | 83 | 91 | | { |
| | 83 | 92 | | Transport = _serverAddress.Protocol == Protocol.Ice ? |
| | 83 | 93 | | duplexServerTransport.DefaultName : multiplexedServerTransport.DefaultName |
| | 83 | 94 | | }; |
| | 83 | 95 | | } |
| | | 96 | | |
| | 94 | 97 | | if (options.ServerAuthenticationOptions?.ApplicationProtocols is not null) |
| | 0 | 98 | | { |
| | 0 | 99 | | throw new ArgumentException( |
| | 0 | 100 | | "The ApplicationProtocols property of the SSL server authentication options must be null. The ALPN is se |
| | 0 | 101 | | nameof(options)); |
| | | 102 | | } |
| | | 103 | | |
| | 94 | 104 | | var transportAddress = new TransportAddress |
| | 94 | 105 | | { |
| | 94 | 106 | | Host = _serverAddress.Host, |
| | 94 | 107 | | Port = _serverAddress.Port, |
| | 94 | 108 | | TransportName = _serverAddress.Transport, |
| | 94 | 109 | | Params = _serverAddress.Params |
| | 94 | 110 | | }; |
| | | 111 | | |
| | 94 | 112 | | _listenerFactory = () => |
| | 93 | 113 | | { |
| | 94 | 114 | | IConnectorListener listener; |
| | 94 | 115 | | |
| | 93 | 116 | | SslServerAuthenticationOptions? serverAuthenticationOptions = options.ServerAuthenticationOptions; |
| | 93 | 117 | | if (serverAuthenticationOptions is not null) |
| | 5 | 118 | | { |
| | 5 | 119 | | serverAuthenticationOptions = serverAuthenticationOptions.ShallowClone(); |
| | 5 | 120 | | serverAuthenticationOptions.ApplicationProtocols = [_serverAddress.Protocol.AlpnProtocol]; |
| | 5 | 121 | | } |
| | 94 | 122 | | |
| | 93 | 123 | | if (_serverAddress.Protocol == Protocol.Ice) |
| | 25 | 124 | | { |
| | 25 | 125 | | IListener<IDuplexConnection> transportListener = duplexServerTransport.Listen( |
| | 25 | 126 | | transportAddress, |
| | 25 | 127 | | new DuplexConnectionOptions |
| | 25 | 128 | | { |
| | 25 | 129 | | MinSegmentSize = options.ConnectionOptions.MinSegmentSize, |
| | 25 | 130 | | Pool = options.ConnectionOptions.Pool, |
| | 25 | 131 | | }, |
| | 25 | 132 | | serverAuthenticationOptions); |
| | 94 | 133 | | |
| | 25 | 134 | | listener = new IceConnectorListener(transportListener, _serverAddress, options.ConnectionOptions); |
| | 25 | 135 | | } |
| | 94 | 136 | | else |
| | 68 | 137 | | { |
| | 68 | 138 | | IListener<IMultiplexedConnection> transportListener = multiplexedServerTransport.Listen( |
| | 68 | 139 | | transportAddress, |
| | 68 | 140 | | new MultiplexedConnectionOptions |
| | 68 | 141 | | { |
| | 68 | 142 | | HandshakeTimeout = options.ConnectTimeout, |
| | 68 | 143 | | MaxBidirectionalStreams = options.ConnectionOptions.MaxIceRpcBidirectionalStreams, |
| | 68 | 144 | | // Add an additional stream for the icerpc protocol control stream. |
| | 68 | 145 | | MaxUnidirectionalStreams = |
| | 68 | 146 | | int.Min(options.ConnectionOptions.MaxIceRpcUnidirectionalStreams + 1, ushort.MaxValue), |
| | 68 | 147 | | MinSegmentSize = options.ConnectionOptions.MinSegmentSize, |
| | 68 | 148 | | Pool = options.ConnectionOptions.Pool |
| | 68 | 149 | | }, |
| | 68 | 150 | | serverAuthenticationOptions); |
| | 94 | 151 | | |
| | 68 | 152 | | listener = new IceRpcConnectorListener( |
| | 68 | 153 | | transportListener, |
| | 68 | 154 | | _serverAddress, |
| | 68 | 155 | | options.ConnectionOptions, |
| | 68 | 156 | | logger == NullLogger.Instance ? null : new LogTaskExceptionObserver(logger)); |
| | 68 | 157 | | } |
| | 94 | 158 | | |
| | 93 | 159 | | listener = new MetricsConnectorListenerDecorator(listener); |
| | 93 | 160 | | if (logger != NullLogger.Instance) |
| | 10 | 161 | | { |
| | 10 | 162 | | listener = new LogConnectorListenerDecorator(listener, logger); |
| | 10 | 163 | | } |
| | 93 | 164 | | return listener; |
| | 187 | 165 | | }; |
| | 94 | 166 | | } |
| | | 167 | | |
| | | 168 | | /// <summary>Constructs a server with the specified dispatcher and authentication options. All other properties |
| | | 169 | | /// use the <see cref="ServerOptions" /> defaults.</summary> |
| | | 170 | | /// <param name="dispatcher">The dispatcher of the server.</param> |
| | | 171 | | /// <param name="serverAuthenticationOptions">The SSL server authentication options. When not <see langword="null" |
| | | 172 | | /// />, the server will accept only secure connections.</param> |
| | | 173 | | /// <param name="duplexServerTransport">The transport used to create ice protocol connections. <see langword="null" |
| | | 174 | | /// /> is equivalent to <see cref="IDuplexServerTransport.Default" />.</param> |
| | | 175 | | /// <param name="multiplexedServerTransport">The transport used to create icerpc protocol connections. <see |
| | | 176 | | /// langword="null" /> is equivalent to <see cref="IMultiplexedServerTransport.Default" />.</param> |
| | | 177 | | /// <param name="logger">The logger. <see langword="null" /> is equivalent to <see cref="NullLogger.Instance" |
| | | 178 | | /// />.</param> |
| | | 179 | | public Server( |
| | | 180 | | IDispatcher dispatcher, |
| | | 181 | | SslServerAuthenticationOptions? serverAuthenticationOptions = null, |
| | | 182 | | IDuplexServerTransport? duplexServerTransport = null, |
| | | 183 | | IMultiplexedServerTransport? multiplexedServerTransport = null, |
| | | 184 | | ILogger? logger = null) |
| | 1 | 185 | | : this( |
| | 1 | 186 | | new ServerOptions |
| | 1 | 187 | | { |
| | 1 | 188 | | ServerAuthenticationOptions = serverAuthenticationOptions, |
| | 1 | 189 | | ConnectionOptions = new() |
| | 1 | 190 | | { |
| | 1 | 191 | | Dispatcher = dispatcher, |
| | 1 | 192 | | } |
| | 1 | 193 | | }, |
| | 1 | 194 | | duplexServerTransport, |
| | 1 | 195 | | multiplexedServerTransport, |
| | 1 | 196 | | logger) |
| | 1 | 197 | | { |
| | 1 | 198 | | } |
| | | 199 | | |
| | | 200 | | /// <summary>Constructs a server with the specified dispatcher, server address and authentication options. All |
| | | 201 | | /// other properties use the <see cref="ServerOptions" /> defaults.</summary> |
| | | 202 | | /// <param name="dispatcher">The dispatcher of the server.</param> |
| | | 203 | | /// <param name="serverAddress">The server address of the server.</param> |
| | | 204 | | /// <param name="serverAuthenticationOptions">The SSL server authentication options. When not <see langword="null" |
| | | 205 | | /// />, the server will accept only secure connections.</param> |
| | | 206 | | /// <param name="duplexServerTransport">The transport used to create ice protocol connections. <see langword="null" |
| | | 207 | | /// /> is equivalent to <see cref="IDuplexServerTransport.Default" />.</param> |
| | | 208 | | /// <param name="multiplexedServerTransport">The transport used to create icerpc protocol connections. <see |
| | | 209 | | /// langword="null" /> is equivalent to <see cref="IMultiplexedServerTransport.Default" />.</param> |
| | | 210 | | /// <param name="logger">The logger. <see langword="null" /> is equivalent to <see cref="NullLogger.Instance" |
| | | 211 | | /// />.</param> |
| | | 212 | | public Server( |
| | | 213 | | IDispatcher dispatcher, |
| | | 214 | | ServerAddress serverAddress, |
| | | 215 | | SslServerAuthenticationOptions? serverAuthenticationOptions = null, |
| | | 216 | | IDuplexServerTransport? duplexServerTransport = null, |
| | | 217 | | IMultiplexedServerTransport? multiplexedServerTransport = null, |
| | | 218 | | ILogger? logger = null) |
| | 34 | 219 | | : this( |
| | 34 | 220 | | new ServerOptions |
| | 34 | 221 | | { |
| | 34 | 222 | | ServerAuthenticationOptions = serverAuthenticationOptions, |
| | 34 | 223 | | ConnectionOptions = new() |
| | 34 | 224 | | { |
| | 34 | 225 | | Dispatcher = dispatcher, |
| | 34 | 226 | | }, |
| | 34 | 227 | | ServerAddress = serverAddress |
| | 34 | 228 | | }, |
| | 34 | 229 | | duplexServerTransport, |
| | 34 | 230 | | multiplexedServerTransport, |
| | 34 | 231 | | logger) |
| | 34 | 232 | | { |
| | 34 | 233 | | } |
| | | 234 | | |
| | | 235 | | /// <summary>Constructs a server with the specified dispatcher, server address URI and authentication options. All |
| | | 236 | | /// other properties use the <see cref="ServerOptions" /> defaults.</summary> |
| | | 237 | | /// <param name="dispatcher">The dispatcher of the server.</param> |
| | | 238 | | /// <param name="serverAddressUri">A URI that represents the server address of the server.</param> |
| | | 239 | | /// <param name="serverAuthenticationOptions">The SSL server authentication options. When not <see langword="null" |
| | | 240 | | /// />, the server will accept only secure connections.</param> |
| | | 241 | | /// <param name="duplexServerTransport">The transport used to create ice protocol connections. <see langword="null" |
| | | 242 | | /// /> is equivalent to <see cref="IDuplexServerTransport.Default" />.</param> |
| | | 243 | | /// <param name="multiplexedServerTransport">The transport used to create icerpc protocol connections. <see |
| | | 244 | | /// langword="null" /> is equivalent to <see cref="IMultiplexedServerTransport.Default" />.</param> |
| | | 245 | | /// <param name="logger">The logger. <see langword="null" /> is equivalent to <see cref="NullLogger.Instance" |
| | | 246 | | /// />.</param> |
| | | 247 | | public Server( |
| | | 248 | | IDispatcher dispatcher, |
| | | 249 | | Uri serverAddressUri, |
| | | 250 | | SslServerAuthenticationOptions? serverAuthenticationOptions = null, |
| | | 251 | | IDuplexServerTransport? duplexServerTransport = null, |
| | | 252 | | IMultiplexedServerTransport? multiplexedServerTransport = null, |
| | | 253 | | ILogger? logger = null) |
| | 14 | 254 | | : this( |
| | 14 | 255 | | dispatcher, |
| | 14 | 256 | | new ServerAddress(serverAddressUri), |
| | 14 | 257 | | serverAuthenticationOptions, |
| | 14 | 258 | | duplexServerTransport, |
| | 14 | 259 | | multiplexedServerTransport, |
| | 14 | 260 | | logger) |
| | 14 | 261 | | { |
| | 14 | 262 | | } |
| | | 263 | | |
| | | 264 | | /// <summary>Releases all resources allocated by this server. The server stops listening for new connections and |
| | | 265 | | /// disposes the connections it accepted from clients.</summary> |
| | | 266 | | /// <returns>A value task that completes when the disposal of all connections accepted by the server has completed. |
| | | 267 | | /// This includes connections that were active when this method is called and connections whose disposal was |
| | | 268 | | /// initiated prior to this call.</returns> |
| | | 269 | | /// <remarks>The disposal of an underlying connection of the server aborts invocations, cancels dispatches and |
| | | 270 | | /// disposes the underlying transport connection without waiting for the peer. To wait for invocations and |
| | | 271 | | /// dispatches to complete, call <see cref="ShutdownAsync" /> first. If the configured dispatcher does not complete |
| | | 272 | | /// promptly when its cancellation token is canceled, the disposal can hang.</remarks> |
| | | 273 | | public ValueTask DisposeAsync() |
| | 95 | 274 | | { |
| | | 275 | | lock (_mutex) |
| | 95 | 276 | | { |
| | 95 | 277 | | if (_disposeTask is null) |
| | 94 | 278 | | { |
| | 94 | 279 | | _shutdownTask ??= Task.CompletedTask; |
| | 94 | 280 | | if (_detachedConnectionCount == 0) |
| | 86 | 281 | | { |
| | 86 | 282 | | _ = _detachedConnectionsTcs.TrySetResult(); |
| | 86 | 283 | | } |
| | | 284 | | |
| | 94 | 285 | | _disposeTask = PerformDisposeAsync(); |
| | 94 | 286 | | } |
| | 95 | 287 | | return new(_disposeTask); |
| | | 288 | | } |
| | | 289 | | |
| | | 290 | | async Task PerformDisposeAsync() |
| | 94 | 291 | | { |
| | 94 | 292 | | await Task.Yield(); // exit mutex lock |
| | | 293 | | |
| | 94 | 294 | | _disposedCts.Cancel(); |
| | | 295 | | |
| | | 296 | | // _listenTask etc are immutable when _disposeTask is not null. |
| | | 297 | | |
| | | 298 | | // Wait for shutdown before disposing connections. |
| | | 299 | | try |
| | 94 | 300 | | { |
| | 94 | 301 | | await _shutdownTask.ConfigureAwait(false); |
| | 94 | 302 | | } |
| | 0 | 303 | | catch |
| | 0 | 304 | | { |
| | | 305 | | // Ignore exceptions. |
| | 0 | 306 | | } |
| | | 307 | | |
| | 94 | 308 | | if (_listenTask is not null) |
| | 93 | 309 | | { |
| | | 310 | | try |
| | 93 | 311 | | { |
| | 93 | 312 | | await _listenTask.ConfigureAwait(false); |
| | 93 | 313 | | } |
| | 0 | 314 | | catch |
| | 0 | 315 | | { |
| | | 316 | | // Ignore exceptions. |
| | 0 | 317 | | } |
| | | 318 | | |
| | 93 | 319 | | await Task.WhenAll( |
| | 93 | 320 | | _connections |
| | 48 | 321 | | .Select(connection => connection.DisposeAsync().AsTask()) |
| | 93 | 322 | | .Append(_detachedConnectionsTcs.Task)).ConfigureAwait(false); |
| | 93 | 323 | | } |
| | | 324 | | |
| | 94 | 325 | | _disposedCts.Dispose(); |
| | 94 | 326 | | _shutdownCts.Dispose(); |
| | 94 | 327 | | } |
| | 95 | 328 | | } |
| | | 329 | | |
| | | 330 | | /// <summary>Starts accepting connections on the configured server address. Requests received over these connections |
| | | 331 | | /// are then dispatched by the configured dispatcher.</summary> |
| | | 332 | | /// <returns>The server address this server is listening on and that a client would connect to. This address is the |
| | | 333 | | /// same as the <see cref="ServerOptions.ServerAddress" /> of <see cref="ServerOptions" /> except its |
| | | 334 | | /// <see cref="ServerAddress.Transport" /> property is always non-null and its port number is never 0 when the host |
| | | 335 | | /// is an IP address.</returns> |
| | | 336 | | /// <exception cref="IceRpcException">Thrown when the server transport fails to listen on the configured <see |
| | | 337 | | /// cref="ServerOptions.ServerAddress" />.</exception> |
| | | 338 | | /// <exception cref="InvalidOperationException">Thrown when the server is already listening, shut down or shutting |
| | | 339 | | /// down.</exception> |
| | | 340 | | /// <exception cref="ObjectDisposedException">Throw when the server is disposed.</exception> |
| | | 341 | | /// <remarks><see cref="Listen" /> can also throw exceptions from the transport; for example, the transport can |
| | | 342 | | /// reject the server address.</remarks> |
| | | 343 | | public ServerAddress Listen() |
| | 95 | 344 | | { |
| | | 345 | | lock (_mutex) |
| | 95 | 346 | | { |
| | 95 | 347 | | ObjectDisposedException.ThrowIf(_disposeTask is not null, this); |
| | | 348 | | |
| | 94 | 349 | | if (_shutdownTask is not null) |
| | 0 | 350 | | { |
| | 0 | 351 | | throw new InvalidOperationException($"Server '{this}' is shut down or shutting down."); |
| | | 352 | | } |
| | 94 | 353 | | if (_listenTask is not null) |
| | 1 | 354 | | { |
| | 1 | 355 | | throw new InvalidOperationException($"Server '{this}' is already listening."); |
| | | 356 | | } |
| | | 357 | | |
| | 93 | 358 | | IConnectorListener listener = _listenerFactory(); |
| | 93 | 359 | | _listenTask = ListenAsync(listener); // _listenTask owns listener and must dispose it |
| | 93 | 360 | | return listener.ServerAddress; |
| | | 361 | | } |
| | | 362 | | |
| | | 363 | | async Task ListenAsync(IConnectorListener listener) |
| | 93 | 364 | | { |
| | 93 | 365 | | await Task.Yield(); // exit mutex lock |
| | | 366 | | |
| | | 367 | | try |
| | 93 | 368 | | { |
| | 93 | 369 | | using var pendingConnectionSemaphore = new SemaphoreSlim( |
| | 93 | 370 | | _maxPendingConnections, |
| | 93 | 371 | | _maxPendingConnections); |
| | | 372 | | |
| | 185 | 373 | | while (!_shutdownCts.IsCancellationRequested) |
| | 185 | 374 | | { |
| | 185 | 375 | | await pendingConnectionSemaphore.WaitAsync(_shutdownCts.Token).ConfigureAwait(false); |
| | | 376 | | |
| | 184 | 377 | | IConnector? connector = null; |
| | | 378 | | do |
| | 303 | 379 | | { |
| | | 380 | | try |
| | 303 | 381 | | { |
| | 303 | 382 | | (connector, _) = await listener.AcceptAsync(_shutdownCts.Token).ConfigureAwait(false); |
| | 92 | 383 | | } |
| | 211 | 384 | | catch (Exception exception) when (IsRetryableAcceptException(exception)) |
| | 119 | 385 | | { |
| | | 386 | | // continue |
| | 119 | 387 | | } |
| | 211 | 388 | | } |
| | 211 | 389 | | while (connector is null); |
| | | 390 | | |
| | | 391 | | // We don't wait for the connection to be activated or shutdown. This could take a while for some |
| | | 392 | | // transports such as TLS based transports where the handshake requires few round trips between the |
| | | 393 | | // client and server. Waiting could also cause a security issue if the client doesn't respond to the |
| | | 394 | | // connection initialization as we wouldn't be able to accept new connections in the meantime. The |
| | | 395 | | // call will eventually timeout if the ConnectTimeout expires. |
| | 92 | 396 | | CancellationToken cancellationToken = _disposedCts.Token; |
| | 92 | 397 | | _ = Task.Run( |
| | 92 | 398 | | async () => |
| | 92 | 399 | | { |
| | 92 | 400 | | try |
| | 92 | 401 | | { |
| | 92 | 402 | | await ConnectAsync(connector, cancellationToken).ConfigureAwait(false); |
| | 87 | 403 | | } |
| | 5 | 404 | | catch |
| | 5 | 405 | | { |
| | 92 | 406 | | // Ignore connection establishment failure. This failures are logged by the |
| | 92 | 407 | | // LogConnectorDecorator |
| | 5 | 408 | | } |
| | 92 | 409 | | finally |
| | 92 | 410 | | { |
| | 92 | 411 | | // The connection dispose will dispose the transport connection if it has not been |
| | 92 | 412 | | // adopted by the protocol connection. |
| | 92 | 413 | | await connector.DisposeAsync().ConfigureAwait(false); |
| | 92 | 414 | | |
| | 92 | 415 | | // The pending connection semaphore is disposed by the listen task completion once |
| | 92 | 416 | | // shutdown / dispose is initiated. |
| | 92 | 417 | | lock (_mutex) |
| | 92 | 418 | | { |
| | 92 | 419 | | if (_shutdownTask is null) |
| | 88 | 420 | | { |
| | 88 | 421 | | pendingConnectionSemaphore.Release(); |
| | 88 | 422 | | } |
| | 92 | 423 | | } |
| | 92 | 424 | | } |
| | 92 | 425 | | }, |
| | 92 | 426 | | CancellationToken.None); // the task must run to dispose the connector. |
| | 92 | 427 | | } |
| | 0 | 428 | | } |
| | 93 | 429 | | catch |
| | 93 | 430 | | { |
| | | 431 | | // Ignore. Exceptions thrown by listener.AcceptAsync are logged by the log decorator when appropriate. |
| | 93 | 432 | | } |
| | | 433 | | finally |
| | 93 | 434 | | { |
| | 93 | 435 | | await listener.DisposeAsync().ConfigureAwait(false); |
| | 93 | 436 | | } |
| | | 437 | | |
| | | 438 | | async Task ConnectAsync(IConnector connector, CancellationToken cancellationToken) |
| | 92 | 439 | | { |
| | 92 | 440 | | using var connectCts = CancellationTokenSource.CreateLinkedTokenSource(cancellationToken); |
| | 92 | 441 | | connectCts.CancelAfter(_connectTimeout); |
| | | 442 | | |
| | | 443 | | // Connect the transport connection first. This connection establishment can be interrupted by the |
| | | 444 | | // connect timeout or the server ShutdownAsync/DisposeAsync. |
| | 92 | 445 | | TransportConnectionInformation transportConnectionInformation = |
| | 92 | 446 | | await connector.ConnectTransportConnectionAsync(connectCts.Token).ConfigureAwait(false); |
| | | 447 | | |
| | 87 | 448 | | IProtocolConnection? protocolConnection = null; |
| | 87 | 449 | | bool serverBusy = false; |
| | | 450 | | |
| | | 451 | | lock (_mutex) |
| | 87 | 452 | | { |
| | 87 | 453 | | Debug.Assert( |
| | 87 | 454 | | _maxConnections == 0 || _connections.Count + _detachedConnectionCount <= _maxConnections); |
| | | 455 | | |
| | 87 | 456 | | if (_shutdownTask is null) |
| | 87 | 457 | | { |
| | 87 | 458 | | if (_maxConnections > 0 && (_connections.Count + _detachedConnectionCount) == _maxConnections) |
| | 7 | 459 | | { |
| | 7 | 460 | | serverBusy = true; |
| | 7 | 461 | | } |
| | | 462 | | else |
| | 80 | 463 | | { |
| | | 464 | | // The protocol connection adopts the transport connection from the connector and it's |
| | | 465 | | // now responsible for disposing of it. |
| | 80 | 466 | | protocolConnection = connector.CreateProtocolConnection(transportConnectionInformation); |
| | 80 | 467 | | _detachedConnectionCount++; |
| | 80 | 468 | | } |
| | 87 | 469 | | } |
| | 87 | 470 | | } |
| | | 471 | | |
| | 87 | 472 | | if (protocolConnection is null) |
| | 7 | 473 | | { |
| | | 474 | | try |
| | 7 | 475 | | { |
| | 7 | 476 | | await connector.RefuseTransportConnectionAsync(serverBusy, connectCts.Token) |
| | 7 | 477 | | .ConfigureAwait(false); |
| | 5 | 478 | | } |
| | 2 | 479 | | catch |
| | 2 | 480 | | { |
| | | 481 | | // ignore and continue |
| | 2 | 482 | | } |
| | | 483 | | // The transport connection is disposed by the disposal of the connector. |
| | 7 | 484 | | } |
| | | 485 | | else |
| | 80 | 486 | | { |
| | | 487 | | Task shutdownRequested; |
| | | 488 | | try |
| | 80 | 489 | | { |
| | 80 | 490 | | (_, shutdownRequested) = await protocolConnection.ConnectAsync(connectCts.Token) |
| | 80 | 491 | | .ConfigureAwait(false); |
| | 80 | 492 | | } |
| | 0 | 493 | | catch |
| | 0 | 494 | | { |
| | 0 | 495 | | await DisposeDetachedConnectionAsync(protocolConnection, withShutdown: false) |
| | 0 | 496 | | .ConfigureAwait(false); |
| | 0 | 497 | | throw; |
| | | 498 | | } |
| | | 499 | | |
| | 80 | 500 | | LinkedListNode<IProtocolConnection>? listNode = null; |
| | | 501 | | |
| | | 502 | | lock (_mutex) |
| | | 503 | | { |
| | 80 | 504 | | if (_shutdownTask is null) |
| | | 505 | | { |
| | 79 | 506 | | listNode = _connections.AddLast(protocolConnection); |
| | | 507 | | |
| | | 508 | | // protocolConnection is no longer a detached connection since it's now "attached" in |
| | | 509 | | // _connections. |
| | 79 | 510 | | _detachedConnectionCount--; |
| | | 511 | | } |
| | 80 | 512 | | } |
| | | 513 | | |
| | 80 | 514 | | if (listNode is null) |
| | | 515 | | { |
| | 1 | 516 | | await DisposeDetachedConnectionAsync(protocolConnection, withShutdown: true) |
| | 1 | 517 | | .ConfigureAwait(false); |
| | | 518 | | } |
| | | 519 | | else |
| | 79 | 520 | | { |
| | | 521 | | // Schedule removal after successful ConnectAsync. |
| | 79 | 522 | | _ = ShutdownWhenRequestedAsync(protocolConnection, shutdownRequested, listNode); |
| | | 523 | | } |
| | 80 | 524 | | } |
| | | 525 | | } |
| | | 526 | | } |
| | | 527 | | |
| | | 528 | | async Task DisposeDetachedConnectionAsync(IProtocolConnection connection, bool withShutdown) |
| | 32 | 529 | | { |
| | 32 | 530 | | if (withShutdown) |
| | 32 | 531 | | { |
| | | 532 | | // _disposedCts is not disposed since we own a _backgroundConnectionDisposeCount. |
| | 32 | 533 | | using var cts = CancellationTokenSource.CreateLinkedTokenSource(_disposedCts.Token); |
| | 32 | 534 | | cts.CancelAfter(_shutdownTimeout); |
| | | 535 | | |
| | | 536 | | try |
| | 32 | 537 | | { |
| | | 538 | | // Can be canceled by DisposeAsync or the shutdown timeout. |
| | 32 | 539 | | await connection.ShutdownAsync(cts.Token).ConfigureAwait(false); |
| | 21 | 540 | | } |
| | 11 | 541 | | catch |
| | 11 | 542 | | { |
| | | 543 | | // Ignore connection shutdown failures. connection.ShutdownAsync makes sure it's an "expected" |
| | | 544 | | // exception. |
| | 11 | 545 | | } |
| | 32 | 546 | | } |
| | | 547 | | |
| | 32 | 548 | | await connection.DisposeAsync().ConfigureAwait(false); |
| | | 549 | | lock (_mutex) |
| | 32 | 550 | | { |
| | 32 | 551 | | if (--_detachedConnectionCount == 0 && _shutdownTask is not null) |
| | 12 | 552 | | { |
| | 12 | 553 | | _detachedConnectionsTcs.SetResult(); |
| | 12 | 554 | | } |
| | 32 | 555 | | } |
| | 32 | 556 | | } |
| | | 557 | | |
| | | 558 | | // Remove the connection from _connections after a successful ConnectAsync. |
| | | 559 | | async Task ShutdownWhenRequestedAsync( |
| | | 560 | | IProtocolConnection connection, |
| | | 561 | | Task shutdownRequested, |
| | | 562 | | LinkedListNode<IProtocolConnection> listNode) |
| | 79 | 563 | | { |
| | 79 | 564 | | await shutdownRequested.ConfigureAwait(false); |
| | | 565 | | |
| | | 566 | | lock (_mutex) |
| | 65 | 567 | | { |
| | 65 | 568 | | if (_shutdownTask is null) |
| | 31 | 569 | | { |
| | 31 | 570 | | _connections.Remove(listNode); |
| | 31 | 571 | | _detachedConnectionCount++; |
| | 31 | 572 | | } |
| | | 573 | | else |
| | 34 | 574 | | { |
| | | 575 | | // _connections is immutable and ShutdownAsync/DisposeAsync is responsible to shut down/dispose |
| | | 576 | | // this connection. |
| | 34 | 577 | | return; |
| | | 578 | | } |
| | 31 | 579 | | } |
| | | 580 | | |
| | 31 | 581 | | await DisposeDetachedConnectionAsync(connection, withShutdown: true).ConfigureAwait(false); |
| | 65 | 582 | | } |
| | 273 | 583 | | } |
| | | 584 | | |
| | | 585 | | /// <summary>Gracefully shuts down this server: the server stops accepting new connections and shuts down gracefully |
| | | 586 | | /// all its connections.</summary> |
| | | 587 | | /// <param name="cancellationToken">A cancellation token that receives the cancellation requests.</param> |
| | | 588 | | /// <returns>A task that completes successfully once the shutdown of all connections accepted by the server has |
| | | 589 | | /// completed. This includes connections that were active when this method is called and connections whose shutdown |
| | | 590 | | /// was initiated prior to this call.</returns> |
| | | 591 | | /// <exception cref="InvalidOperationException">Thrown when this method is called more than once.</exception> |
| | | 592 | | /// <exception cref="ObjectDisposedException">Thrown when the server is disposed.</exception> |
| | | 593 | | /// <remarks><para>The returned task can also complete with one of the following exceptions:</para> |
| | | 594 | | /// <list type="bullet"> |
| | | 595 | | /// <item><description><see cref="IceRpcException" /> with error <see cref="IceRpcError.OperationAborted" /> if the |
| | | 596 | | /// server is disposed while being shut down.</description></item> |
| | | 597 | | /// <item><description><see cref="OperationCanceledException" /> if cancellation was requested through the |
| | | 598 | | /// cancellation token.</description></item> |
| | | 599 | | /// <item><description><see cref="TimeoutException" /> if the shutdown timed out.</description></item> |
| | | 600 | | /// </list> |
| | | 601 | | /// </remarks> |
| | | 602 | | public Task ShutdownAsync(CancellationToken cancellationToken = default) |
| | 34 | 603 | | { |
| | | 604 | | lock (_mutex) |
| | 34 | 605 | | { |
| | 34 | 606 | | ObjectDisposedException.ThrowIf(_disposeTask is not null, this); |
| | | 607 | | |
| | 34 | 608 | | if (_shutdownTask is not null) |
| | 0 | 609 | | { |
| | 0 | 610 | | throw new InvalidOperationException($"Server '{this}' is shut down or shutting down."); |
| | | 611 | | } |
| | | 612 | | |
| | 34 | 613 | | if (_detachedConnectionCount == 0) |
| | 30 | 614 | | { |
| | 30 | 615 | | _detachedConnectionsTcs.SetResult(); |
| | 30 | 616 | | } |
| | | 617 | | |
| | 34 | 618 | | _shutdownTask = PerformShutdownAsync(); |
| | 34 | 619 | | } |
| | 34 | 620 | | return _shutdownTask; |
| | | 621 | | |
| | | 622 | | async Task PerformShutdownAsync() |
| | 34 | 623 | | { |
| | 34 | 624 | | await Task.Yield(); // exit mutex lock |
| | | 625 | | |
| | 34 | 626 | | _shutdownCts.Cancel(); |
| | | 627 | | |
| | | 628 | | // _listenTask is immutable once _shutdownTask is not null. |
| | 34 | 629 | | if (_listenTask is not null) |
| | 34 | 630 | | { |
| | | 631 | | try |
| | 34 | 632 | | { |
| | 34 | 633 | | using var cts = CancellationTokenSource.CreateLinkedTokenSource( |
| | 34 | 634 | | cancellationToken, |
| | 34 | 635 | | _disposedCts.Token); |
| | | 636 | | |
| | 34 | 637 | | cts.CancelAfter(_shutdownTimeout); |
| | | 638 | | |
| | | 639 | | try |
| | 34 | 640 | | { |
| | 34 | 641 | | await Task.WhenAll( |
| | 34 | 642 | | _connections |
| | 14 | 643 | | .Select(connection => connection.ShutdownAsync(cts.Token)) |
| | 34 | 644 | | .Append(_listenTask.WaitAsync(cts.Token)) |
| | 34 | 645 | | .Append(_detachedConnectionsTcs.Task.WaitAsync(cts.Token))) |
| | 34 | 646 | | .ConfigureAwait(false); |
| | 33 | 647 | | } |
| | 0 | 648 | | catch (OperationCanceledException) |
| | 0 | 649 | | { |
| | 0 | 650 | | throw; |
| | | 651 | | } |
| | 1 | 652 | | catch |
| | 1 | 653 | | { |
| | | 654 | | // Ignore _listenTask and connection shutdown exceptions |
| | | 655 | | |
| | | 656 | | // Throw OperationCanceledException if this WhenAll exception is hiding an OCE. |
| | 1 | 657 | | cts.Token.ThrowIfCancellationRequested(); |
| | 1 | 658 | | } |
| | 34 | 659 | | } |
| | 0 | 660 | | catch (OperationCanceledException) |
| | 0 | 661 | | { |
| | 0 | 662 | | cancellationToken.ThrowIfCancellationRequested(); |
| | | 663 | | |
| | 0 | 664 | | if (_disposedCts.IsCancellationRequested) |
| | 0 | 665 | | { |
| | 0 | 666 | | throw new IceRpcException( |
| | 0 | 667 | | IceRpcError.OperationAborted, |
| | 0 | 668 | | "The shutdown was aborted because the server was disposed."); |
| | | 669 | | } |
| | | 670 | | else |
| | 0 | 671 | | { |
| | 0 | 672 | | throw new TimeoutException( |
| | 0 | 673 | | $"The server shut down timed out after {_shutdownTimeout.TotalSeconds} s."); |
| | | 674 | | } |
| | | 675 | | } |
| | 34 | 676 | | } |
| | 34 | 677 | | } |
| | 34 | 678 | | } |
| | | 679 | | |
| | | 680 | | /// <summary>Returns a string that represents this server.</summary> |
| | | 681 | | /// <returns>A string that represents this server.</returns> |
| | 1 | 682 | | public override string ToString() => _serverAddress.ToString(); |
| | | 683 | | |
| | | 684 | | /// <summary>Returns true if the <see cref="IConnectorListener.AcceptAsync" /> failure can be retried.</summary> |
| | | 685 | | private static bool IsRetryableAcceptException(Exception exception) => |
| | | 686 | | // Transports such as QUIC do the SSL handshake when the connection is accepted, this can throw |
| | | 687 | | // AuthenticationException if it fails. |
| | 211 | 688 | | exception is IceRpcException or AuthenticationException; |
| | | 689 | | |
| | | 690 | | /// <summary>Provides a decorator that adds logging to a <see cref="IConnectorListener" />.</summary> |
| | | 691 | | private class LogConnectorListenerDecorator : IConnectorListener |
| | | 692 | | { |
| | 46 | 693 | | public ServerAddress ServerAddress => _decoratee.ServerAddress; |
| | | 694 | | |
| | | 695 | | private readonly IConnectorListener _decoratee; |
| | | 696 | | private readonly ILogger _logger; |
| | | 697 | | |
| | | 698 | | public async Task<(IConnector, EndPoint)> AcceptAsync(CancellationToken cancellationToken) |
| | 18 | 699 | | { |
| | | 700 | | try |
| | 18 | 701 | | { |
| | 18 | 702 | | (IConnector connector, EndPoint remoteNetworkAddress) = |
| | 18 | 703 | | await _decoratee.AcceptAsync(cancellationToken).ConfigureAwait(false); |
| | | 704 | | |
| | 8 | 705 | | _logger.LogConnectionAccepted(ServerAddress, remoteNetworkAddress); |
| | 8 | 706 | | return ( |
| | 8 | 707 | | new LogConnectorDecorator(connector, ServerAddress, remoteNetworkAddress, _logger), |
| | 8 | 708 | | remoteNetworkAddress); |
| | | 709 | | } |
| | 10 | 710 | | catch (OperationCanceledException exception) when (exception.CancellationToken == cancellationToken) |
| | 10 | 711 | | { |
| | | 712 | | // Do not log this exception. The AcceptAsync call can fail with OperationCanceledException during |
| | | 713 | | // shutdown once the shutdown cancellation token is canceled. |
| | 10 | 714 | | throw; |
| | | 715 | | } |
| | 0 | 716 | | catch (ObjectDisposedException) |
| | 0 | 717 | | { |
| | | 718 | | // Do not log this exception. The AcceptAsync call can fail with ObjectDisposedException during |
| | | 719 | | // shutdown once the listener is disposed or if it is accepting a connection while the listener is |
| | | 720 | | // disposed. |
| | 0 | 721 | | throw; |
| | | 722 | | } |
| | 0 | 723 | | catch (Exception exception) when (IsRetryableAcceptException(exception)) |
| | 0 | 724 | | { |
| | 0 | 725 | | _logger.LogConnectionAcceptFailedWithRetryableException(ServerAddress, exception); |
| | 0 | 726 | | throw; |
| | | 727 | | } |
| | 0 | 728 | | catch (Exception exception) |
| | 0 | 729 | | { |
| | 0 | 730 | | _logger.LogConnectionAcceptFailed(ServerAddress, exception); |
| | 0 | 731 | | throw; |
| | | 732 | | } |
| | 8 | 733 | | } |
| | | 734 | | |
| | | 735 | | public ValueTask DisposeAsync() |
| | 10 | 736 | | { |
| | 10 | 737 | | _logger.LogStopAcceptingConnections(ServerAddress); |
| | 10 | 738 | | return _decoratee.DisposeAsync(); |
| | 10 | 739 | | } |
| | | 740 | | |
| | 10 | 741 | | internal LogConnectorListenerDecorator(IConnectorListener decoratee, ILogger logger) |
| | 10 | 742 | | { |
| | 10 | 743 | | _decoratee = decoratee; |
| | 10 | 744 | | _logger = logger; |
| | 10 | 745 | | _logger.LogStartAcceptingConnections(ServerAddress); |
| | 10 | 746 | | } |
| | | 747 | | } |
| | | 748 | | |
| | | 749 | | private class LogConnectorDecorator : IConnector |
| | | 750 | | { |
| | | 751 | | private readonly IConnector _decoratee; |
| | | 752 | | private readonly ILogger _logger; |
| | | 753 | | private readonly EndPoint _remoteNetworkAddress; |
| | | 754 | | private readonly ServerAddress _serverAddress; |
| | | 755 | | |
| | | 756 | | public async Task<TransportConnectionInformation> ConnectTransportConnectionAsync( |
| | | 757 | | CancellationToken cancellationToken) |
| | 8 | 758 | | { |
| | | 759 | | try |
| | 8 | 760 | | { |
| | 8 | 761 | | return await _decoratee.ConnectTransportConnectionAsync(cancellationToken).ConfigureAwait(false); |
| | | 762 | | } |
| | 2 | 763 | | catch (Exception exception) |
| | 2 | 764 | | { |
| | 2 | 765 | | _logger.LogConnectionConnectFailed(_serverAddress, _remoteNetworkAddress, exception); |
| | 2 | 766 | | throw; |
| | | 767 | | } |
| | 6 | 768 | | } |
| | | 769 | | |
| | | 770 | | public IProtocolConnection CreateProtocolConnection( |
| | | 771 | | TransportConnectionInformation transportConnectionInformation) => |
| | 6 | 772 | | new LogProtocolConnectionDecorator( |
| | 6 | 773 | | _decoratee.CreateProtocolConnection(transportConnectionInformation), |
| | 6 | 774 | | _serverAddress, |
| | 6 | 775 | | _remoteNetworkAddress, |
| | 6 | 776 | | _logger); |
| | | 777 | | |
| | 8 | 778 | | public ValueTask DisposeAsync() => _decoratee.DisposeAsync(); |
| | | 779 | | |
| | | 780 | | public Task RefuseTransportConnectionAsync(bool serverBusy, CancellationToken cancel) => |
| | 0 | 781 | | _decoratee.RefuseTransportConnectionAsync(serverBusy, cancel); |
| | | 782 | | |
| | 8 | 783 | | internal LogConnectorDecorator( |
| | 8 | 784 | | IConnector decoratee, |
| | 8 | 785 | | ServerAddress serverAddress, |
| | 8 | 786 | | EndPoint remoteNetworkAddress, |
| | 8 | 787 | | ILogger logger) |
| | 8 | 788 | | { |
| | 8 | 789 | | _decoratee = decoratee; |
| | 8 | 790 | | _logger = logger; |
| | 8 | 791 | | _serverAddress = serverAddress; |
| | 8 | 792 | | _remoteNetworkAddress = remoteNetworkAddress; |
| | 8 | 793 | | } |
| | | 794 | | } |
| | | 795 | | |
| | | 796 | | /// <summary>Provides a decorator that adds metrics to a <see cref="IConnectorListener" />.</summary> |
| | | 797 | | private class MetricsConnectorListenerDecorator : IConnectorListener |
| | | 798 | | { |
| | 129 | 799 | | public ServerAddress ServerAddress => _decoratee.ServerAddress; |
| | | 800 | | |
| | | 801 | | private readonly IConnectorListener _decoratee; |
| | | 802 | | |
| | | 803 | | public async Task<(IConnector, EndPoint)> AcceptAsync( |
| | | 804 | | CancellationToken cancellationToken) |
| | 303 | 805 | | { |
| | 303 | 806 | | (IConnector connector, EndPoint remoteNetworkAddress) = |
| | 303 | 807 | | await _decoratee.AcceptAsync(cancellationToken).ConfigureAwait(false); |
| | 92 | 808 | | return (new MetricsConnectorDecorator(connector), remoteNetworkAddress); |
| | 92 | 809 | | } |
| | | 810 | | |
| | 93 | 811 | | public ValueTask DisposeAsync() => _decoratee.DisposeAsync(); |
| | | 812 | | |
| | 93 | 813 | | internal MetricsConnectorListenerDecorator(IConnectorListener decoratee) => |
| | 93 | 814 | | _decoratee = decoratee; |
| | | 815 | | } |
| | | 816 | | |
| | | 817 | | private class MetricsConnectorDecorator : IConnector |
| | | 818 | | { |
| | | 819 | | private readonly IConnector _decoratee; |
| | | 820 | | |
| | | 821 | | public async Task<TransportConnectionInformation> ConnectTransportConnectionAsync( |
| | | 822 | | CancellationToken cancellationToken) |
| | 92 | 823 | | { |
| | 92 | 824 | | Metrics.ServerMetrics.ConnectStart(); |
| | | 825 | | try |
| | 92 | 826 | | { |
| | 92 | 827 | | return await _decoratee.ConnectTransportConnectionAsync(cancellationToken).ConfigureAwait(false); |
| | | 828 | | } |
| | 5 | 829 | | catch |
| | 5 | 830 | | { |
| | 5 | 831 | | Metrics.ServerMetrics.ConnectStop(); |
| | 5 | 832 | | Metrics.ServerMetrics.ConnectionFailure(); |
| | 5 | 833 | | throw; |
| | | 834 | | } |
| | 87 | 835 | | } |
| | | 836 | | |
| | | 837 | | public IProtocolConnection CreateProtocolConnection( |
| | | 838 | | TransportConnectionInformation transportConnectionInformation) => |
| | 80 | 839 | | new MetricsProtocolConnectionDecorator( |
| | 80 | 840 | | _decoratee.CreateProtocolConnection(transportConnectionInformation), |
| | 80 | 841 | | Metrics.ServerMetrics, |
| | 80 | 842 | | connectStarted: true); |
| | | 843 | | |
| | 92 | 844 | | public ValueTask DisposeAsync() => _decoratee.DisposeAsync(); |
| | | 845 | | |
| | | 846 | | public async Task RefuseTransportConnectionAsync(bool serverBusy, CancellationToken cancel) |
| | 7 | 847 | | { |
| | | 848 | | try |
| | 7 | 849 | | { |
| | 7 | 850 | | await _decoratee.RefuseTransportConnectionAsync(serverBusy, cancel).ConfigureAwait(false); |
| | 5 | 851 | | } |
| | | 852 | | finally |
| | 7 | 853 | | { |
| | 7 | 854 | | Metrics.ServerMetrics.ConnectionFailure(); |
| | 7 | 855 | | Metrics.ServerMetrics.ConnectStop(); |
| | 7 | 856 | | } |
| | 5 | 857 | | } |
| | | 858 | | |
| | 184 | 859 | | internal MetricsConnectorDecorator(IConnector decoratee) => _decoratee = decoratee; |
| | | 860 | | } |
| | | 861 | | |
| | | 862 | | /// <summary>A connector listener accepts a transport connection and returns a <see cref="IConnector" />. The |
| | | 863 | | /// connector is used to refuse the transport connection or obtain a protocol connection once the transport |
| | | 864 | | /// connection is connected.</summary> |
| | | 865 | | private interface IConnectorListener : IAsyncDisposable |
| | | 866 | | { |
| | | 867 | | ServerAddress ServerAddress { get; } |
| | | 868 | | |
| | | 869 | | Task<(IConnector, EndPoint)> AcceptAsync(CancellationToken cancel); |
| | | 870 | | } |
| | | 871 | | |
| | | 872 | | /// <summary>A connector is returned by <see cref="IConnectorListener" />. The connector allows to connect the |
| | | 873 | | /// transport connection. If successful, the transport connection can either be refused or accepted by creating the |
| | | 874 | | /// protocol connection out of it.</summary> |
| | | 875 | | private interface IConnector : IAsyncDisposable |
| | | 876 | | { |
| | | 877 | | Task<TransportConnectionInformation> ConnectTransportConnectionAsync(CancellationToken cancellationToken); |
| | | 878 | | |
| | | 879 | | IProtocolConnection CreateProtocolConnection(TransportConnectionInformation transportConnectionInformation); |
| | | 880 | | |
| | | 881 | | Task RefuseTransportConnectionAsync(bool serverBusy, CancellationToken cancel); |
| | | 882 | | } |
| | | 883 | | |
| | | 884 | | private class IceConnectorListener : IConnectorListener |
| | | 885 | | { |
| | 43 | 886 | | public ServerAddress ServerAddress { get; } |
| | | 887 | | |
| | | 888 | | private readonly IListener<IDuplexConnection> _listener; |
| | | 889 | | private readonly ConnectionOptions _options; |
| | | 890 | | |
| | 25 | 891 | | public ValueTask DisposeAsync() => _listener.DisposeAsync(); |
| | | 892 | | |
| | | 893 | | public async Task<(IConnector, EndPoint)> AcceptAsync(CancellationToken cancel) |
| | 51 | 894 | | { |
| | 51 | 895 | | (IDuplexConnection transportConnection, EndPoint remoteNetworkAddress) = await _listener.AcceptAsync( |
| | 51 | 896 | | cancel).ConfigureAwait(false); |
| | 26 | 897 | | return (new IceConnector(transportConnection, _options), remoteNetworkAddress); |
| | 26 | 898 | | } |
| | | 899 | | |
| | 25 | 900 | | internal IceConnectorListener( |
| | 25 | 901 | | IListener<IDuplexConnection> listener, |
| | 25 | 902 | | ServerAddress serverAddress, |
| | 25 | 903 | | ConnectionOptions options) |
| | 25 | 904 | | { |
| | 25 | 905 | | _listener = listener; |
| | 25 | 906 | | ServerAddress = serverAddress with { Port = listener.TransportAddress.Port }; |
| | 25 | 907 | | _options = options; |
| | 25 | 908 | | } |
| | | 909 | | } |
| | | 910 | | |
| | | 911 | | private class IceConnector : IConnector |
| | | 912 | | { |
| | | 913 | | private readonly ConnectionOptions _options; |
| | | 914 | | private IDuplexConnection? _transportConnection; |
| | | 915 | | |
| | | 916 | | public Task<TransportConnectionInformation> ConnectTransportConnectionAsync( |
| | | 917 | | CancellationToken cancellationToken) => |
| | 26 | 918 | | _transportConnection!.ConnectAsync(cancellationToken); |
| | | 919 | | |
| | | 920 | | public IProtocolConnection CreateProtocolConnection( |
| | | 921 | | TransportConnectionInformation transportConnectionInformation) |
| | 23 | 922 | | { |
| | | 923 | | // The protocol connection takes ownership of the transport connection. |
| | 23 | 924 | | var protocolConnection = new IceProtocolConnection( |
| | 23 | 925 | | _transportConnection!, |
| | 23 | 926 | | transportConnectionInformation, |
| | 23 | 927 | | _options); |
| | 23 | 928 | | _transportConnection = null; |
| | 23 | 929 | | return protocolConnection; |
| | 23 | 930 | | } |
| | | 931 | | |
| | | 932 | | public ValueTask DisposeAsync() |
| | 26 | 933 | | { |
| | 26 | 934 | | _transportConnection?.Dispose(); |
| | 26 | 935 | | return new(); |
| | 26 | 936 | | } |
| | | 937 | | |
| | | 938 | | public Task RefuseTransportConnectionAsync(bool serverBusy, CancellationToken cancellationToken) |
| | 2 | 939 | | { |
| | 2 | 940 | | _transportConnection!.Dispose(); |
| | 2 | 941 | | return Task.CompletedTask; |
| | 2 | 942 | | } |
| | | 943 | | |
| | 26 | 944 | | internal IceConnector(IDuplexConnection transportConnection, ConnectionOptions options) |
| | 26 | 945 | | { |
| | 26 | 946 | | _transportConnection = transportConnection; |
| | 26 | 947 | | _options = options; |
| | 26 | 948 | | } |
| | | 949 | | } |
| | | 950 | | |
| | | 951 | | private class IceRpcConnectorListener : IConnectorListener |
| | | 952 | | { |
| | 86 | 953 | | public ServerAddress ServerAddress { get; } |
| | | 954 | | |
| | | 955 | | private readonly IListener<IMultiplexedConnection> _listener; |
| | | 956 | | private readonly ConnectionOptions _options; |
| | | 957 | | private readonly ITaskExceptionObserver? _taskExceptionObserver; |
| | | 958 | | |
| | | 959 | | public async Task<(IConnector, EndPoint)> AcceptAsync(CancellationToken cancel) |
| | 252 | 960 | | { |
| | 252 | 961 | | (IMultiplexedConnection transportConnection, EndPoint remoteNetworkAddress) = await _listener.AcceptAsync( |
| | 252 | 962 | | cancel).ConfigureAwait(false); |
| | 66 | 963 | | return (new IceRpcConnector(transportConnection, _options, _taskExceptionObserver), remoteNetworkAddress); |
| | 66 | 964 | | } |
| | | 965 | | |
| | 68 | 966 | | public ValueTask DisposeAsync() => _listener.DisposeAsync(); |
| | | 967 | | |
| | 68 | 968 | | internal IceRpcConnectorListener( |
| | 68 | 969 | | IListener<IMultiplexedConnection> listener, |
| | 68 | 970 | | ServerAddress serverAddress, |
| | 68 | 971 | | ConnectionOptions options, |
| | 68 | 972 | | ITaskExceptionObserver? taskExceptionObserver) |
| | 68 | 973 | | { |
| | 68 | 974 | | _listener = listener; |
| | 68 | 975 | | ServerAddress = serverAddress with { Port = listener.TransportAddress.Port }; |
| | 68 | 976 | | _options = options; |
| | 68 | 977 | | _taskExceptionObserver = taskExceptionObserver; |
| | 68 | 978 | | } |
| | | 979 | | } |
| | | 980 | | |
| | | 981 | | private class IceRpcConnector : IConnector |
| | | 982 | | { |
| | | 983 | | private readonly ConnectionOptions _options; |
| | | 984 | | private readonly ITaskExceptionObserver? _taskExceptionObserver; |
| | | 985 | | private IMultiplexedConnection? _transportConnection; |
| | | 986 | | |
| | | 987 | | public Task<TransportConnectionInformation> ConnectTransportConnectionAsync( |
| | | 988 | | CancellationToken cancellationToken) => |
| | 66 | 989 | | _transportConnection!.ConnectAsync(cancellationToken); |
| | | 990 | | |
| | | 991 | | public IProtocolConnection CreateProtocolConnection( |
| | | 992 | | TransportConnectionInformation transportConnectionInformation) |
| | 57 | 993 | | { |
| | | 994 | | // The protocol connection takes ownership of the transport connection. |
| | 57 | 995 | | var protocolConnection = new IceRpcProtocolConnection( |
| | 57 | 996 | | _transportConnection!, |
| | 57 | 997 | | transportConnectionInformation, |
| | 57 | 998 | | _options, |
| | 57 | 999 | | _taskExceptionObserver); |
| | 57 | 1000 | | _transportConnection = null; |
| | 57 | 1001 | | return protocolConnection; |
| | 57 | 1002 | | } |
| | | 1003 | | |
| | 66 | 1004 | | public ValueTask DisposeAsync() => _transportConnection?.DisposeAsync() ?? new(); |
| | | 1005 | | |
| | | 1006 | | public Task RefuseTransportConnectionAsync(bool serverBusy, CancellationToken cancellationToken) => |
| | 5 | 1007 | | _transportConnection!.CloseAsync( |
| | 5 | 1008 | | serverBusy ? MultiplexedConnectionCloseError.ServerBusy : MultiplexedConnectionCloseError.Refused, |
| | 5 | 1009 | | cancellationToken); |
| | | 1010 | | |
| | 66 | 1011 | | internal IceRpcConnector( |
| | 66 | 1012 | | IMultiplexedConnection transportConnection, |
| | 66 | 1013 | | ConnectionOptions options, |
| | 66 | 1014 | | ITaskExceptionObserver? taskExceptionObserver) |
| | 66 | 1015 | | { |
| | 66 | 1016 | | _transportConnection = transportConnection; |
| | 66 | 1017 | | _options = options; |
| | 66 | 1018 | | _taskExceptionObserver = taskExceptionObserver; |
| | 66 | 1019 | | } |
| | | 1020 | | } |
| | | 1021 | | } |