Mark Windows-specific APIs #138

terrajobst · 2020-07-10T04:20:05Z

No description provided.

accepted/2020/windows-specific-apis/windows-specific-apis.md

stephentoub · 2020-07-10T14:20:51Z

accepted/2020/windows-specific-apis/windows-specific-apis.md

+* **X509Chain**
+    - `.ctor(IntPtr)`
+
+### System.ServiceModel


Someone familiar with WCF will need to comment on this section.

We have zero api's which are Windows specific.

accepted/2020/windows-specific-apis/windows-specific-apis.md

terrajobst · 2020-07-14T16:43:22Z

FYI. I've done a run for .NET 5 and the latest Microsoft.Windows.Compatibility pack. Once I've merged the delta, I'll flip this back to api-ready-for-review.

terrajobst · 2020-07-14T19:51:13Z

@akoeplinger I've rebased out the Excel file 🙂

jeffhandley · 2020-07-14T21:42:19Z

accepted/2020/windows-specific-apis/windows-specific-apis.md

+
+## Open Issues
+
+* We should run the tool again .NET 5


Suggested change

* We should run the tool again .NET 5

* We should run the tool against .NET 5

jeffhandley · 2020-07-14T21:42:19Z

accepted/2020/windows-specific-apis/windows-specific-apis.md

+    - `CreateBindingElements()`
+* **ChannelFactory**
+    - `.ctor(Binding, EndpointAddress)`
+    - `.ctor(ServiceEndpoint)`
+    - `.ctor(String)`
+    - `.ctor(String, EndpointAddress)`
+    - `ApplyConfiguration(String)`
+    - `CreateDescription()`
+    - `InitializeEndpoint(Binding, EndpointAddress)`
+    - `InitializeEndpoint(ServiceEndpoint)`
+    - `InitializeEndpoint(String, EndpointAddress)`
+* **ChannelTerminatedException**
+    - `.ctor(SerializationInfo, StreamingContext)`
+* **ClientBase**
+    - `.ctor()`
+    - `.ctor(String)`
+    - `.ctor(String, EndpointAddress)`
+    - `.ctor(String, String)`
+* **ClientBase+ChannelBase**
+    - `EndInvoke(String, Object[], IAsyncResult)`
+* **ClientCredentialsSecurityTokenManager**
+    - `CreateSecurityTokenAuthenticator(SecurityTokenRequirement, SecurityTokenResolver)`
+    - `CreateSecurityTokenProvider(SecurityTokenRequirement)`
+    - `CreateSecurityTokenSerializer(SecurityTokenVersion)`
+* **CommunicationException**
+    - `.ctor(SerializationInfo, StreamingContext)`
+* **CommunicationObjectAbortedException**
+    - `.ctor(SerializationInfo, StreamingContext)`
+* **CommunicationObjectFaultedException**
+    - `.ctor(SerializationInfo, StreamingContext)`
+* **DuplexChannelFactory**
+    - `.ctor(InstanceContext, Binding, EndpointAddress)`
+    - `.ctor(InstanceContext, Binding, String)`
+    - `.ctor(InstanceContext, String)`
+    - `.ctor(InstanceContext, String, EndpointAddress)`
+* **DuplexClientBase**
+    - `.ctor(InstanceContext)`
+    - `.ctor(InstanceContext, String)`
+    - `.ctor(InstanceContext, String, EndpointAddress)`
+    - `.ctor(InstanceContext, String, String)`
+* **EndpointAddress**
+    - `ApplyTo(Message)`
+* **EndpointIdentity**
+    - `Equals(Object)`
+    - `GetHashCode()`
+* **EndpointNotFoundException**
+    - `.ctor(SerializationInfo, StreamingContext)`
+* **FaultException**
+    - `.ctor(SerializationInfo, StreamingContext)`
+* **InvalidMessageContractException**
+    - `.ctor(SerializationInfo, StreamingContext)`
+* **MessageHeaderException**
+    - `.ctor(SerializationInfo, StreamingContext)`
+* **MessageSecurityOverTcp**
+    - `get_ClientCredentialType()`
+    - `set_ClientCredentialType(MessageCredentialType)`
+* **NetHttpBinding**
+    - `CreateBindingElements()`
+* **NetHttpsBinding**
+    - `.ctor()`
+    - `.ctor(BasicHttpsSecurityMode)`
+    - `CreateBindingElements()`
+* **NetTcpBinding**
+    - `.ctor(String)`
+    - `CreateBindingElements()`
+* **ProtocolException**
+    - `.ctor(SerializationInfo, StreamingContext)`
+* **QuotaExceededException**
+    - `.ctor(SerializationInfo, StreamingContext)`
+* **ServerTooBusyException**
+    - `.ctor(SerializationInfo, StreamingContext)`
+* **ServiceActivationException**
+    - `.ctor(SerializationInfo, StreamingContext)`
+
+### System.ServiceModel.Channels
+
+* **AddressHeader**
+    - `Equals(Object)`
+    - `GetHashCode()`
+* **MessageHeaders**
+    - `set_To(Uri)`
+* **SecurityBindingElement**
+    - `CreateSecureConversationBindingElement(SecurityBindingElement)`
+* **TransportSecurityBindingElement**
+    - `GetProperty<T>(BindingContext)`
+* **WebSocketTransportSettings**
+    - `get_DisablePayloadMasking()`
+    - `set_DisablePayloadMasking(Boolean)`
+
+### System.ServiceModel.Security
+
+* **MessageSecurityException**
+    - `.ctor(SerializationInfo, StreamingContext)`
+* **SecurityAccessDeniedException**
+    - `.ctor(SerializationInfo, StreamingContext)`
+* **SecurityNegotiationException**
+    - `.ctor(SerializationInfo, StreamingContext)`
+* **X509ServiceCertificateAuthentication**
+    - `set_CertificateValidationMode(X509CertificateValidationMode)`
+


