| | | 1 | | // Copyright (c) ZeroC, Inc. |
| | | 2 | | |
| | | 3 | | using System.Net.Sockets; |
| | | 4 | | |
| | | 5 | | namespace IceRpc.Transports; |
| | | 6 | | |
| | | 7 | | /// <summary>Provides an extension method for <see cref="SocketException"/> to convert it into an <see |
| | | 8 | | /// cref="IceRpcException"/>.</summary> |
| | | 9 | | public static class SocketExceptionExtensions |
| | | 10 | | { |
| | | 11 | | /// <summary>Converts a <see cref="SocketException"/> into an <see cref="IceRpcException" />.</summary> |
| | | 12 | | /// <param name="exception">The exception to convert.</param> |
| | | 13 | | /// <param name="innerException">The inner exception for the <see cref="IceRpcException"/>, when |
| | | 14 | | /// <see langword="null"/> <paramref name="exception"/> is used as the inner exception.</param> |
| | | 15 | | /// <returns>The <see cref="IceRpcException"/> created from the <see cref="SocketException"/>.</returns> |
| | | 16 | | public static IceRpcException ToIceRpcException(this SocketException exception, Exception? innerException = null) |
| | 43 | 17 | | { |
| | 43 | 18 | | innerException ??= exception; |
| | 43 | 19 | | IceRpcError errorCode = exception.SocketErrorCode switch |
| | 43 | 20 | | { |
| | 43 | 21 | | // Address is already in use when attempting to bind a listening socket. |
| | 3 | 22 | | SocketError.AddressAlreadyInUse => IceRpcError.AddressInUse, |
| | 43 | 23 | | |
| | 43 | 24 | | // ConnectionAborted is reported by the OS and is often triggered by the peer or by a network failure. |
| | 0 | 25 | | SocketError.ConnectionAborted => IceRpcError.ConnectionAborted, |
| | 43 | 26 | | |
| | 43 | 27 | | // Shutdown matches EPIPE and ConnectionReset matches ECONNRESET. Both are the result of the peer |
| | 43 | 28 | | // closing the connection non-gracefully. |
| | 43 | 29 | | // |
| | 43 | 30 | | // EPIPE is returned when writing to a socket that has been closed and the send buffer is empty. |
| | 43 | 31 | | // ECONNRESET is returned when the connection is reset while data is still pending in the send buffer. |
| | 43 | 32 | | // |
| | 43 | 33 | | // In both cases the connection can no longer be used. |
| | 35 | 34 | | SocketError.ConnectionReset => IceRpcError.ConnectionAborted, |
| | 2 | 35 | | SocketError.Shutdown => IceRpcError.ConnectionAborted, |
| | 43 | 36 | | |
| | 43 | 37 | | // NetworkReset indicates that an established connection became invalid due to a network event |
| | 43 | 38 | | // (for example interface reset, Wi-Fi reconnect, VPN reconnect). |
| | 0 | 39 | | SocketError.NetworkReset => IceRpcError.ConnectionAborted, |
| | 43 | 40 | | |
| | 43 | 41 | | // The server is reachable but no process is listening on the target port. |
| | 2 | 42 | | SocketError.ConnectionRefused => IceRpcError.ConnectionRefused, |
| | 43 | 43 | | |
| | 43 | 44 | | // These errors indicate the remote server cannot be reached. This includes routing failures, |
| | 43 | 45 | | // local network failures, OS-level TCP timeouts, and host reachability failures. |
| | 43 | 46 | | // |
| | 43 | 47 | | // The TimedOut error refers to the OS TCP stack exhausting SYN retransmissions when |
| | 43 | 48 | | // attempting to connect — not to IceRPC-level timeouts, which result in |
| | 43 | 49 | | // OperationCanceledException via CancellationToken. |
| | 43 | 50 | | // |
| | 43 | 51 | | // With the async socket API used by IceRPC, these errors occur during connection |
| | 43 | 52 | | // establishment. On an established TCP connection, the kernel absorbs ICMP errors |
| | 43 | 53 | | // and retransmits internally; the application sees ConnectionReset (mapped to |
| | 43 | 54 | | // ConnectionAborted above) rather than these reachability errors. |
| | 43 | 55 | | // |
| | 43 | 56 | | // They are grouped as ServerUnreachable because from the RPC perspective the connection |
| | 43 | 57 | | // cannot be established. |
| | 1 | 58 | | SocketError.HostUnreachable => IceRpcError.ServerUnreachable, |
| | 0 | 59 | | SocketError.NetworkUnreachable => IceRpcError.ServerUnreachable, |
| | 0 | 60 | | SocketError.NetworkDown => IceRpcError.ServerUnreachable, |
| | 0 | 61 | | SocketError.HostDown => IceRpcError.ServerUnreachable, |
| | 0 | 62 | | SocketError.TimedOut => IceRpcError.ServerUnreachable, |
| | 43 | 63 | | |
| | 43 | 64 | | // Name resolution failures are also mapped to ServerUnreachable so that the connection cache |
| | 43 | 65 | | // can treat DNS failures and transport reachability failures uniformly and try alternate |
| | 43 | 66 | | // server addresses. |
| | 43 | 67 | | // |
| | 43 | 68 | | // These errors always occur before connection establishment (during name resolution). |
| | 43 | 69 | | // |
| | 43 | 70 | | // Some of these errors (for example HostNotFound) are often permanent configuration issues, |
| | 43 | 71 | | // but IceRPC keeps the public error model small and leaves retry decisions to higher layers. |
| | 0 | 72 | | SocketError.HostNotFound => IceRpcError.ServerUnreachable, |
| | 0 | 73 | | SocketError.TryAgain => IceRpcError.ServerUnreachable, |
| | 0 | 74 | | SocketError.NoRecovery => IceRpcError.ServerUnreachable, |
| | 0 | 75 | | SocketError.NoData => IceRpcError.ServerUnreachable, |
| | 43 | 76 | | |
| | 43 | 77 | | // Operation was aborted locally, typically due to cancellation or socket disposal. |
| | 0 | 78 | | SocketError.OperationAborted => IceRpcError.OperationAborted, |
| | 43 | 79 | | |
| | 0 | 80 | | _ => IceRpcError.IceRpcError |
| | 43 | 81 | | }; |
| | | 82 | | |
| | 43 | 83 | | return new IceRpcException(errorCode, innerException); |
| | 43 | 84 | | } |
| | | 85 | | } |