Use TimeSpan everywhere we use an int for seconds, milliseconds, and timeouts #14336
Description
In a large software project, it's easy to mess up units for time. IE, is that Int32 seconds or milliseconds? Or maybe minutes? I've been fixing my team's source code to use the unit-agnostic TimeSpan class wherever possible. However the .NET Framework is not complete in its adoption of TimeSpan. Specifically, we don't have a Process.WaitForExit overload that takes a TimeSpan, only an Int32 for the timeout.
I suggest someone look through all .NET Framework API's for Int32 parameters containing "second", "millisecond", "ms", "timeout" (and perhaps "time") and see if there is a parallel TimeSpan-based overload. If not, please fix that.
API Proposal
(Proposed by @reflectronic)
namespace System {
public static class GC {
+ public static GCNotificationStatus WaitForFullGCApproach(TimeSpan timeout);
+ public static GCNotificationStatus WaitForFullGCComplete(TimeSpan timeout);
}
}
namespace System.ComponentModel.DataAnnotations {
public class RegularExpressionAttribute {
! This one might not end up being that useful, since people generally don't ever manipulate an instance of this attribute.
+ public TimeSpan MatchTimeout { get; }
}
}
namespace System.Diagnostics {
public class Process {
+ public bool WaitForExit(TimeSpan timeout);
+ public bool WaitForInputIdle(TimeSpan timeout);
}
}
namespace System.IO {
public class FileSystemWatcher {
+ public WaitForChangedResult WaitForChanged(WatcherChangeTypes changeType, TimeSpan timeout);
}
public sealed class NamedPipeClientStream : PipeStream {
+ public void Connect(TimeSpan timeout);
+ public Task ConnectAsync(TimeSpan timeout, CancellationToken cancellationToken = default);
}
}
namespace System.Net.NetworkInformation {
public class Ping {
+ public PingReply Send(IPAddress address, TimeSpan timeout, byte[]? buffer = null, PingOptions? options = null);
+ public PingReply Send(string hostNameOrAddress, TimeSpan timeout, byte[]? buffer = null, PingOptions? options = null);
! Skipped EAP based methods; if they are desired, they can be added back in
! I added CancellationToken because it is probably worth it. If you don't want it you can remove it.
+ public Task<PingReply> SendPingAsync(IPAddress address, TimeSpan timeout, byte[]? buffer = null, PingOptions? options = null, CancellationToken cancellationToken = default);
+ public Task<PingReply> SendPingAsync(string hostNameOrAddress, TimeSpan timeout, byte[]? buffer = null, PingOptions? options = null, CancellationToken cancellationToken = default);
}
}
namespace System.Net.Sockets {
public class NetworkStream : Stream {
+ public void Close(TimeSpan timeout);
}
public class Socket {
+ public bool Poll(TimeSpan timeout, SelectMode mode);
+ public static void Select(IList checkRead, IList checkWrite, IList checkError, TimeSpan timeout);
}
}
namespace System.ServiceProcess {
public class ServiceBase {
+ public void RequestAdditionalTime(TimeSpan time);
}
}
namespace System.Threading.Tasks {
public class Task {
+ public bool Wait(TimeSpan timeout, CancellationToken cancellationToken);
}
}
namespace System.Timers {
public class Timer {
+ public Timer(TimeSpan interval);
}
}APIs that I don't know how to make better:
namespace System.IO {
public abstract class Stream {
+ public TimeSpan ReadTimeoutTimeSpan { get; set; }
+ public TimeSpan WriteTimeoutTimeSpan { get; set; }
}
}
namespace System.IO.Ports {
public class SerialPort {
+ public TimeSpan ReadTimeoutTimeSpan { get; set; }
+ public TimeSpan WriteTimeoutTimeSpan { get; set; }
}
}
namespace System.Media {
public class SoundPlayer {
+ public TimeSpan LoadTimeoutTimeSpan { get; set; }
}
}
namespace System.Net.NetworkInformation {
+ public static class NetworkInformationTimeSpanExtensions {
+ public static TimeSpan GetPacketReassemblyTimeout(this IPGlobalStatistics statistics);
+ public static TimeSpan GetMaximumTransmissionTimeout(this TcpStatistics statistics);
+ public static TimeSpan GetMinimumTransmissionTimeout(this TcpStatistics statistics);
+ }
}
namespace System.Net.Sockets {
public class Socket {
+ public TimeSpan ReceiveTimeoutTimeSpan { get; set; }
+ public TimeSpan ReceiveTimeoutTimeSpan { get; set; }
}
public class TcpClient {
+ public TimeSpan ReceiveTimeoutTimeSpan { get; set; }
+ public TimeSpan SendTimeoutTimeSpan { get; set; }
}
}
namespace System.Timers {
public class Timer {
+ public TimeSpan IntervalTimeSpan { get; set; }
}
}APIs which use seconds:
These suffer from the same problem as the previous group, but also only deal with seconds, meaning that most TimeSpan values would need to be rounded out.
namespace System.Data {
! This would need to be a DIM.
public interface IDbCommand {
+ TimeSpan CommandTimeoutTimeSpan { get; set; }
}
+ public static class DataTimeSpanExtensions {
+ public static TimeSpan GetConnectionTimeout(this IDbConnection connection);
+ }
}
namespace System.Data.Sql {
public sealed class SqlNotificationRequest {
+ public TimeSpan TimeoutTimeSpan { get; set; }
}
}
namespace System.Data.SqlClient {
public sealed class SqlBulkCopy {
+ public TimeSpan BulkCopyTimeoutTimeSpan { get; set; }
}
public sealed class SqlConnectionStringBuilder {
+ public TimeSpan ConnectTimeoutTimeSpan { get; set; }
+ public TimeSpan LoadBalanceTimeoutTimeSpan { get; set; }
}
public sealed class SqlDependency {
+ public SqlDependency(SqlCommand command, string options, TimeSpan timeout);
}
}
namespace System.Net.Sockets {
public class LingerOption {
+ public LingerOption(bool enable, TimeSpan time);
+ public TimeSpan LingerTimeSpan { get; set; }
}
public class Socket {
+ public void Close(TimeSpan timeout);
}
}