Per @mconnew's comment, this suggestion will remove the ServiceModel types.

Suggested change

### System.ServiceModel

* **ActionNotSupportedException**

- `.ctor(SerializationInfo, StreamingContext)`

- `.ctor(String, Exception)`

* **BasicHttpBinding**

- `.ctor()`

- `.ctor(BasicHttpSecurityMode)`

- `CreateBindingElements()`

* **BasicHttpsBinding**

- `.ctor()`

- `.ctor(BasicHttpsSecurityMode)`

- `CreateBindingElements()`

* **ChannelFactory**

- `.ctor(Binding, EndpointAddress)`

- `.ctor(ServiceEndpoint)`

- `.ctor(String)`

- `.ctor(String, EndpointAddress)`

- `ApplyConfiguration(String)`

- `CreateDescription()`

- `InitializeEndpoint(Binding, EndpointAddress)`

- `InitializeEndpoint(ServiceEndpoint)`

- `InitializeEndpoint(String, EndpointAddress)`

* **ChannelTerminatedException**

- `.ctor(SerializationInfo, StreamingContext)`

* **ClientBase**

- `.ctor()`

- `.ctor(String)`

- `.ctor(String, EndpointAddress)`

- `.ctor(String, String)`

* **ClientBase+ChannelBase**

- `EndInvoke(String, Object[], IAsyncResult)`

* **ClientCredentialsSecurityTokenManager**

- `CreateSecurityTokenAuthenticator(SecurityTokenRequirement, SecurityTokenResolver)`

- `CreateSecurityTokenProvider(SecurityTokenRequirement)`

- `CreateSecurityTokenSerializer(SecurityTokenVersion)`

* **CommunicationException**

- `.ctor(SerializationInfo, StreamingContext)`

* **CommunicationObjectAbortedException**

- `.ctor(SerializationInfo, StreamingContext)`

* **CommunicationObjectFaultedException**

- `.ctor(SerializationInfo, StreamingContext)`

* **DuplexChannelFactory**

- `.ctor(InstanceContext, Binding, EndpointAddress)`

- `.ctor(InstanceContext, Binding, String)`

- `.ctor(InstanceContext, String)`

- `.ctor(InstanceContext, String, EndpointAddress)`

* **DuplexClientBase**

- `.ctor(InstanceContext)`

- `.ctor(InstanceContext, String)`

- `.ctor(InstanceContext, String, EndpointAddress)`

- `.ctor(InstanceContext, String, String)`

* **EndpointAddress**

- `ApplyTo(Message)`

* **EndpointIdentity**

- `Equals(Object)`

- `GetHashCode()`

* **EndpointNotFoundException**

- `.ctor(SerializationInfo, StreamingContext)`

* **FaultException**

- `.ctor(SerializationInfo, StreamingContext)`

* **InvalidMessageContractException**

- `.ctor(SerializationInfo, StreamingContext)`

* **MessageHeaderException**

- `.ctor(SerializationInfo, StreamingContext)`

* **MessageSecurityOverTcp**

- `get_ClientCredentialType()`

- `set_ClientCredentialType(MessageCredentialType)`

