Obsolete Socket.UseOnlyOverlappedIO

Background and Motivation

This property it is only meaningful on .NET Framework where it functions as a socket-level switch between IOCP and Win32 event based overlapped IO.

.NET (Core) Windows sockets are entirely IOCP-based, and the concept of "overlapped IO" does not exist on other platforms, therefore the property contains empty logic, and there is no chance we will ever implement it. To avoid confusion, I suggest to obsolete and hide it it together with the related flag in SocketInformationOptions.

Proposed API

public class Socket
{
+   [Obsolete]
+   [EditorBrowsable(EditorBrowsableState.Never)]
    public bool UseOnlyOverlappedIO { get; set; }
}

public enum SocketInformationOptions
{
    NonBlocking = 1,
    Connected = 2,
    Listening = 4,
+   [Obsolete]
+   [EditorBrowsable(EditorBrowsableState.Never)]
    UseOnlyOverlappedIO = 8,
}

Risks

Breaking /warnaserror builds when porting to .NET 6. (Which may actually prevent runtime failures.)

Is it also worth marking it as non browsable?

Is it also worth marking it as non browsable?

In my opinion - yes, so updated the proposal.

Triage: We agree, it is no-op on .NET Core, let's obsolete it.

Video

Looks good
It feels over-engineered to add a diagnostic ID to this obsoletion

namespace System.Net.Sockets
{
    public partial class Socket
    {
        [Obsolete]
        [EditorBrowsable(EditorBrowsableState.Never)]
        public bool UseOnlyOverlappedIO { get; set; }
    }
    public partial enum SocketInformationOptions
    {
        [Obsolete]
        [EditorBrowsable(EditorBrowsableState.Never)]
        UseOnlyOverlappedIO = 8,
    }
}

Obsolete Socket.UseOnlyOverlappedIO (#52475)

Navigation Menu

Repository navigation

Obsolete Socket.UseOnlyOverlappedIO #47163

Background and Motivation

Proposed API

Risks

Metadata

Assignees

Labels

Type

Projects

Milestone

Relationships

Development

Obsolete Socket.UseOnlyOverlappedIO #47163

Description

Background and Motivation

Proposed API

Risks

Activity

Wraith2 commented on Jan 19, 2021

antonfirsov commented on Jan 19, 2021

karelz commented on Feb 4, 2021

terrajobst commented on Feb 4, 2021

Metadata

Metadata

Assignees

Labels

Type

Projects

Milestone

Relationships

Development

Issue actions