* **NetHttpBinding**

- `CreateBindingElements()`

* **NetHttpsBinding**

- `.ctor()`

- `.ctor(BasicHttpsSecurityMode)`

- `CreateBindingElements()`

* **NetTcpBinding**

- `.ctor(String)`

- `CreateBindingElements()`

* **ProtocolException**

- `.ctor(SerializationInfo, StreamingContext)`

* **QuotaExceededException**

- `.ctor(SerializationInfo, StreamingContext)`

* **ServerTooBusyException**

- `.ctor(SerializationInfo, StreamingContext)`

* **ServiceActivationException**

- `.ctor(SerializationInfo, StreamingContext)`

### System.ServiceModel.Channels

* **AddressHeader**

- `Equals(Object)`

- `GetHashCode()`

* **MessageHeaders**

- `set_To(Uri)`

* **SecurityBindingElement**

- `CreateSecureConversationBindingElement(SecurityBindingElement)`

* **TransportSecurityBindingElement**

- `GetProperty<T>(BindingContext)`

* **WebSocketTransportSettings**

- `get_DisablePayloadMasking()`

- `set_DisablePayloadMasking(Boolean)`

### System.ServiceModel.Security

* **MessageSecurityException**

- `.ctor(SerializationInfo, StreamingContext)`

* **SecurityAccessDeniedException**

- `.ctor(SerializationInfo, StreamingContext)`

* **SecurityNegotiationException**

- `.ctor(SerializationInfo, StreamingContext)`

* **X509ServiceCertificateAuthentication**

- `set_CertificateValidationMode(X509CertificateValidationMode)`

Do we know what caused them to show up here in the first place?

adamsitnik · 2020-07-15T09:51:09Z

accepted/2020/windows-specific-apis/windows-specific-apis.md

+    - `EnterDebugMode()`
+    - `LeaveDebugMode()`


these two are nops and to be consistent with other nops, we should remove them from the list

context: https://github.com/dotnet/designs/pull/138/files#r454448405

Suggested change

- `EnterDebugMode()`

- `LeaveDebugMode()`

adamsitnik · 2020-07-15T09:55:35Z

accepted/2020/windows-specific-apis/windows-specific-apis.md

+### System.IO.Pipes
+
+* **NamedPipeClientStream**
+    - `Connect(Int32)`


I can't see a code path where Connect(Int32) throws on Unix.

https://github.com/dotnet/runtime/blob/08643df14054d1273002254c909fa099649ebfcf/src/libraries/System.IO.Pipes/src/System/IO/Pipes/NamedPipeClientStream.cs#L130-L173

https://github.com/dotnet/runtime/blob/08643df14054d1273002254c909fa099649ebfcf/src/libraries/System.IO.Pipes/src/System/IO/Pipes/NamedPipeClientStream.Unix.cs#L20-L67

Suggested change

- `Connect(Int32)`

adamsitnik · 2020-07-15T09:56:36Z

accepted/2020/windows-specific-apis/windows-specific-apis.md

+* **NamedPipeServerStream**
+    - `WaitForConnection()`


it's supported on Unix: https://github.com/dotnet/runtime/blob/08643df14054d1273002254c909fa099649ebfcf/src/libraries/System.IO.Pipes/src/System/IO/Pipes/NamedPipeServerStream.Unix.cs#L54-L66

Suggested change

* **NamedPipeServerStream**

- `WaitForConnection()`

adamsitnik · 2020-07-15T10:03:41Z

accepted/2020/windows-specific-apis/windows-specific-apis.md

+* **Socket**
+    - `SetIPProtectionLevel(IPProtectionLevel)`


https://github.com/dotnet/runtime/blob/08643df14054d1273002254c909fa099649ebfcf/src/libraries/System.Net.Sockets/src/System/Net/Sockets/Socket.Unix.cs#L13-L17

Suggested change

* **Socket**

- `SetIPProtectionLevel(IPProtectionLevel)`

* **Socket**

- `.ctor(SocketInformation)`

- `SetIPProtectionLevel(IPProtectionLevel)`

adamsitnik · 2020-07-15T10:43:03Z

accepted/2020/windows-specific-apis/windows-specific-apis.md

+
+* **DriveInfo**
+    - `set_VolumeLabel(String)`
+


https://github.com/dotnet/runtime/blob/1bdcd669e70d687bb0c56fe20aafa7c104b6aa0e/src/libraries/System.IO.FileSystem/src/System/IO/FileSystem.Unix.cs#L50-L58

Suggested change

### System.IO.FileSystem

* **File**

- `Decrypt(string)`

- `Encrypt(string)`

adamsitnik · 2020-07-15T10:52:16Z

FWIW I've done some simple manual search of keyword "PlatformNotSupportedException" in *Unix.cs files and found only 2 things that were not on the list and provided a suggestion that adds them. IMO the list is complete now.

My PR is ready dotnet/runtime#39265

terrajobst · 2020-07-16T17:33:51Z

Video

The proposal looks good.
We should consider a diagnostic to warn on typos in the OS name, e.g. [MinimumOSPlatform("windos7.0")]

terrajobst force-pushed the terrajobst:windows-specific-apis branch from e391b7d to 066cd2b Jul 10, 2020

terrajobst changed the title ~~windows specific apis~~ Mark Windows-specific APIs Jul 10, 2020

yaakov-h reviewed Jul 10, 2020

View changes

accepted/2020/windows-specific-apis/windows-specific-apis.md Outdated Show resolved Hide resolved

terrajobst added api-ready-for-review blocking labels Jul 10, 2020

adamsitnik reviewed Jul 10, 2020

View changes

accepted/2020/windows-specific-apis/windows-specific-apis.md Show resolved Hide resolved

adamsitnik reviewed Jul 10, 2020

View changes

accepted/2020/windows-specific-apis/windows-specific-apis.md Outdated Show resolved Hide resolved

adamsitnik reviewed Jul 10, 2020

View changes

accepted/2020/windows-specific-apis/windows-specific-apis.md Show resolved Hide resolved

adamsitnik reviewed Jul 10, 2020

View changes

accepted/2020/windows-specific-apis/windows-specific-apis.md Show resolved Hide resolved

akoeplinger reviewed Jul 10, 2020

View changes

accepted/2020/windows-specific-apis/windows-specific-apis.md Show resolved Hide resolved

akoeplinger reviewed Jul 10, 2020

View changes

accepted/2020/windows-specific-apis/windows-specific-apis.md Outdated Show resolved Hide resolved

akoeplinger reviewed Jul 10, 2020

View changes

accepted/2020/windows-specific-apis/windows-specific-apis.md Outdated Show resolved Hide resolved

akoeplinger reviewed Jul 10, 2020

View changes

accepted/2020/windows-specific-apis/windows-specific-apis.md Outdated Show resolved Hide resolved

akoeplinger reviewed Jul 10, 2020

View changes

accepted/2020/windows-specific-apis/windows-specific-apis.md Show resolved Hide resolved

stephentoub reviewed Jul 10, 2020

View changes

accepted/2020/windows-specific-apis/windows-specific-apis.md Outdated Show resolved Hide resolved

stephentoub reviewed Jul 10, 2020

View changes

accepted/2020/windows-specific-apis/windows-specific-apis.md Show resolved Hide resolved

stephentoub reviewed Jul 10, 2020

View changes

accepted/2020/windows-specific-apis/windows-specific-apis.md Outdated Show resolved Hide resolved

stephentoub reviewed Jul 10, 2020

View changes

accepted/2020/windows-specific-apis/windows-specific-apis.md Outdated Show resolved Hide resolved

stephentoub reviewed Jul 10, 2020

View changes

accepted/2020/windows-specific-apis/windows-specific-apis.md Outdated Show resolved Hide resolved

stephentoub reviewed Jul 10, 2020

View changes

accepted/2020/windows-specific-apis/windows-specific-apis.md Outdated Show resolved Hide resolved

stephentoub reviewed Jul 10, 2020

View changes

accepted/2020/windows-specific-apis/windows-specific-apis.md Outdated Show resolved Hide resolved

stephentoub reviewed Jul 10, 2020

View changes

accepted/2020/windows-specific-apis/windows-specific-apis.md Outdated Show resolved Hide resolved

stephentoub reviewed Jul 10, 2020

View changes

accepted/2020/windows-specific-apis/windows-specific-apis.md Outdated Show resolved Hide resolved

stephentoub reviewed Jul 10, 2020

View changes

accepted/2020/windows-specific-apis/windows-specific-apis.md Outdated Show resolved Hide resolved

stephentoub reviewed Jul 10, 2020

View changes

accepted/2020/windows-specific-apis/windows-specific-apis.md Show resolved Hide resolved

stephentoub reviewed Jul 10, 2020

View changes

accepted/2020/windows-specific-apis/windows-specific-apis.md Outdated Show resolved Hide resolved

stephentoub reviewed Jul 10, 2020

View changes

accepted/2020/windows-specific-apis/windows-specific-apis.md Outdated Show resolved Hide resolved

stephentoub reviewed Jul 10, 2020

View changes

accepted/2020/windows-specific-apis/windows-specific-apis.md Outdated Show resolved Hide resolved

stephentoub reviewed Jul 10, 2020

View changes

accepted/2020/windows-specific-apis/windows-specific-apis.md Outdated Show resolved Hide resolved

adamsitnik reviewed Jul 14, 2020

View changes

accepted/2020/windows-specific-apis/windows-specific-apis.md Outdated Show resolved Hide resolved

adamsitnik reviewed Jul 14, 2020

View changes

accepted/2020/windows-specific-apis/windows-specific-apis.md Show resolved Hide resolved

adamsitnik reviewed Jul 14, 2020

View changes

accepted/2020/windows-specific-apis/windows-specific-apis.md Show resolved Hide resolved

terrajobst and others added 7 commits Jul 10, 2020

Add proposal to mark Windows-specific APIs

6c431f4

address review feedback for windows-specific APIs

34bb95e

Add Windows-only MemoryMappedFile.CreateOrOpen back into the list

8374f5f

Add additional notes from review

b0754a9

Add note about partially supported APIs

95239be

Add APIs based on Adam's feedback

fd6aba8

Add missing APIs from .NET 5 Preview 6

Loading status checks…

242ba7b

terrajobst force-pushed the terrajobst:windows-specific-apis branch from 3909780 to 242ba7b Jul 14, 2020

terrajobst added api-ready-for-review blocking and removed api-needs-work labels Jul 14, 2020

jeffhandley reviewed Jul 14, 2020

View changes

adamsitnik reviewed Jul 15, 2020

View changes

terrajobst added api-approved and removed api-ready-for-review blocking labels Jul 16, 2020

jeffhandley merged commit a3b498f into dotnet:master Jul 16, 2020
1 check passed

1 check passed

license/cla All CLA requirements met.
Details

terrajobst deleted the terrajobst:windows-specific-apis branch Sep 28, 2020

Sep	OCT	Nov
	19
2019	2020	2021

dotnet / designs

Mark Windows-specific APIs #138

Mark Windows-specific APIs #138

terrajobst commented Jul 10, 2020 •

edited

This comment has been minimized.

This comment has been minimized.

terrajobst commented Jul 14, 2020

terrajobst commented Jul 14, 2020

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

adamsitnik commented Jul 15, 2020

terrajobst commented Jul 16, 2020 •

edited by dotnet-api-review bot

	* We should run the tool again .NET 5
	* We should run the tool against .NET 5

+### System.IO.FileSystem
+* **File**
+    - `Decrypt(string)`
+    - `Encrypt(string)`

dotnet / designs

Join GitHub today

Mark Windows-specific APIs #138

Mark Windows-specific APIs #138

Conversation

terrajobst commented Jul 10, 2020 • edited

This comment has been minimized.

stephentoub Jul 10, 2020 Member

This comment has been minimized.

mconnew Jul 14, 2020 Member

terrajobst commented Jul 14, 2020

terrajobst commented Jul 14, 2020

This comment has been minimized.

jeffhandley Jul 14, 2020 Contributor

This comment has been minimized.

jeffhandley Jul 14, 2020 Contributor

This comment has been minimized.

stephentoub Jul 14, 2020 Member

This comment has been minimized.

adamsitnik Jul 15, 2020 Member

This comment has been minimized.

adamsitnik Jul 15, 2020 Member

This comment has been minimized.

adamsitnik Jul 15, 2020 Member

This comment has been minimized.

adamsitnik Jul 15, 2020 Member

This comment has been minimized.

adamsitnik Jul 15, 2020 Member

adamsitnik commented Jul 15, 2020

terrajobst commented Jul 16, 2020 • edited by dotnet-api-review bot

Essential cookies

Always active

Analytics cookies

terrajobst commented Jul 10, 2020 •

edited

stephentoub Jul 10, 2020
Member

mconnew Jul 14, 2020
Member

jeffhandley Jul 14, 2020
Contributor

jeffhandley Jul 14, 2020
Contributor

stephentoub Jul 14, 2020
Member

adamsitnik Jul 15, 2020
Member

adamsitnik Jul 15, 2020
Member

adamsitnik Jul 15, 2020
Member

adamsitnik Jul 15, 2020
Member

adamsitnik Jul 15, 2020
Member

terrajobst commented Jul 16, 2020 •

edited by dotnet-api-review bot