move SocketTaskExtensions methods to Socket class - #45083

Merged
geoffkizer merged 4 commits into
dotnet:masterfrom
geoffkizer:movesockettaskextensions
Dec 30, 2020
Merged

move SocketTaskExtensions methods to Socket class#45083
geoffkizer merged 4 commits into
dotnet:masterfrom
geoffkizer:movesockettaskextensions

Conversation

@geoffkizer

@geoffkizergeoffkizer commented Nov 22, 2020

Copy link
Copy Markdown
Contributor

@geoffkizergeoffkizer added this to the 6.0.0 milestone Nov 22, 2020
@ghost

ghost commented Nov 22, 2020

Copy link
Copy Markdown

Tagging subscribers to this area: @dotnet/ncl
See info in area-owners.md if you want to be subscribed.

Issue Details

Fixes #43901

@antonfirsov@stephentoub @dotnet/ncl

Author:geoffkizer
Assignees:-
Labels:

area-System.Net.Sockets

Milestone:6.0.0

@Dotnet-GitSync-Bot

Dotnet-GitSync-Bot commented Nov 22, 2020

Copy link
Copy Markdown
Collaborator

Note regarding the new-api-needs-documentation label:

This serves as a reminder for when your PR is modifying a ref *.cs file and adding/modifying public APIs, to please make sure the API implementation in the src *.cs file is documented with triple slash comments, so the PR reviewers can sign off that change.

@geoffkizer

geoffkizer commented Nov 22, 2020

Copy link
Copy Markdown
ContributorAuthor

/azp run runtime-libraries-coreclr outerloop

@azure-pipelines

azure-pipelinesBot commented Nov 22, 2020

Copy link
Copy Markdown
Azure Pipelines successfully started running 1 pipeline(s).

antonfirsov
antonfirsov reviewed Nov 23, 2020
View reviewed changes
Comment threadsrc/libraries/System.Net.Sockets/ref/System.Net.Sockets.cs Outdated
Comment on lines +402 to +420
public System.Threading.Tasks.Task<System.Net.Sockets.Socket> AcceptAsync() { throw null; }
public System.Threading.Tasks.Task<System.Net.Sockets.Socket> AcceptAsync(System.Net.Sockets.Socket? acceptSocket) { throw null; }
public System.Threading.Tasks.Task ConnectAsync(System.Net.EndPoint remoteEP) { throw null; }
public System.Threading.Tasks.ValueTask ConnectAsync(System.Net.EndPoint remoteEP, System.Threading.CancellationToken cancellationToken) { throw null; }
public System.Threading.Tasks.Task ConnectAsync(System.Net.IPAddress address, int port) { throw null; }
public System.Threading.Tasks.ValueTask ConnectAsync(System.Net.IPAddress address, int port, System.Threading.CancellationToken cancellationToken) { throw null; }
public System.Threading.Tasks.Task ConnectAsync(System.Net.IPAddress[] addresses, int port) { throw null; }
public System.Threading.Tasks.ValueTask ConnectAsync(System.Net.IPAddress[] addresses, int port, System.Threading.CancellationToken cancellationToken) { throw null; }
public System.Threading.Tasks.Task ConnectAsync(string host, int port) { throw null; }
public System.Threading.Tasks.ValueTask ConnectAsync(string host, int port, System.Threading.CancellationToken cancellationToken) { throw null; }
public System.Threading.Tasks.Task<int> ReceiveAsync(System.ArraySegment<byte> buffer, System.Net.Sockets.SocketFlags socketFlags) { throw null; }
public System.Threading.Tasks.Task<int> ReceiveAsync(System.Collections.Generic.IList<System.ArraySegment<byte>> buffers, System.Net.Sockets.SocketFlags socketFlags) { throw null; }
public System.Threading.Tasks.ValueTask<int> ReceiveAsync(System.Memory<byte> buffer, System.Net.Sockets.SocketFlags socketFlags, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) { throw null; }
public System.Threading.Tasks.Task<System.Net.Sockets.SocketReceiveFromResult> ReceiveFromAsync(System.ArraySegment<byte> buffer, System.Net.Sockets.SocketFlags socketFlags, System.Net.EndPoint remoteEndPoint) { throw null; }
public System.Threading.Tasks.Task<System.Net.Sockets.SocketReceiveMessageFromResult> ReceiveMessageFromAsync(System.ArraySegment<byte> buffer, System.Net.Sockets.SocketFlags socketFlags, System.Net.EndPoint remoteEndPoint) { throw null; }
public System.Threading.Tasks.Task<int> SendAsync(System.ArraySegment<byte> buffer, System.Net.Sockets.SocketFlags socketFlags) { throw null; }
public System.Threading.Tasks.Task<int> SendAsync(System.Collections.Generic.IList<System.ArraySegment<byte>> buffers, System.Net.Sockets.SocketFlags socketFlags) { throw null; }
public System.Threading.Tasks.ValueTask<int> SendAsync(System.ReadOnlyMemory<byte> buffer, System.Net.Sockets.SocketFlags socketFlags, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) { throw null; }
public System.Threading.Tasks.Task<int> SendToAsync(System.ArraySegment<byte> buffer, System.Net.Sockets.SocketFlags socketFlags, System.Net.EndPoint remoteEP) { throw null; }

@antonfirsovantonfirsovNov 23, 2020

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I suppose the additions were manual. Shouldn't we at least do to the alphabetical ordering to reduce the number of conflicts in later PR-s with consolidation?

@geoffkizergeoffkizerNov 24, 2020

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sure, will do.

@runfoapprunfoappBot mentioned this pull request Nov 23, 2020
Closed
@antonfirsov

antonfirsov commented Nov 23, 2020

Copy link
Copy Markdown
Contributor

Coming from #44889 (comment) ... shouldn't we also add xmldocs in this PR?

@stephentoub

stephentoub commented Nov 23, 2020

Copy link
Copy Markdown
Member

shouldn't we also add xmldocs in this PR?

Yup

@geoffkizer

geoffkizer commented Nov 24, 2020

Copy link
Copy Markdown
ContributorAuthor

I suspect we already have docs for the extension methods, and we should just use them here.

@carlossanlop Do you know? What should be done in this PR to preserve existing docs, just move them to these instance methods?

@geoffkizer

geoffkizer commented Nov 24, 2020

Copy link
Copy Markdown
ContributorAuthor

/azp run runtime-libraries-coreclr outerloop

@azure-pipelines

azure-pipelinesBot commented Nov 24, 2020

Copy link
Copy Markdown
Azure Pipelines successfully started running 1 pipeline(s).

@carlossanlop

carlossanlop commented Nov 30, 2020

Copy link
Copy Markdown
Contributor

@geoffkizer@antonfirsov If documentation was already added somewhere else for the APIs that were made public in this PR, you can copy the triple slash comments on top of these newly public APIs.

@geoffkizer

geoffkizer commented Nov 30, 2020

Copy link
Copy Markdown
ContributorAuthor

@carlossanlop There are no triple-slash comments for the existing APIs.

@carlossanlop

carlossanlop commented Nov 30, 2020

Copy link
Copy Markdown
Contributor

@geoffkizer Ah, got it. Then please add new triple slash comments.

@geoffkizer

geoffkizer commented Dec 15, 2020

Copy link
Copy Markdown
ContributorAuthor

/azp run runtime-libraries-coreclr outerloop

@azure-pipelines

azure-pipelinesBot commented Dec 15, 2020

Copy link
Copy Markdown
Azure Pipelines successfully started running 1 pipeline(s).

@geoffkizer

geoffkizer commented Dec 15, 2020

Copy link
Copy Markdown
ContributorAuthor

Doc comments added.

@dotnet/ncl Can someone review?

@runfoapprunfoappBot mentioned this pull request Dec 15, 2020
Closed
antonfirsov
antonfirsov reviewed Dec 16, 2020
View reviewed changes

@antonfirsovantonfirsov left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If documentation text will be auto-generated, we should probably copy it from SocketTaskExtensions for consistency:
https://docs.microsoft.com/en-us/dotnet/api/system.net.sockets.sockettaskextensions.acceptasync?view=net-5.0#System_Net_Sockets_SocketTaskExtensions_AcceptAsync_System_Net_Sockets_Socket_

https://github.com/dotnet/dotnet-api-docs/blob/master/xml/System.Net.Sockets/SocketTaskExtensions.xml

Otherwise LGTM.

Comment threadsrc/libraries/System.Net.Sockets/src/System/Net/Sockets/Socket.Tasks.cs

internal Task<Socket> AcceptAsync(Socket? acceptSocket)
/// <summary>
/// Accepts an incoming connection.

@antonfirsovantonfirsovDec 16, 2020•
edited by stephentoub
Loading

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
/// Accepts an incoming connection.
/// Performs an asynchronous operation to accept an incoming connection attempt on the socket.

Comment threadsrc/libraries/System.Net.Sockets/src/System/Net/Sockets/Socket.Tasks.cs
/// <summary>
/// Accepts an incoming connection.
/// </summary>
/// <returns>An asynchronous task that completes with the accepted Socket.</returns>

@antonfirsovantonfirsovDec 16, 2020

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
/// <returns>An asynchronous task that completes with the accepted Socket.</returns>
/// <returns>An asynchronous task that completes with a <see cref="T:System.Net.Sockets.Socket" /> to handle communication with the remote host.

Comment threadsrc/libraries/System.Net.Sockets/src/System/Net/Sockets/Socket.Tasks.cs
public Task<Socket> AcceptAsync() => AcceptAsync((Socket?)null);

/// <summary>
/// Accepts an incoming connection.

@antonfirsovantonfirsovDec 16, 2020

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
/// Accepts an incoming connection.
/// Performs an asynchronous operation on to accept an incoming connection attempt on the socket.

Comment threadsrc/libraries/System.Net.Sockets/src/System/Net/Sockets/Socket.Tasks.cs
/// <summary>
/// Accepts an incoming connection.
/// </summary>
/// <param name="acceptSocket">The socket to use for accepting the connection.</param>

@antonfirsovantonfirsovDec 16, 2020

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
/// <param name="acceptSocket">The socket to use for accepting the connection.</param>
/// <param name="acceptSocket">The accepted Socket object. This value may be `null`.</param>

Comment threadsrc/libraries/System.Net.Sockets/src/System/Net/Sockets/Socket.Tasks.cs
public Task ConnectAsync(IPAddress[] addresses, int port) => ConnectAsync(addresses, port, CancellationToken.None).AsTask();

/// <summary>
/// Establishes a connection to a remote host.

@antonfirsovantonfirsovDec 16, 2020

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Same for the rest ..

@geoffkizer

geoffkizer commented Dec 17, 2020

Copy link
Copy Markdown
ContributorAuthor

If documentation text will be auto-generated, we should probably copy it from SocketTaskExtensions for consistency:

I used that as a starting point for what I added and tried to improve/clarify parts.

@geoffkizer
geoffkizer merged commit 9bb4bfe into dotnet:masterDec 30, 2020
@antonfirsovantonfirsov mentioned this pull request Jan 13, 2021
Merged
@ghostghost locked as resolved and limited conversation to collaborators Jan 29, 2021
Sign up for freeto subscribe to this conversation on GitHub. Already have an account? Sign in.

Reviewers

@stephentoubstephentoubstephentoub approved these changes
+1 more reviewer
@antonfirsovantonfirsovantonfirsov approved these changes
Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

area-System.Net.Socketsnew-api-needs-documentation

Projects

None yet

Milestone

6.0.0

Development

Successfully merging this pull request may close these issues.

Move SocketTaskExtensions methods to Socket class itself

5 participants

@geoffkizer@Dotnet-GitSync-Bot@antonfirsov@stephentoub@carlossanlop
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Add copy buttons to all 
 blocks\n(function() {\n function addCopyButtons() {\n document.querySelectorAll('pre code').forEach(function(codeBlock) {\n if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;\n codeBlock.parentElement.setAttribute('data-copy-added', 'true');\n \n var btn = document.createElement('button');\n btn.textContent = 'Copy';\n btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';\n btn.onmouseover = function() { this.style.opacity = '1'; };\n btn.onmouseout = function() { this.style.opacity = '0.7'; };\n btn.onclick = function() {\n navigator.clipboard.writeText(codeBlock.textContent).then(function() {\n btn.textContent = 'Copied!';\n setTimeout(function() { btn.textContent = 'Copy'; }, 1500);\n });\n };\n codeBlock.parentElement.style.position = 'relative';\n codeBlock.parentElement.appendChild(btn);\n });\n }\n \n addCopyButtons();\n \n // Re-run on dynamic content\n var observer = new MutationObserver(addCopyButtons);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Add Copy Buttons to Code Blocks");
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '

Skip to content
move SocketTaskExtensions methods to Socket class - #45083
Merged
geoffkizer merged 4 commits into
dotnet:masterfrom 
geoffkizer:movesockettaskextensions
Dec 30, 2020
Merged
move SocketTaskExtensions methods to Socket class#45083
geoffkizer merged 4 commits into
dotnet:masterfrom 
geoffkizer:movesockettaskextensions
Conversation
@geoffkizer
@geoffkizergeoffkizer
commented
Nov 22, 2020

Copy link


Copy Markdown

Contributor
@geoffkizergeoffkizer
added this to the 6.0.0 milestone
Nov 22, 2020
@ghost
ghost
commented
Nov 22, 2020

Copy link


Copy Markdown

Tagging subscribers to this area: @dotnet/ncl

See info in area-owners.md if you want to be subscribed.
Issue Details
Fixes #43901
@antonfirsov@stephentoub @dotnet/ncl
Author:geoffkizer
Assignees:-
Labels:
area-System.Net.Sockets
Milestone:6.0.0
@Dotnet-GitSync-Bot
Dotnet-GitSync-Bot
commented
Nov 22, 2020

Copy link


Copy Markdown

Collaborator
Note regarding the new-api-needs-documentation label:
This serves as a reminder for when your PR is modifying a ref *.cs file and adding/modifying public APIs, to please make sure the API implementation in the src *.cs file is documented with triple slash comments, so the PR reviewers can sign off that change.
@geoffkizer
geoffkizer
commented
Nov 22, 2020

Copy link


Copy Markdown

ContributorAuthor
/azp run runtime-libraries-coreclr outerloop
@azure-pipelines
azure-pipelinesBot
commented
Nov 22, 2020

Copy link


Copy Markdown


Azure Pipelines successfully started running 1 pipeline(s).
antonfirsov
antonfirsov
reviewed
Nov 23, 2020
View reviewed changes
Comment threadsrc/libraries/System.Net.Sockets/ref/System.Net.Sockets.cs
Outdated


Comment on lines

+402
 to 
+420

 public System.Threading.Tasks.Task<System.Net.Sockets.Socket> AcceptAsync() { throw null; }
 public System.Threading.Tasks.Task<System.Net.Sockets.Socket> AcceptAsync(System.Net.Sockets.Socket? acceptSocket) { throw null; }
 public System.Threading.Tasks.Task ConnectAsync(System.Net.EndPoint remoteEP) { throw null; }
 public System.Threading.Tasks.ValueTask ConnectAsync(System.Net.EndPoint remoteEP, System.Threading.CancellationToken cancellationToken) { throw null; }
 public System.Threading.Tasks.Task ConnectAsync(System.Net.IPAddress address, int port) { throw null; }
 public System.Threading.Tasks.ValueTask ConnectAsync(System.Net.IPAddress address, int port, System.Threading.CancellationToken cancellationToken) { throw null; }
 public System.Threading.Tasks.Task ConnectAsync(System.Net.IPAddress[] addresses, int port) { throw null; }
 public System.Threading.Tasks.ValueTask ConnectAsync(System.Net.IPAddress[] addresses, int port, System.Threading.CancellationToken cancellationToken) { throw null; }
 public System.Threading.Tasks.Task ConnectAsync(string host, int port) { throw null; }
 public System.Threading.Tasks.ValueTask ConnectAsync(string host, int port, System.Threading.CancellationToken cancellationToken) { throw null; }
 public System.Threading.Tasks.Task<int> ReceiveAsync(System.ArraySegment<byte> buffer, System.Net.Sockets.SocketFlags socketFlags) { throw null; }
 public System.Threading.Tasks.Task<int> ReceiveAsync(System.Collections.Generic.IList<System.ArraySegment<byte>> buffers, System.Net.Sockets.SocketFlags socketFlags) { throw null; }
 public System.Threading.Tasks.ValueTask<int> ReceiveAsync(System.Memory<byte> buffer, System.Net.Sockets.SocketFlags socketFlags, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) { throw null; }
 public System.Threading.Tasks.Task<System.Net.Sockets.SocketReceiveFromResult> ReceiveFromAsync(System.ArraySegment<byte> buffer, System.Net.Sockets.SocketFlags socketFlags, System.Net.EndPoint remoteEndPoint) { throw null; }
 public System.Threading.Tasks.Task<System.Net.Sockets.SocketReceiveMessageFromResult> ReceiveMessageFromAsync(System.ArraySegment<byte> buffer, System.Net.Sockets.SocketFlags socketFlags, System.Net.EndPoint remoteEndPoint) { throw null; }
 public System.Threading.Tasks.Task<int> SendAsync(System.ArraySegment<byte> buffer, System.Net.Sockets.SocketFlags socketFlags) { throw null; }
 public System.Threading.Tasks.Task<int> SendAsync(System.Collections.Generic.IList<System.ArraySegment<byte>> buffers, System.Net.Sockets.SocketFlags socketFlags) { throw null; }
 public System.Threading.Tasks.ValueTask<int> SendAsync(System.ReadOnlyMemory<byte> buffer, System.Net.Sockets.SocketFlags socketFlags, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) { throw null; }
 public System.Threading.Tasks.Task<int> SendToAsync(System.ArraySegment<byte> buffer, System.Net.Sockets.SocketFlags socketFlags, System.Net.EndPoint remoteEP) { throw null; }
@antonfirsovantonfirsovNov 23, 2020

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I suppose the additions were manual. Shouldn't we at least do to the alphabetical ordering to reduce the number of conflicts in later PR-s with consolidation?
@geoffkizergeoffkizerNov 24, 2020

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sure, will do.
@runfoapprunfoappBot
mentioned this pull request
Nov 23, 2020

Closed

@antonfirsov
antonfirsov
commented
Nov 23, 2020

Copy link


Copy Markdown

Contributor
Coming from #44889 (comment) ... shouldn't we also add xmldocs in this PR?
@stephentoub
stephentoub
commented
Nov 23, 2020

Copy link


Copy Markdown

Member
shouldn't we also add xmldocs in this PR?
Yup
@geoffkizer
geoffkizer
commented
Nov 24, 2020

Copy link


Copy Markdown

ContributorAuthor
I suspect we already have docs for the extension methods, and we should just use them here.
@carlossanlop Do you know? What should be done in this PR to preserve existing docs, just move them to these instance methods?
@geoffkizer
geoffkizer
commented
Nov 24, 2020

Copy link


Copy Markdown

ContributorAuthor
/azp run runtime-libraries-coreclr outerloop
@azure-pipelines
azure-pipelinesBot
commented
Nov 24, 2020

Copy link


Copy Markdown


Azure Pipelines successfully started running 1 pipeline(s).
@carlossanlop
carlossanlop
commented
Nov 30, 2020

Copy link


Copy Markdown

Contributor
@geoffkizer@antonfirsov If documentation was already added somewhere else for the APIs that were made public in this PR, you can copy the triple slash comments on top of these newly public APIs.
@geoffkizer
geoffkizer
commented
Nov 30, 2020

Copy link


Copy Markdown

ContributorAuthor
@carlossanlop There are no triple-slash comments for the existing APIs.
@carlossanlop
carlossanlop
commented
Nov 30, 2020

Copy link


Copy Markdown

Contributor
@geoffkizer Ah, got it. Then please add new triple slash comments.
@geoffkizer
geoffkizer
commented
Dec 15, 2020

Copy link


Copy Markdown

ContributorAuthor
/azp run runtime-libraries-coreclr outerloop
@azure-pipelines
azure-pipelinesBot
commented
Dec 15, 2020

Copy link


Copy Markdown


Azure Pipelines successfully started running 1 pipeline(s).
@geoffkizer
geoffkizer
commented
Dec 15, 2020

Copy link


Copy Markdown

ContributorAuthor
Doc comments added.
@dotnet/ncl Can someone review?
@runfoapprunfoappBot
mentioned this pull request
Dec 15, 2020

Closed

antonfirsov
antonfirsov
reviewed
Dec 16, 2020
View reviewed changes
@antonfirsovantonfirsov
left a comment


Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If documentation text will be auto-generated, we should probably copy it from SocketTaskExtensions for consistency:
https://docs.microsoft.com/en-us/dotnet/api/system.net.sockets.sockettaskextensions.acceptasync?view=net-5.0#System_Net_Sockets_SocketTaskExtensions_AcceptAsync_System_Net_Sockets_Socket_
https://github.com/dotnet/dotnet-api-docs/blob/master/xml/System.Net.Sockets/SocketTaskExtensions.xml
Otherwise LGTM.
Comment threadsrc/libraries/System.Net.Sockets/src/System/Net/Sockets/Socket.Tasks.cs

 internal Task<Socket> AcceptAsync(Socket? acceptSocket)
 /// <summary>
 /// Accepts an incoming connection.
@antonfirsovantonfirsovDec 16, 2020•

edited by stephentoub

Loading

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.


Suggested change

/// Accepts an incoming connection.
/// Performs an asynchronous operation to accept an incoming connection attempt on the socket.
Comment threadsrc/libraries/System.Net.Sockets/src/System/Net/Sockets/Socket.Tasks.cs
 /// <summary>
 /// Accepts an incoming connection.
 /// </summary>
 /// <returns>An asynchronous task that completes with the accepted Socket.</returns>
@antonfirsovantonfirsovDec 16, 2020

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.


Suggested change

/// <returns>An asynchronous task that completes with the accepted Socket.</returns>
/// <returns>An asynchronous task that completes with a <see cref="T:System.Net.Sockets.Socket" /> to handle communication with the remote host.
Comment threadsrc/libraries/System.Net.Sockets/src/System/Net/Sockets/Socket.Tasks.cs
 public Task<Socket> AcceptAsync() => AcceptAsync((Socket?)null);

 /// <summary>
 /// Accepts an incoming connection.
@antonfirsovantonfirsovDec 16, 2020

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.


Suggested change

/// Accepts an incoming connection.
/// Performs an asynchronous operation on to accept an incoming connection attempt on the socket.
Comment threadsrc/libraries/System.Net.Sockets/src/System/Net/Sockets/Socket.Tasks.cs
 /// <summary>
 /// Accepts an incoming connection.
 /// </summary>
 /// <param name="acceptSocket">The socket to use for accepting the connection.</param>
@antonfirsovantonfirsovDec 16, 2020

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.


Suggested change

/// <param name="acceptSocket">The socket to use for accepting the connection.</param>
/// <param name="acceptSocket">The accepted Socket object. This value may be `null`.</param>
Comment threadsrc/libraries/System.Net.Sockets/src/System/Net/Sockets/Socket.Tasks.cs
 public Task ConnectAsync(IPAddress[] addresses, int port) => ConnectAsync(addresses, port, CancellationToken.None).AsTask();

 /// <summary>
 /// Establishes a connection to a remote host.
@antonfirsovantonfirsovDec 16, 2020

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Same for the rest ..
@geoffkizer
geoffkizer
commented
Dec 17, 2020

Copy link


Copy Markdown

ContributorAuthor
If documentation text will be auto-generated, we should probably copy it from SocketTaskExtensions for consistency:
I used that as a starting point for what I added and tried to improve/clarify parts.
@geoffkizer
geoffkizer
merged commit 9bb4bfe
into
dotnet:masterDec 30, 2020
@antonfirsovantonfirsov
mentioned this pull request
Jan 13, 2021
 Merged

@ghostghost
locked as resolved and limited conversation to collaborators
Jan 29, 2021
Sign up for freeto subscribe to this conversation on GitHub.
Already have an account?
Sign in.


Reviewers

@stephentoubstephentoubstephentoub approved these changes

+1 more reviewer

@antonfirsovantonfirsovantonfirsov approved these changes
Reviewers whose approvals may not affect merge requirements

Assignees


No one assigned


Labels

area-System.Net.Socketsnew-api-needs-documentation

Projects


None yet


Milestone

6.0.0

Development

Successfully merging this pull request may close these issues.

Move SocketTaskExtensions methods to Socket class itself


5 participants

@geoffkizer@Dotnet-GitSync-Bot@antonfirsov@stephentoub@carlossanlop

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Force GitHub README to respect dark mode\n(function() {\n var style = document.createElement('style');\n style.textContent = '\n .markdown-body {\n color-scheme: dark light;\n }\n .markdown-body pre { background: #161b22 !important; }\n .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }\n .markdown-body table th, .markdown-body table td { border-color: #30363d !important; }\n .markdown-body img { background: #0d1117; }\n .markdown-body blockquote { border-left-color: #8b949e; }\n .markdown-body hr { border-color: #30363d; }\n ';\n document.head.appendChild(style);\n})();", "GitHub Dark Mode README Fix");
}
} catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
move SocketTaskExtensions methods to Socket class - #45083
Merged
geoffkizer merged 4 commits into
dotnet:masterfrom 
geoffkizer:movesockettaskextensions
Dec 30, 2020
Merged
move SocketTaskExtensions methods to Socket class#45083
geoffkizer merged 4 commits into
dotnet:masterfrom 
geoffkizer:movesockettaskextensions
Conversation
@geoffkizer
@geoffkizergeoffkizer
commented
Nov 22, 2020

Copy link


Copy Markdown

Contributor
@geoffkizergeoffkizer
added this to the 6.0.0 milestone
Nov 22, 2020
@ghost
ghost
commented
Nov 22, 2020

Copy link


Copy Markdown

Tagging subscribers to this area: @dotnet/ncl

See info in area-owners.md if you want to be subscribed.
Issue Details
Fixes #43901
@antonfirsov@stephentoub @dotnet/ncl
Author:geoffkizer
Assignees:-
Labels:
area-System.Net.Sockets
Milestone:6.0.0
@Dotnet-GitSync-Bot
Dotnet-GitSync-Bot
commented
Nov 22, 2020

Copy link


Copy Markdown

Collaborator
Note regarding the new-api-needs-documentation label:
This serves as a reminder for when your PR is modifying a ref *.cs file and adding/modifying public APIs, to please make sure the API implementation in the src *.cs file is documented with triple slash comments, so the PR reviewers can sign off that change.
@geoffkizer
geoffkizer
commented
Nov 22, 2020

Copy link


Copy Markdown

ContributorAuthor
/azp run runtime-libraries-coreclr outerloop
@azure-pipelines
azure-pipelinesBot
commented
Nov 22, 2020

Copy link


Copy Markdown


Azure Pipelines successfully started running 1 pipeline(s).
antonfirsov
antonfirsov
reviewed
Nov 23, 2020
View reviewed changes
Comment threadsrc/libraries/System.Net.Sockets/ref/System.Net.Sockets.cs
Outdated


Comment on lines

+402
 to 
+420

 public System.Threading.Tasks.Task<System.Net.Sockets.Socket> AcceptAsync() { throw null; }
 public System.Threading.Tasks.Task<System.Net.Sockets.Socket> AcceptAsync(System.Net.Sockets.Socket? acceptSocket) { throw null; }
 public System.Threading.Tasks.Task ConnectAsync(System.Net.EndPoint remoteEP) { throw null; }
 public System.Threading.Tasks.ValueTask ConnectAsync(System.Net.EndPoint remoteEP, System.Threading.CancellationToken cancellationToken) { throw null; }
 public System.Threading.Tasks.Task ConnectAsync(System.Net.IPAddress address, int port) { throw null; }
 public System.Threading.Tasks.ValueTask ConnectAsync(System.Net.IPAddress address, int port, System.Threading.CancellationToken cancellationToken) { throw null; }
 public System.Threading.Tasks.Task ConnectAsync(System.Net.IPAddress[] addresses, int port) { throw null; }
 public System.Threading.Tasks.ValueTask ConnectAsync(System.Net.IPAddress[] addresses, int port, System.Threading.CancellationToken cancellationToken) { throw null; }
 public System.Threading.Tasks.Task ConnectAsync(string host, int port) { throw null; }
 public System.Threading.Tasks.ValueTask ConnectAsync(string host, int port, System.Threading.CancellationToken cancellationToken) { throw null; }
 public System.Threading.Tasks.Task<int> ReceiveAsync(System.ArraySegment<byte> buffer, System.Net.Sockets.SocketFlags socketFlags) { throw null; }
 public System.Threading.Tasks.Task<int> ReceiveAsync(System.Collections.Generic.IList<System.ArraySegment<byte>> buffers, System.Net.Sockets.SocketFlags socketFlags) { throw null; }
 public System.Threading.Tasks.ValueTask<int> ReceiveAsync(System.Memory<byte> buffer, System.Net.Sockets.SocketFlags socketFlags, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) { throw null; }
 public System.Threading.Tasks.Task<System.Net.Sockets.SocketReceiveFromResult> ReceiveFromAsync(System.ArraySegment<byte> buffer, System.Net.Sockets.SocketFlags socketFlags, System.Net.EndPoint remoteEndPoint) { throw null; }
 public System.Threading.Tasks.Task<System.Net.Sockets.SocketReceiveMessageFromResult> ReceiveMessageFromAsync(System.ArraySegment<byte> buffer, System.Net.Sockets.SocketFlags socketFlags, System.Net.EndPoint remoteEndPoint) { throw null; }
 public System.Threading.Tasks.Task<int> SendAsync(System.ArraySegment<byte> buffer, System.Net.Sockets.SocketFlags socketFlags) { throw null; }
 public System.Threading.Tasks.Task<int> SendAsync(System.Collections.Generic.IList<System.ArraySegment<byte>> buffers, System.Net.Sockets.SocketFlags socketFlags) { throw null; }
 public System.Threading.Tasks.ValueTask<int> SendAsync(System.ReadOnlyMemory<byte> buffer, System.Net.Sockets.SocketFlags socketFlags, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) { throw null; }
 public System.Threading.Tasks.Task<int> SendToAsync(System.ArraySegment<byte> buffer, System.Net.Sockets.SocketFlags socketFlags, System.Net.EndPoint remoteEP) { throw null; }
@antonfirsovantonfirsovNov 23, 2020

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I suppose the additions were manual. Shouldn't we at least do to the alphabetical ordering to reduce the number of conflicts in later PR-s with consolidation?
@geoffkizergeoffkizerNov 24, 2020

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sure, will do.
@runfoapprunfoappBot
mentioned this pull request
Nov 23, 2020

Closed

@antonfirsov
antonfirsov
commented
Nov 23, 2020

Copy link


Copy Markdown

Contributor
Coming from #44889 (comment) ... shouldn't we also add xmldocs in this PR?
@stephentoub
stephentoub
commented
Nov 23, 2020

Copy link


Copy Markdown

Member
shouldn't we also add xmldocs in this PR?
Yup
@geoffkizer
geoffkizer
commented
Nov 24, 2020

Copy link


Copy Markdown

ContributorAuthor
I suspect we already have docs for the extension methods, and we should just use them here.
@carlossanlop Do you know? What should be done in this PR to preserve existing docs, just move them to these instance methods?
@geoffkizer
geoffkizer
commented
Nov 24, 2020

Copy link


Copy Markdown

ContributorAuthor
/azp run runtime-libraries-coreclr outerloop
@azure-pipelines
azure-pipelinesBot
commented
Nov 24, 2020

Copy link


Copy Markdown


Azure Pipelines successfully started running 1 pipeline(s).
@carlossanlop
carlossanlop
commented
Nov 30, 2020

Copy link


Copy Markdown

Contributor
@geoffkizer@antonfirsov If documentation was already added somewhere else for the APIs that were made public in this PR, you can copy the triple slash comments on top of these newly public APIs.
@geoffkizer
geoffkizer
commented
Nov 30, 2020

Copy link


Copy Markdown

ContributorAuthor
@carlossanlop There are no triple-slash comments for the existing APIs.
@carlossanlop
carlossanlop
commented
Nov 30, 2020

Copy link


Copy Markdown

Contributor
@geoffkizer Ah, got it. Then please add new triple slash comments.
@geoffkizer
geoffkizer
commented
Dec 15, 2020

Copy link


Copy Markdown

ContributorAuthor
/azp run runtime-libraries-coreclr outerloop
@azure-pipelines
azure-pipelinesBot
commented
Dec 15, 2020

Copy link


Copy Markdown


Azure Pipelines successfully started running 1 pipeline(s).
@geoffkizer
geoffkizer
commented
Dec 15, 2020

Copy link


Copy Markdown

ContributorAuthor
Doc comments added.
@dotnet/ncl Can someone review?
@runfoapprunfoappBot
mentioned this pull request
Dec 15, 2020

Closed

antonfirsov
antonfirsov
reviewed
Dec 16, 2020
View reviewed changes
@antonfirsovantonfirsov
left a comment


Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If documentation text will be auto-generated, we should probably copy it from SocketTaskExtensions for consistency:
https://docs.microsoft.com/en-us/dotnet/api/system.net.sockets.sockettaskextensions.acceptasync?view=net-5.0#System_Net_Sockets_SocketTaskExtensions_AcceptAsync_System_Net_Sockets_Socket_
https://github.com/dotnet/dotnet-api-docs/blob/master/xml/System.Net.Sockets/SocketTaskExtensions.xml
Otherwise LGTM.
Comment threadsrc/libraries/System.Net.Sockets/src/System/Net/Sockets/Socket.Tasks.cs

 internal Task<Socket> AcceptAsync(Socket? acceptSocket)
 /// <summary>
 /// Accepts an incoming connection.
@antonfirsovantonfirsovDec 16, 2020•

edited by stephentoub

Loading

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.


Suggested change

/// Accepts an incoming connection.
/// Performs an asynchronous operation to accept an incoming connection attempt on the socket.
Comment threadsrc/libraries/System.Net.Sockets/src/System/Net/Sockets/Socket.Tasks.cs
 /// <summary>
 /// Accepts an incoming connection.
 /// </summary>
 /// <returns>An asynchronous task that completes with the accepted Socket.</returns>
@antonfirsovantonfirsovDec 16, 2020

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.


Suggested change

/// <returns>An asynchronous task that completes with the accepted Socket.</returns>
/// <returns>An asynchronous task that completes with a <see cref="T:System.Net.Sockets.Socket" /> to handle communication with the remote host.
Comment threadsrc/libraries/System.Net.Sockets/src/System/Net/Sockets/Socket.Tasks.cs
 public Task<Socket> AcceptAsync() => AcceptAsync((Socket?)null);

 /// <summary>
 /// Accepts an incoming connection.
@antonfirsovantonfirsovDec 16, 2020

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.


Suggested change

/// Accepts an incoming connection.
/// Performs an asynchronous operation on to accept an incoming connection attempt on the socket.
Comment threadsrc/libraries/System.Net.Sockets/src/System/Net/Sockets/Socket.Tasks.cs
 /// <summary>
 /// Accepts an incoming connection.
 /// </summary>
 /// <param name="acceptSocket">The socket to use for accepting the connection.</param>
@antonfirsovantonfirsovDec 16, 2020

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.


Suggested change

/// <param name="acceptSocket">The socket to use for accepting the connection.</param>
/// <param name="acceptSocket">The accepted Socket object. This value may be `null`.</param>
Comment threadsrc/libraries/System.Net.Sockets/src/System/Net/Sockets/Socket.Tasks.cs
 public Task ConnectAsync(IPAddress[] addresses, int port) => ConnectAsync(addresses, port, CancellationToken.None).AsTask();

 /// <summary>
 /// Establishes a connection to a remote host.
@antonfirsovantonfirsovDec 16, 2020

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Same for the rest ..
@geoffkizer
geoffkizer
commented
Dec 17, 2020

Copy link


Copy Markdown

ContributorAuthor
If documentation text will be auto-generated, we should probably copy it from SocketTaskExtensions for consistency:
I used that as a starting point for what I added and tried to improve/clarify parts.
@geoffkizer
geoffkizer
merged commit 9bb4bfe
into
dotnet:masterDec 30, 2020
@antonfirsovantonfirsov
mentioned this pull request
Jan 13, 2021
 Merged

@ghostghost
locked as resolved and limited conversation to collaborators
Jan 29, 2021
Sign up for freeto subscribe to this conversation on GitHub.
Already have an account?
Sign in.


Reviewers

@stephentoubstephentoubstephentoub approved these changes

+1 more reviewer

@antonfirsovantonfirsovantonfirsov approved these changes
Reviewers whose approvals may not affect merge requirements

Assignees


No one assigned


Labels

area-System.Net.Socketsnew-api-needs-documentation

Projects


None yet


Milestone

6.0.0

Development

Successfully merging this pull request may close these issues.

Move SocketTaskExtensions methods to Socket class itself


5 participants

@geoffkizer@Dotnet-GitSync-Bot@antonfirsov@stephentoub@carlossanlop

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Highlight search terms from Google/DuckDuckGo/Bing referrer\n(function() {\n var ref = document.referrer;\n var terms = [];\n \n if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {\n var url = new URL(ref);\n var q = url.searchParams.get('q') || url.searchParams.get('p');\n if (q) {\n terms = q.split(/\\s+/).filter(function(t) { return t.length > 2; });\n }\n }\n \n if (terms.length === 0) return;\n \n var style = document.createElement('style');\n style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';\n document.head.appendChild(style);\n \n function highlight(node) {\n if (node.nodeType === 3) { // text node\n var text = node.textContent;\n var found = false;\n terms.forEach(function(term) {\n var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\\]\\\\]/g, '\\\\') + ')', 'gi');\n if (regex.test(text)) {\n found = true;\n var frag = document.createDocumentFragment();\n var parts = text.split(regex);\n parts.forEach(function(part, i) {\n if (i % 2 === 0) {\n frag.appendChild(document.createTextNode(part));\n } else {\n var span = document.createElement('span');\n span.className = 'userscript-highlight';\n span.textContent = part;\n frag.appendChild(span);\n }\n });\n node.parentNode.replaceChild(frag, node);\n }\n });\n } else if (node.nodeType === 1 && node.childNodes) { // element\n var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];\n if (!skipTags.includes(node.tagName)) {\n Array.from(node.childNodes).forEach(highlight);\n }\n }\n }\n \n highlight(document.body);\n \n // Re-highlight on dynamic content\n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1 || node.nodeType === 3) highlight(node);\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Highlight Search Terms");
}
} catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
move SocketTaskExtensions methods to Socket class - #45083
Merged
geoffkizer merged 4 commits into
dotnet:masterfrom 
geoffkizer:movesockettaskextensions
Dec 30, 2020
Merged
move SocketTaskExtensions methods to Socket class#45083
geoffkizer merged 4 commits into
dotnet:masterfrom 
geoffkizer:movesockettaskextensions
Conversation
@geoffkizer
@geoffkizergeoffkizer
commented
Nov 22, 2020

Copy link


Copy Markdown

Contributor
@geoffkizergeoffkizer
added this to the 6.0.0 milestone
Nov 22, 2020
@ghost
ghost
commented
Nov 22, 2020

Copy link


Copy Markdown

Tagging subscribers to this area: @dotnet/ncl

See info in area-owners.md if you want to be subscribed.
Issue Details
Fixes #43901
@antonfirsov@stephentoub @dotnet/ncl
Author:geoffkizer
Assignees:-
Labels:
area-System.Net.Sockets
Milestone:6.0.0
@Dotnet-GitSync-Bot
Dotnet-GitSync-Bot
commented
Nov 22, 2020

Copy link


Copy Markdown

Collaborator
Note regarding the new-api-needs-documentation label:
This serves as a reminder for when your PR is modifying a ref *.cs file and adding/modifying public APIs, to please make sure the API implementation in the src *.cs file is documented with triple slash comments, so the PR reviewers can sign off that change.
@geoffkizer
geoffkizer
commented
Nov 22, 2020

Copy link


Copy Markdown

ContributorAuthor
/azp run runtime-libraries-coreclr outerloop
@azure-pipelines
azure-pipelinesBot
commented
Nov 22, 2020

Copy link


Copy Markdown


Azure Pipelines successfully started running 1 pipeline(s).
antonfirsov
antonfirsov
reviewed
Nov 23, 2020
View reviewed changes
Comment threadsrc/libraries/System.Net.Sockets/ref/System.Net.Sockets.cs
Outdated


Comment on lines

+402
 to 
+420

 public System.Threading.Tasks.Task<System.Net.Sockets.Socket> AcceptAsync() { throw null; }
 public System.Threading.Tasks.Task<System.Net.Sockets.Socket> AcceptAsync(System.Net.Sockets.Socket? acceptSocket) { throw null; }
 public System.Threading.Tasks.Task ConnectAsync(System.Net.EndPoint remoteEP) { throw null; }
 public System.Threading.Tasks.ValueTask ConnectAsync(System.Net.EndPoint remoteEP, System.Threading.CancellationToken cancellationToken) { throw null; }
 public System.Threading.Tasks.Task ConnectAsync(System.Net.IPAddress address, int port) { throw null; }
 public System.Threading.Tasks.ValueTask ConnectAsync(System.Net.IPAddress address, int port, System.Threading.CancellationToken cancellationToken) { throw null; }
 public System.Threading.Tasks.Task ConnectAsync(System.Net.IPAddress[] addresses, int port) { throw null; }
 public System.Threading.Tasks.ValueTask ConnectAsync(System.Net.IPAddress[] addresses, int port, System.Threading.CancellationToken cancellationToken) { throw null; }
 public System.Threading.Tasks.Task ConnectAsync(string host, int port) { throw null; }
 public System.Threading.Tasks.ValueTask ConnectAsync(string host, int port, System.Threading.CancellationToken cancellationToken) { throw null; }
 public System.Threading.Tasks.Task<int> ReceiveAsync(System.ArraySegment<byte> buffer, System.Net.Sockets.SocketFlags socketFlags) { throw null; }
 public System.Threading.Tasks.Task<int> ReceiveAsync(System.Collections.Generic.IList<System.ArraySegment<byte>> buffers, System.Net.Sockets.SocketFlags socketFlags) { throw null; }
 public System.Threading.Tasks.ValueTask<int> ReceiveAsync(System.Memory<byte> buffer, System.Net.Sockets.SocketFlags socketFlags, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) { throw null; }
 public System.Threading.Tasks.Task<System.Net.Sockets.SocketReceiveFromResult> ReceiveFromAsync(System.ArraySegment<byte> buffer, System.Net.Sockets.SocketFlags socketFlags, System.Net.EndPoint remoteEndPoint) { throw null; }
 public System.Threading.Tasks.Task<System.Net.Sockets.SocketReceiveMessageFromResult> ReceiveMessageFromAsync(System.ArraySegment<byte> buffer, System.Net.Sockets.SocketFlags socketFlags, System.Net.EndPoint remoteEndPoint) { throw null; }
 public System.Threading.Tasks.Task<int> SendAsync(System.ArraySegment<byte> buffer, System.Net.Sockets.SocketFlags socketFlags) { throw null; }
 public System.Threading.Tasks.Task<int> SendAsync(System.Collections.Generic.IList<System.ArraySegment<byte>> buffers, System.Net.Sockets.SocketFlags socketFlags) { throw null; }
 public System.Threading.Tasks.ValueTask<int> SendAsync(System.ReadOnlyMemory<byte> buffer, System.Net.Sockets.SocketFlags socketFlags, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) { throw null; }
 public System.Threading.Tasks.Task<int> SendToAsync(System.ArraySegment<byte> buffer, System.Net.Sockets.SocketFlags socketFlags, System.Net.EndPoint remoteEP) { throw null; }
@antonfirsovantonfirsovNov 23, 2020

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I suppose the additions were manual. Shouldn't we at least do to the alphabetical ordering to reduce the number of conflicts in later PR-s with consolidation?
@geoffkizergeoffkizerNov 24, 2020

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sure, will do.
@runfoapprunfoappBot
mentioned this pull request
Nov 23, 2020

Closed

@antonfirsov
antonfirsov
commented
Nov 23, 2020

Copy link


Copy Markdown

Contributor
Coming from #44889 (comment) ... shouldn't we also add xmldocs in this PR?
@stephentoub
stephentoub
commented
Nov 23, 2020

Copy link


Copy Markdown

Member
shouldn't we also add xmldocs in this PR?
Yup
@geoffkizer
geoffkizer
commented
Nov 24, 2020

Copy link


Copy Markdown

ContributorAuthor
I suspect we already have docs for the extension methods, and we should just use them here.
@carlossanlop Do you know? What should be done in this PR to preserve existing docs, just move them to these instance methods?
@geoffkizer
geoffkizer
commented
Nov 24, 2020

Copy link


Copy Markdown

ContributorAuthor
/azp run runtime-libraries-coreclr outerloop
@azure-pipelines
azure-pipelinesBot
commented
Nov 24, 2020

Copy link


Copy Markdown


Azure Pipelines successfully started running 1 pipeline(s).
@carlossanlop
carlossanlop
commented
Nov 30, 2020

Copy link


Copy Markdown

Contributor
@geoffkizer@antonfirsov If documentation was already added somewhere else for the APIs that were made public in this PR, you can copy the triple slash comments on top of these newly public APIs.
@geoffkizer
geoffkizer
commented
Nov 30, 2020

Copy link


Copy Markdown

ContributorAuthor
@carlossanlop There are no triple-slash comments for the existing APIs.
@carlossanlop
carlossanlop
commented
Nov 30, 2020

Copy link


Copy Markdown

Contributor
@geoffkizer Ah, got it. Then please add new triple slash comments.
@geoffkizer
geoffkizer
commented
Dec 15, 2020

Copy link


Copy Markdown

ContributorAuthor
/azp run runtime-libraries-coreclr outerloop
@azure-pipelines
azure-pipelinesBot
commented
Dec 15, 2020

Copy link


Copy Markdown


Azure Pipelines successfully started running 1 pipeline(s).
@geoffkizer
geoffkizer
commented
Dec 15, 2020

Copy link


Copy Markdown

ContributorAuthor
Doc comments added.
@dotnet/ncl Can someone review?
@runfoapprunfoappBot
mentioned this pull request
Dec 15, 2020

Closed

antonfirsov
antonfirsov
reviewed
Dec 16, 2020
View reviewed changes
@antonfirsovantonfirsov
left a comment


Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If documentation text will be auto-generated, we should probably copy it from SocketTaskExtensions for consistency:
https://docs.microsoft.com/en-us/dotnet/api/system.net.sockets.sockettaskextensions.acceptasync?view=net-5.0#System_Net_Sockets_SocketTaskExtensions_AcceptAsync_System_Net_Sockets_Socket_
https://github.com/dotnet/dotnet-api-docs/blob/master/xml/System.Net.Sockets/SocketTaskExtensions.xml
Otherwise LGTM.
Comment threadsrc/libraries/System.Net.Sockets/src/System/Net/Sockets/Socket.Tasks.cs

 internal Task<Socket> AcceptAsync(Socket? acceptSocket)
 /// <summary>
 /// Accepts an incoming connection.
@antonfirsovantonfirsovDec 16, 2020•

edited by stephentoub

Loading

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.


Suggested change

/// Accepts an incoming connection.
/// Performs an asynchronous operation to accept an incoming connection attempt on the socket.
Comment threadsrc/libraries/System.Net.Sockets/src/System/Net/Sockets/Socket.Tasks.cs
 /// <summary>
 /// Accepts an incoming connection.
 /// </summary>
 /// <returns>An asynchronous task that completes with the accepted Socket.</returns>
@antonfirsovantonfirsovDec 16, 2020

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.


Suggested change

/// <returns>An asynchronous task that completes with the accepted Socket.</returns>
/// <returns>An asynchronous task that completes with a <see cref="T:System.Net.Sockets.Socket" /> to handle communication with the remote host.
Comment threadsrc/libraries/System.Net.Sockets/src/System/Net/Sockets/Socket.Tasks.cs
 public Task<Socket> AcceptAsync() => AcceptAsync((Socket?)null);

 /// <summary>
 /// Accepts an incoming connection.
@antonfirsovantonfirsovDec 16, 2020

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.


Suggested change

/// Accepts an incoming connection.
/// Performs an asynchronous operation on to accept an incoming connection attempt on the socket.
Comment threadsrc/libraries/System.Net.Sockets/src/System/Net/Sockets/Socket.Tasks.cs
 /// <summary>
 /// Accepts an incoming connection.
 /// </summary>
 /// <param name="acceptSocket">The socket to use for accepting the connection.</param>
@antonfirsovantonfirsovDec 16, 2020

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.


Suggested change

/// <param name="acceptSocket">The socket to use for accepting the connection.</param>
/// <param name="acceptSocket">The accepted Socket object. This value may be `null`.</param>
Comment threadsrc/libraries/System.Net.Sockets/src/System/Net/Sockets/Socket.Tasks.cs
 public Task ConnectAsync(IPAddress[] addresses, int port) => ConnectAsync(addresses, port, CancellationToken.None).AsTask();

 /// <summary>
 /// Establishes a connection to a remote host.
@antonfirsovantonfirsovDec 16, 2020

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Same for the rest ..
@geoffkizer
geoffkizer
commented
Dec 17, 2020

Copy link


Copy Markdown

ContributorAuthor
If documentation text will be auto-generated, we should probably copy it from SocketTaskExtensions for consistency:
I used that as a starting point for what I added and tried to improve/clarify parts.
@geoffkizer
geoffkizer
merged commit 9bb4bfe
into
dotnet:masterDec 30, 2020
@antonfirsovantonfirsov
mentioned this pull request
Jan 13, 2021
 Merged

@ghostghost
locked as resolved and limited conversation to collaborators
Jan 29, 2021
Sign up for freeto subscribe to this conversation on GitHub.
Already have an account?
Sign in.


Reviewers

@stephentoubstephentoubstephentoub approved these changes

+1 more reviewer

@antonfirsovantonfirsovantonfirsov approved these changes
Reviewers whose approvals may not affect merge requirements

Assignees


No one assigned


Labels

area-System.Net.Socketsnew-api-needs-documentation

Projects


None yet


Milestone

6.0.0

Development

Successfully merging this pull request may close these issues.

Move SocketTaskExtensions methods to Socket class itself


5 participants

@geoffkizer@Dotnet-GitSync-Bot@antonfirsov@stephentoub@carlossanlop

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Strip utm_, fbclid, gclid, etc. from all links on page\n(function() {\n var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',\n 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',\n 'ref', 'ref_src', 'source', 'medium', 'campaign'];\n \n function cleanUrl(url) {\n try {\n var u = new URL(url, window.location.origin);\n var changed = false;\n trackingParams.forEach(function(p) {\n if (u.searchParams.has(p)) {\n u.searchParams.delete(p);\n changed = true;\n }\n });\n return changed ? u.toString() : url;\n } catch (e) {\n return url;\n }\n }\n \n function cleanLinks() {\n document.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n \n cleanLinks();\n \n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1) {\n if (node.tagName === 'A') cleanLinks();\n node.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Remove Tracking Parameters from Links");
}
} catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); }
})();
(function(){
try {
var __m = "youtube.com";
var __re = new RegExp('^' + "youtube\\.com" + '

Skip to content
move SocketTaskExtensions methods to Socket class - #45083
Merged
geoffkizer merged 4 commits into
dotnet:masterfrom 
geoffkizer:movesockettaskextensions
Dec 30, 2020
Merged
move SocketTaskExtensions methods to Socket class#45083
geoffkizer merged 4 commits into
dotnet:masterfrom 
geoffkizer:movesockettaskextensions
Conversation
@geoffkizer
@geoffkizergeoffkizer
commented
Nov 22, 2020

Copy link


Copy Markdown

Contributor
@geoffkizergeoffkizer
added this to the 6.0.0 milestone
Nov 22, 2020
@ghost
ghost
commented
Nov 22, 2020

Copy link


Copy Markdown

Tagging subscribers to this area: @dotnet/ncl

See info in area-owners.md if you want to be subscribed.
Issue Details
Fixes #43901
@antonfirsov@stephentoub @dotnet/ncl
Author:geoffkizer
Assignees:-
Labels:
area-System.Net.Sockets
Milestone:6.0.0
@Dotnet-GitSync-Bot
Dotnet-GitSync-Bot
commented
Nov 22, 2020

Copy link


Copy Markdown

Collaborator
Note regarding the new-api-needs-documentation label:
This serves as a reminder for when your PR is modifying a ref *.cs file and adding/modifying public APIs, to please make sure the API implementation in the src *.cs file is documented with triple slash comments, so the PR reviewers can sign off that change.
@geoffkizer
geoffkizer
commented
Nov 22, 2020

Copy link


Copy Markdown

ContributorAuthor
/azp run runtime-libraries-coreclr outerloop
@azure-pipelines
azure-pipelinesBot
commented
Nov 22, 2020

Copy link


Copy Markdown


Azure Pipelines successfully started running 1 pipeline(s).
antonfirsov
antonfirsov
reviewed
Nov 23, 2020
View reviewed changes
Comment threadsrc/libraries/System.Net.Sockets/ref/System.Net.Sockets.cs
Outdated


Comment on lines

+402
 to 
+420

 public System.Threading.Tasks.Task<System.Net.Sockets.Socket> AcceptAsync() { throw null; }
 public System.Threading.Tasks.Task<System.Net.Sockets.Socket> AcceptAsync(System.Net.Sockets.Socket? acceptSocket) { throw null; }
 public System.Threading.Tasks.Task ConnectAsync(System.Net.EndPoint remoteEP) { throw null; }
 public System.Threading.Tasks.ValueTask ConnectAsync(System.Net.EndPoint remoteEP, System.Threading.CancellationToken cancellationToken) { throw null; }
 public System.Threading.Tasks.Task ConnectAsync(System.Net.IPAddress address, int port) { throw null; }
 public System.Threading.Tasks.ValueTask ConnectAsync(System.Net.IPAddress address, int port, System.Threading.CancellationToken cancellationToken) { throw null; }
 public System.Threading.Tasks.Task ConnectAsync(System.Net.IPAddress[] addresses, int port) { throw null; }
 public System.Threading.Tasks.ValueTask ConnectAsync(System.Net.IPAddress[] addresses, int port, System.Threading.CancellationToken cancellationToken) { throw null; }
 public System.Threading.Tasks.Task ConnectAsync(string host, int port) { throw null; }
 public System.Threading.Tasks.ValueTask ConnectAsync(string host, int port, System.Threading.CancellationToken cancellationToken) { throw null; }
 public System.Threading.Tasks.Task<int> ReceiveAsync(System.ArraySegment<byte> buffer, System.Net.Sockets.SocketFlags socketFlags) { throw null; }
 public System.Threading.Tasks.Task<int> ReceiveAsync(System.Collections.Generic.IList<System.ArraySegment<byte>> buffers, System.Net.Sockets.SocketFlags socketFlags) { throw null; }
 public System.Threading.Tasks.ValueTask<int> ReceiveAsync(System.Memory<byte> buffer, System.Net.Sockets.SocketFlags socketFlags, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) { throw null; }
 public System.Threading.Tasks.Task<System.Net.Sockets.SocketReceiveFromResult> ReceiveFromAsync(System.ArraySegment<byte> buffer, System.Net.Sockets.SocketFlags socketFlags, System.Net.EndPoint remoteEndPoint) { throw null; }
 public System.Threading.Tasks.Task<System.Net.Sockets.SocketReceiveMessageFromResult> ReceiveMessageFromAsync(System.ArraySegment<byte> buffer, System.Net.Sockets.SocketFlags socketFlags, System.Net.EndPoint remoteEndPoint) { throw null; }
 public System.Threading.Tasks.Task<int> SendAsync(System.ArraySegment<byte> buffer, System.Net.Sockets.SocketFlags socketFlags) { throw null; }
 public System.Threading.Tasks.Task<int> SendAsync(System.Collections.Generic.IList<System.ArraySegment<byte>> buffers, System.Net.Sockets.SocketFlags socketFlags) { throw null; }
 public System.Threading.Tasks.ValueTask<int> SendAsync(System.ReadOnlyMemory<byte> buffer, System.Net.Sockets.SocketFlags socketFlags, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) { throw null; }
 public System.Threading.Tasks.Task<int> SendToAsync(System.ArraySegment<byte> buffer, System.Net.Sockets.SocketFlags socketFlags, System.Net.EndPoint remoteEP) { throw null; }
@antonfirsovantonfirsovNov 23, 2020

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I suppose the additions were manual. Shouldn't we at least do to the alphabetical ordering to reduce the number of conflicts in later PR-s with consolidation?
@geoffkizergeoffkizerNov 24, 2020

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sure, will do.
@runfoapprunfoappBot
mentioned this pull request
Nov 23, 2020

Closed

@antonfirsov
antonfirsov
commented
Nov 23, 2020

Copy link


Copy Markdown

Contributor
Coming from #44889 (comment) ... shouldn't we also add xmldocs in this PR?
@stephentoub
stephentoub
commented
Nov 23, 2020

Copy link


Copy Markdown

Member
shouldn't we also add xmldocs in this PR?
Yup
@geoffkizer
geoffkizer
commented
Nov 24, 2020

Copy link


Copy Markdown

ContributorAuthor
I suspect we already have docs for the extension methods, and we should just use them here.
@carlossanlop Do you know? What should be done in this PR to preserve existing docs, just move them to these instance methods?
@geoffkizer
geoffkizer
commented
Nov 24, 2020

Copy link


Copy Markdown

ContributorAuthor
/azp run runtime-libraries-coreclr outerloop
@azure-pipelines
azure-pipelinesBot
commented
Nov 24, 2020

Copy link


Copy Markdown


Azure Pipelines successfully started running 1 pipeline(s).
@carlossanlop
carlossanlop
commented
Nov 30, 2020

Copy link


Copy Markdown

Contributor
@geoffkizer@antonfirsov If documentation was already added somewhere else for the APIs that were made public in this PR, you can copy the triple slash comments on top of these newly public APIs.
@geoffkizer
geoffkizer
commented
Nov 30, 2020

Copy link


Copy Markdown

ContributorAuthor
@carlossanlop There are no triple-slash comments for the existing APIs.
@carlossanlop
carlossanlop
commented
Nov 30, 2020

Copy link


Copy Markdown

Contributor
@geoffkizer Ah, got it. Then please add new triple slash comments.
@geoffkizer
geoffkizer
commented
Dec 15, 2020

Copy link


Copy Markdown

ContributorAuthor
/azp run runtime-libraries-coreclr outerloop
@azure-pipelines
azure-pipelinesBot
commented
Dec 15, 2020

Copy link


Copy Markdown


Azure Pipelines successfully started running 1 pipeline(s).
@geoffkizer
geoffkizer
commented
Dec 15, 2020

Copy link


Copy Markdown

ContributorAuthor
Doc comments added.
@dotnet/ncl Can someone review?
@runfoapprunfoappBot
mentioned this pull request
Dec 15, 2020

Closed

antonfirsov
antonfirsov
reviewed
Dec 16, 2020
View reviewed changes
@antonfirsovantonfirsov
left a comment


Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If documentation text will be auto-generated, we should probably copy it from SocketTaskExtensions for consistency:
https://docs.microsoft.com/en-us/dotnet/api/system.net.sockets.sockettaskextensions.acceptasync?view=net-5.0#System_Net_Sockets_SocketTaskExtensions_AcceptAsync_System_Net_Sockets_Socket_
https://github.com/dotnet/dotnet-api-docs/blob/master/xml/System.Net.Sockets/SocketTaskExtensions.xml
Otherwise LGTM.
Comment threadsrc/libraries/System.Net.Sockets/src/System/Net/Sockets/Socket.Tasks.cs

 internal Task<Socket> AcceptAsync(Socket? acceptSocket)
 /// <summary>
 /// Accepts an incoming connection.
@antonfirsovantonfirsovDec 16, 2020•

edited by stephentoub

Loading

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.


Suggested change

/// Accepts an incoming connection.
/// Performs an asynchronous operation to accept an incoming connection attempt on the socket.
Comment threadsrc/libraries/System.Net.Sockets/src/System/Net/Sockets/Socket.Tasks.cs
 /// <summary>
 /// Accepts an incoming connection.
 /// </summary>
 /// <returns>An asynchronous task that completes with the accepted Socket.</returns>
@antonfirsovantonfirsovDec 16, 2020

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.


Suggested change

/// <returns>An asynchronous task that completes with the accepted Socket.</returns>
/// <returns>An asynchronous task that completes with a <see cref="T:System.Net.Sockets.Socket" /> to handle communication with the remote host.
Comment threadsrc/libraries/System.Net.Sockets/src/System/Net/Sockets/Socket.Tasks.cs
 public Task<Socket> AcceptAsync() => AcceptAsync((Socket?)null);

 /// <summary>
 /// Accepts an incoming connection.
@antonfirsovantonfirsovDec 16, 2020

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.


Suggested change

/// Accepts an incoming connection.
/// Performs an asynchronous operation on to accept an incoming connection attempt on the socket.
Comment threadsrc/libraries/System.Net.Sockets/src/System/Net/Sockets/Socket.Tasks.cs
 /// <summary>
 /// Accepts an incoming connection.
 /// </summary>
 /// <param name="acceptSocket">The socket to use for accepting the connection.</param>
@antonfirsovantonfirsovDec 16, 2020

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.


Suggested change

/// <param name="acceptSocket">The socket to use for accepting the connection.</param>
/// <param name="acceptSocket">The accepted Socket object. This value may be `null`.</param>
Comment threadsrc/libraries/System.Net.Sockets/src/System/Net/Sockets/Socket.Tasks.cs
 public Task ConnectAsync(IPAddress[] addresses, int port) => ConnectAsync(addresses, port, CancellationToken.None).AsTask();

 /// <summary>
 /// Establishes a connection to a remote host.
@antonfirsovantonfirsovDec 16, 2020

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Same for the rest ..
@geoffkizer
geoffkizer
commented
Dec 17, 2020

Copy link


Copy Markdown

ContributorAuthor
If documentation text will be auto-generated, we should probably copy it from SocketTaskExtensions for consistency:
I used that as a starting point for what I added and tried to improve/clarify parts.
@geoffkizer
geoffkizer
merged commit 9bb4bfe
into
dotnet:masterDec 30, 2020
@antonfirsovantonfirsov
mentioned this pull request
Jan 13, 2021
 Merged

@ghostghost
locked as resolved and limited conversation to collaborators
Jan 29, 2021
Sign up for freeto subscribe to this conversation on GitHub.
Already have an account?
Sign in.


Reviewers

@stephentoubstephentoubstephentoub approved these changes

+1 more reviewer

@antonfirsovantonfirsovantonfirsov approved these changes
Reviewers whose approvals may not affect merge requirements

Assignees


No one assigned


Labels

area-System.Net.Socketsnew-api-needs-documentation

Projects


None yet


Milestone

6.0.0

Development

Successfully merging this pull request may close these issues.

Move SocketTaskExtensions methods to Socket class itself


5 participants

@geoffkizer@Dotnet-GitSync-Bot@antonfirsov@stephentoub@carlossanlop

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Auto-enable theater mode on YouTube\n(function() {\n function tryTheater() {\n var btn = document.querySelector('button[aria-label=\"Theater mode\"], ytd-player #player button[title=\"Theater mode\"]');\n if (btn && !btn.classList.contains('activated')) {\n btn.click();\n }\n }\n \n // Try immediately\n tryTheater();\n \n // Try after navigation (SPA)\n var lastUrl = location.href;\n setInterval(function() {\n if (location.href !== lastUrl) {\n lastUrl = location.href;\n setTimeout(tryTheater, 500);\n }\n }, 1000);\n \n // Also try on player load\n var observer = new MutationObserver(tryTheater);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "YouTube Theater Mode Default");
}
} catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
move SocketTaskExtensions methods to Socket class - #45083
Merged
geoffkizer merged 4 commits into
dotnet:masterfrom 
geoffkizer:movesockettaskextensions
Dec 30, 2020
Merged
move SocketTaskExtensions methods to Socket class#45083
geoffkizer merged 4 commits into
dotnet:masterfrom 
geoffkizer:movesockettaskextensions
Conversation
@geoffkizer
@geoffkizergeoffkizer
commented
Nov 22, 2020

Copy link


Copy Markdown

Contributor
@geoffkizergeoffkizer
added this to the 6.0.0 milestone
Nov 22, 2020
@ghost
ghost
commented
Nov 22, 2020

Copy link


Copy Markdown

Tagging subscribers to this area: @dotnet/ncl

See info in area-owners.md if you want to be subscribed.
Issue Details
Fixes #43901
@antonfirsov@stephentoub @dotnet/ncl
Author:geoffkizer
Assignees:-
Labels:
area-System.Net.Sockets
Milestone:6.0.0
@Dotnet-GitSync-Bot
Dotnet-GitSync-Bot
commented
Nov 22, 2020

Copy link


Copy Markdown

Collaborator
Note regarding the new-api-needs-documentation label:
This serves as a reminder for when your PR is modifying a ref *.cs file and adding/modifying public APIs, to please make sure the API implementation in the src *.cs file is documented with triple slash comments, so the PR reviewers can sign off that change.
@geoffkizer
geoffkizer
commented
Nov 22, 2020

Copy link


Copy Markdown

ContributorAuthor
/azp run runtime-libraries-coreclr outerloop
@azure-pipelines
azure-pipelinesBot
commented
Nov 22, 2020

Copy link


Copy Markdown


Azure Pipelines successfully started running 1 pipeline(s).
antonfirsov
antonfirsov
reviewed
Nov 23, 2020
View reviewed changes
Comment threadsrc/libraries/System.Net.Sockets/ref/System.Net.Sockets.cs
Outdated


Comment on lines

+402
 to 
+420

 public System.Threading.Tasks.Task<System.Net.Sockets.Socket> AcceptAsync() { throw null; }
 public System.Threading.Tasks.Task<System.Net.Sockets.Socket> AcceptAsync(System.Net.Sockets.Socket? acceptSocket) { throw null; }
 public System.Threading.Tasks.Task ConnectAsync(System.Net.EndPoint remoteEP) { throw null; }
 public System.Threading.Tasks.ValueTask ConnectAsync(System.Net.EndPoint remoteEP, System.Threading.CancellationToken cancellationToken) { throw null; }
 public System.Threading.Tasks.Task ConnectAsync(System.Net.IPAddress address, int port) { throw null; }
 public System.Threading.Tasks.ValueTask ConnectAsync(System.Net.IPAddress address, int port, System.Threading.CancellationToken cancellationToken) { throw null; }
 public System.Threading.Tasks.Task ConnectAsync(System.Net.IPAddress[] addresses, int port) { throw null; }
 public System.Threading.Tasks.ValueTask ConnectAsync(System.Net.IPAddress[] addresses, int port, System.Threading.CancellationToken cancellationToken) { throw null; }
 public System.Threading.Tasks.Task ConnectAsync(string host, int port) { throw null; }
 public System.Threading.Tasks.ValueTask ConnectAsync(string host, int port, System.Threading.CancellationToken cancellationToken) { throw null; }
 public System.Threading.Tasks.Task<int> ReceiveAsync(System.ArraySegment<byte> buffer, System.Net.Sockets.SocketFlags socketFlags) { throw null; }
 public System.Threading.Tasks.Task<int> ReceiveAsync(System.Collections.Generic.IList<System.ArraySegment<byte>> buffers, System.Net.Sockets.SocketFlags socketFlags) { throw null; }
 public System.Threading.Tasks.ValueTask<int> ReceiveAsync(System.Memory<byte> buffer, System.Net.Sockets.SocketFlags socketFlags, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) { throw null; }
 public System.Threading.Tasks.Task<System.Net.Sockets.SocketReceiveFromResult> ReceiveFromAsync(System.ArraySegment<byte> buffer, System.Net.Sockets.SocketFlags socketFlags, System.Net.EndPoint remoteEndPoint) { throw null; }
 public System.Threading.Tasks.Task<System.Net.Sockets.SocketReceiveMessageFromResult> ReceiveMessageFromAsync(System.ArraySegment<byte> buffer, System.Net.Sockets.SocketFlags socketFlags, System.Net.EndPoint remoteEndPoint) { throw null; }
 public System.Threading.Tasks.Task<int> SendAsync(System.ArraySegment<byte> buffer, System.Net.Sockets.SocketFlags socketFlags) { throw null; }
 public System.Threading.Tasks.Task<int> SendAsync(System.Collections.Generic.IList<System.ArraySegment<byte>> buffers, System.Net.Sockets.SocketFlags socketFlags) { throw null; }
 public System.Threading.Tasks.ValueTask<int> SendAsync(System.ReadOnlyMemory<byte> buffer, System.Net.Sockets.SocketFlags socketFlags, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) { throw null; }
 public System.Threading.Tasks.Task<int> SendToAsync(System.ArraySegment<byte> buffer, System.Net.Sockets.SocketFlags socketFlags, System.Net.EndPoint remoteEP) { throw null; }
@antonfirsovantonfirsovNov 23, 2020

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I suppose the additions were manual. Shouldn't we at least do to the alphabetical ordering to reduce the number of conflicts in later PR-s with consolidation?
@geoffkizergeoffkizerNov 24, 2020

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sure, will do.
@runfoapprunfoappBot
mentioned this pull request
Nov 23, 2020

Closed

@antonfirsov
antonfirsov
commented
Nov 23, 2020

Copy link


Copy Markdown

Contributor
Coming from #44889 (comment) ... shouldn't we also add xmldocs in this PR?
@stephentoub
stephentoub
commented
Nov 23, 2020

Copy link


Copy Markdown

Member
shouldn't we also add xmldocs in this PR?
Yup
@geoffkizer
geoffkizer
commented
Nov 24, 2020

Copy link


Copy Markdown

ContributorAuthor
I suspect we already have docs for the extension methods, and we should just use them here.
@carlossanlop Do you know? What should be done in this PR to preserve existing docs, just move them to these instance methods?
@geoffkizer
geoffkizer
commented
Nov 24, 2020

Copy link


Copy Markdown

ContributorAuthor
/azp run runtime-libraries-coreclr outerloop
@azure-pipelines
azure-pipelinesBot
commented
Nov 24, 2020

Copy link


Copy Markdown


Azure Pipelines successfully started running 1 pipeline(s).
@carlossanlop
carlossanlop
commented
Nov 30, 2020

Copy link


Copy Markdown

Contributor
@geoffkizer@antonfirsov If documentation was already added somewhere else for the APIs that were made public in this PR, you can copy the triple slash comments on top of these newly public APIs.
@geoffkizer
geoffkizer
commented
Nov 30, 2020

Copy link


Copy Markdown

ContributorAuthor
@carlossanlop There are no triple-slash comments for the existing APIs.
@carlossanlop
carlossanlop
commented
Nov 30, 2020

Copy link


Copy Markdown

Contributor
@geoffkizer Ah, got it. Then please add new triple slash comments.
@geoffkizer
geoffkizer
commented
Dec 15, 2020

Copy link


Copy Markdown

ContributorAuthor
/azp run runtime-libraries-coreclr outerloop
@azure-pipelines
azure-pipelinesBot
commented
Dec 15, 2020

Copy link


Copy Markdown


Azure Pipelines successfully started running 1 pipeline(s).
@geoffkizer
geoffkizer
commented
Dec 15, 2020

Copy link


Copy Markdown

ContributorAuthor
Doc comments added.
@dotnet/ncl Can someone review?
@runfoapprunfoappBot
mentioned this pull request
Dec 15, 2020

Closed

antonfirsov
antonfirsov
reviewed
Dec 16, 2020
View reviewed changes
@antonfirsovantonfirsov
left a comment


Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If documentation text will be auto-generated, we should probably copy it from SocketTaskExtensions for consistency:
https://docs.microsoft.com/en-us/dotnet/api/system.net.sockets.sockettaskextensions.acceptasync?view=net-5.0#System_Net_Sockets_SocketTaskExtensions_AcceptAsync_System_Net_Sockets_Socket_
https://github.com/dotnet/dotnet-api-docs/blob/master/xml/System.Net.Sockets/SocketTaskExtensions.xml
Otherwise LGTM.
Comment threadsrc/libraries/System.Net.Sockets/src/System/Net/Sockets/Socket.Tasks.cs

 internal Task<Socket> AcceptAsync(Socket? acceptSocket)
 /// <summary>
 /// Accepts an incoming connection.
@antonfirsovantonfirsovDec 16, 2020•

edited by stephentoub

Loading

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.


Suggested change

/// Accepts an incoming connection.
/// Performs an asynchronous operation to accept an incoming connection attempt on the socket.
Comment threadsrc/libraries/System.Net.Sockets/src/System/Net/Sockets/Socket.Tasks.cs
 /// <summary>
 /// Accepts an incoming connection.
 /// </summary>
 /// <returns>An asynchronous task that completes with the accepted Socket.</returns>
@antonfirsovantonfirsovDec 16, 2020

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.


Suggested change

/// <returns>An asynchronous task that completes with the accepted Socket.</returns>
/// <returns>An asynchronous task that completes with a <see cref="T:System.Net.Sockets.Socket" /> to handle communication with the remote host.
Comment threadsrc/libraries/System.Net.Sockets/src/System/Net/Sockets/Socket.Tasks.cs
 public Task<Socket> AcceptAsync() => AcceptAsync((Socket?)null);

 /// <summary>
 /// Accepts an incoming connection.
@antonfirsovantonfirsovDec 16, 2020

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.


Suggested change

/// Accepts an incoming connection.
/// Performs an asynchronous operation on to accept an incoming connection attempt on the socket.
Comment threadsrc/libraries/System.Net.Sockets/src/System/Net/Sockets/Socket.Tasks.cs
 /// <summary>
 /// Accepts an incoming connection.
 /// </summary>
 /// <param name="acceptSocket">The socket to use for accepting the connection.</param>
@antonfirsovantonfirsovDec 16, 2020

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.


Suggested change

/// <param name="acceptSocket">The socket to use for accepting the connection.</param>
/// <param name="acceptSocket">The accepted Socket object. This value may be `null`.</param>
Comment threadsrc/libraries/System.Net.Sockets/src/System/Net/Sockets/Socket.Tasks.cs
 public Task ConnectAsync(IPAddress[] addresses, int port) => ConnectAsync(addresses, port, CancellationToken.None).AsTask();

 /// <summary>
 /// Establishes a connection to a remote host.
@antonfirsovantonfirsovDec 16, 2020

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Same for the rest ..
@geoffkizer
geoffkizer
commented
Dec 17, 2020

Copy link


Copy Markdown

ContributorAuthor
If documentation text will be auto-generated, we should probably copy it from SocketTaskExtensions for consistency:
I used that as a starting point for what I added and tried to improve/clarify parts.
@geoffkizer
geoffkizer
merged commit 9bb4bfe
into
dotnet:masterDec 30, 2020
@antonfirsovantonfirsov
mentioned this pull request
Jan 13, 2021
 Merged

@ghostghost
locked as resolved and limited conversation to collaborators
Jan 29, 2021
Sign up for freeto subscribe to this conversation on GitHub.
Already have an account?
Sign in.


Reviewers

@stephentoubstephentoubstephentoub approved these changes

+1 more reviewer

@antonfirsovantonfirsovantonfirsov approved these changes
Reviewers whose approvals may not affect merge requirements

Assignees


No one assigned


Labels

area-System.Net.Socketsnew-api-needs-documentation

Projects


None yet


Milestone

6.0.0

Development

Successfully merging this pull request may close these issues.

Move SocketTaskExtensions methods to Socket class itself


5 participants

@geoffkizer@Dotnet-GitSync-Bot@antonfirsov@stephentoub@carlossanlop

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Remove or un-stick sticky/fixed headers that block content\n(function() {\n function unstick() {\n document.querySelectorAll('header, nav, [role=\"banner\"], .header, .navbar, .sticky, .fixed-top, [style*=\"position: fixed\"], [style*=\"position:sticky\"]').forEach(function(el) {\n if (el.style.position === 'fixed' || el.style.position === 'sticky' || \n getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {\n el.style.position = 'static';\n el.style.top = 'auto';\n el.style.zIndex = 'auto';\n }\n });\n }\n \n unstick();\n \n var observer = new MutationObserver(unstick);\n observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });\n})();", "Kill Sticky Headers");
}
} catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
move SocketTaskExtensions methods to Socket class - #45083
Merged
geoffkizer merged 4 commits into
dotnet:masterfrom 
geoffkizer:movesockettaskextensions
Dec 30, 2020
Merged
move SocketTaskExtensions methods to Socket class#45083
geoffkizer merged 4 commits into
dotnet:masterfrom 
geoffkizer:movesockettaskextensions
Conversation
@geoffkizer
@geoffkizergeoffkizer
commented
Nov 22, 2020

Copy link


Copy Markdown

Contributor
@geoffkizergeoffkizer
added this to the 6.0.0 milestone
Nov 22, 2020
@ghost
ghost
commented
Nov 22, 2020

Copy link


Copy Markdown

Tagging subscribers to this area: @dotnet/ncl

See info in area-owners.md if you want to be subscribed.
Issue Details
Fixes #43901
@antonfirsov@stephentoub @dotnet/ncl
Author:geoffkizer
Assignees:-
Labels:
area-System.Net.Sockets
Milestone:6.0.0
@Dotnet-GitSync-Bot
Dotnet-GitSync-Bot
commented
Nov 22, 2020

Copy link


Copy Markdown

Collaborator
Note regarding the new-api-needs-documentation label:
This serves as a reminder for when your PR is modifying a ref *.cs file and adding/modifying public APIs, to please make sure the API implementation in the src *.cs file is documented with triple slash comments, so the PR reviewers can sign off that change.
@geoffkizer
geoffkizer
commented
Nov 22, 2020

Copy link


Copy Markdown

ContributorAuthor
/azp run runtime-libraries-coreclr outerloop
@azure-pipelines
azure-pipelinesBot
commented
Nov 22, 2020

Copy link


Copy Markdown


Azure Pipelines successfully started running 1 pipeline(s).
antonfirsov
antonfirsov
reviewed
Nov 23, 2020
View reviewed changes
Comment threadsrc/libraries/System.Net.Sockets/ref/System.Net.Sockets.cs
Outdated


Comment on lines

+402
 to 
+420

 public System.Threading.Tasks.Task<System.Net.Sockets.Socket> AcceptAsync() { throw null; }
 public System.Threading.Tasks.Task<System.Net.Sockets.Socket> AcceptAsync(System.Net.Sockets.Socket? acceptSocket) { throw null; }
 public System.Threading.Tasks.Task ConnectAsync(System.Net.EndPoint remoteEP) { throw null; }
 public System.Threading.Tasks.ValueTask ConnectAsync(System.Net.EndPoint remoteEP, System.Threading.CancellationToken cancellationToken) { throw null; }
 public System.Threading.Tasks.Task ConnectAsync(System.Net.IPAddress address, int port) { throw null; }
 public System.Threading.Tasks.ValueTask ConnectAsync(System.Net.IPAddress address, int port, System.Threading.CancellationToken cancellationToken) { throw null; }
 public System.Threading.Tasks.Task ConnectAsync(System.Net.IPAddress[] addresses, int port) { throw null; }
 public System.Threading.Tasks.ValueTask ConnectAsync(System.Net.IPAddress[] addresses, int port, System.Threading.CancellationToken cancellationToken) { throw null; }
 public System.Threading.Tasks.Task ConnectAsync(string host, int port) { throw null; }
 public System.Threading.Tasks.ValueTask ConnectAsync(string host, int port, System.Threading.CancellationToken cancellationToken) { throw null; }
 public System.Threading.Tasks.Task<int> ReceiveAsync(System.ArraySegment<byte> buffer, System.Net.Sockets.SocketFlags socketFlags) { throw null; }
 public System.Threading.Tasks.Task<int> ReceiveAsync(System.Collections.Generic.IList<System.ArraySegment<byte>> buffers, System.Net.Sockets.SocketFlags socketFlags) { throw null; }
 public System.Threading.Tasks.ValueTask<int> ReceiveAsync(System.Memory<byte> buffer, System.Net.Sockets.SocketFlags socketFlags, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) { throw null; }
 public System.Threading.Tasks.Task<System.Net.Sockets.SocketReceiveFromResult> ReceiveFromAsync(System.ArraySegment<byte> buffer, System.Net.Sockets.SocketFlags socketFlags, System.Net.EndPoint remoteEndPoint) { throw null; }
 public System.Threading.Tasks.Task<System.Net.Sockets.SocketReceiveMessageFromResult> ReceiveMessageFromAsync(System.ArraySegment<byte> buffer, System.Net.Sockets.SocketFlags socketFlags, System.Net.EndPoint remoteEndPoint) { throw null; }
 public System.Threading.Tasks.Task<int> SendAsync(System.ArraySegment<byte> buffer, System.Net.Sockets.SocketFlags socketFlags) { throw null; }
 public System.Threading.Tasks.Task<int> SendAsync(System.Collections.Generic.IList<System.ArraySegment<byte>> buffers, System.Net.Sockets.SocketFlags socketFlags) { throw null; }
 public System.Threading.Tasks.ValueTask<int> SendAsync(System.ReadOnlyMemory<byte> buffer, System.Net.Sockets.SocketFlags socketFlags, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) { throw null; }
 public System.Threading.Tasks.Task<int> SendToAsync(System.ArraySegment<byte> buffer, System.Net.Sockets.SocketFlags socketFlags, System.Net.EndPoint remoteEP) { throw null; }
@antonfirsovantonfirsovNov 23, 2020

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I suppose the additions were manual. Shouldn't we at least do to the alphabetical ordering to reduce the number of conflicts in later PR-s with consolidation?
@geoffkizergeoffkizerNov 24, 2020

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sure, will do.
@runfoapprunfoappBot
mentioned this pull request
Nov 23, 2020

Closed

@antonfirsov
antonfirsov
commented
Nov 23, 2020

Copy link


Copy Markdown

Contributor
Coming from #44889 (comment) ... shouldn't we also add xmldocs in this PR?
@stephentoub
stephentoub
commented
Nov 23, 2020

Copy link


Copy Markdown

Member
shouldn't we also add xmldocs in this PR?
Yup
@geoffkizer
geoffkizer
commented
Nov 24, 2020

Copy link


Copy Markdown

ContributorAuthor
I suspect we already have docs for the extension methods, and we should just use them here.
@carlossanlop Do you know? What should be done in this PR to preserve existing docs, just move them to these instance methods?
@geoffkizer
geoffkizer
commented
Nov 24, 2020

Copy link


Copy Markdown

ContributorAuthor
/azp run runtime-libraries-coreclr outerloop
@azure-pipelines
azure-pipelinesBot
commented
Nov 24, 2020

Copy link


Copy Markdown


Azure Pipelines successfully started running 1 pipeline(s).
@carlossanlop
carlossanlop
commented
Nov 30, 2020

Copy link


Copy Markdown

Contributor
@geoffkizer@antonfirsov If documentation was already added somewhere else for the APIs that were made public in this PR, you can copy the triple slash comments on top of these newly public APIs.
@geoffkizer
geoffkizer
commented
Nov 30, 2020

Copy link


Copy Markdown

ContributorAuthor
@carlossanlop There are no triple-slash comments for the existing APIs.
@carlossanlop
carlossanlop
commented
Nov 30, 2020

Copy link


Copy Markdown

Contributor
@geoffkizer Ah, got it. Then please add new triple slash comments.
@geoffkizer
geoffkizer
commented
Dec 15, 2020

Copy link


Copy Markdown

ContributorAuthor
/azp run runtime-libraries-coreclr outerloop
@azure-pipelines
azure-pipelinesBot
commented
Dec 15, 2020

Copy link


Copy Markdown


Azure Pipelines successfully started running 1 pipeline(s).
@geoffkizer
geoffkizer
commented
Dec 15, 2020

Copy link


Copy Markdown

ContributorAuthor
Doc comments added.
@dotnet/ncl Can someone review?
@runfoapprunfoappBot
mentioned this pull request
Dec 15, 2020

Closed

antonfirsov
antonfirsov
reviewed
Dec 16, 2020
View reviewed changes
@antonfirsovantonfirsov
left a comment


Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If documentation text will be auto-generated, we should probably copy it from SocketTaskExtensions for consistency:
https://docs.microsoft.com/en-us/dotnet/api/system.net.sockets.sockettaskextensions.acceptasync?view=net-5.0#System_Net_Sockets_SocketTaskExtensions_AcceptAsync_System_Net_Sockets_Socket_
https://github.com/dotnet/dotnet-api-docs/blob/master/xml/System.Net.Sockets/SocketTaskExtensions.xml
Otherwise LGTM.
Comment threadsrc/libraries/System.Net.Sockets/src/System/Net/Sockets/Socket.Tasks.cs

 internal Task<Socket> AcceptAsync(Socket? acceptSocket)
 /// <summary>
 /// Accepts an incoming connection.
@antonfirsovantonfirsovDec 16, 2020•

edited by stephentoub

Loading

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.


Suggested change

/// Accepts an incoming connection.
/// Performs an asynchronous operation to accept an incoming connection attempt on the socket.
Comment threadsrc/libraries/System.Net.Sockets/src/System/Net/Sockets/Socket.Tasks.cs
 /// <summary>
 /// Accepts an incoming connection.
 /// </summary>
 /// <returns>An asynchronous task that completes with the accepted Socket.</returns>
@antonfirsovantonfirsovDec 16, 2020

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.


Suggested change

/// <returns>An asynchronous task that completes with the accepted Socket.</returns>
/// <returns>An asynchronous task that completes with a <see cref="T:System.Net.Sockets.Socket" /> to handle communication with the remote host.
Comment threadsrc/libraries/System.Net.Sockets/src/System/Net/Sockets/Socket.Tasks.cs
 public Task<Socket> AcceptAsync() => AcceptAsync((Socket?)null);

 /// <summary>
 /// Accepts an incoming connection.
@antonfirsovantonfirsovDec 16, 2020

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.


Suggested change

/// Accepts an incoming connection.
/// Performs an asynchronous operation on to accept an incoming connection attempt on the socket.
Comment threadsrc/libraries/System.Net.Sockets/src/System/Net/Sockets/Socket.Tasks.cs
 /// <summary>
 /// Accepts an incoming connection.
 /// </summary>
 /// <param name="acceptSocket">The socket to use for accepting the connection.</param>
@antonfirsovantonfirsovDec 16, 2020

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.


Suggested change

/// <param name="acceptSocket">The socket to use for accepting the connection.</param>
/// <param name="acceptSocket">The accepted Socket object. This value may be `null`.</param>
Comment threadsrc/libraries/System.Net.Sockets/src/System/Net/Sockets/Socket.Tasks.cs
 public Task ConnectAsync(IPAddress[] addresses, int port) => ConnectAsync(addresses, port, CancellationToken.None).AsTask();

 /// <summary>
 /// Establishes a connection to a remote host.
@antonfirsovantonfirsovDec 16, 2020

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Same for the rest ..
@geoffkizer
geoffkizer
commented
Dec 17, 2020

Copy link


Copy Markdown

ContributorAuthor
If documentation text will be auto-generated, we should probably copy it from SocketTaskExtensions for consistency:
I used that as a starting point for what I added and tried to improve/clarify parts.
@geoffkizer
geoffkizer
merged commit 9bb4bfe
into
dotnet:masterDec 30, 2020
@antonfirsovantonfirsov
mentioned this pull request
Jan 13, 2021
 Merged

@ghostghost
locked as resolved and limited conversation to collaborators
Jan 29, 2021
Sign up for freeto subscribe to this conversation on GitHub.
Already have an account?
Sign in.


Reviewers

@stephentoubstephentoubstephentoub approved these changes

+1 more reviewer

@antonfirsovantonfirsovantonfirsov approved these changes
Reviewers whose approvals may not affect merge requirements

Assignees


No one assigned


Labels

area-System.Net.Socketsnew-api-needs-documentation

Projects


None yet


Milestone

6.0.0

Development

Successfully merging this pull request may close these issues.

Move SocketTaskExtensions methods to Socket class itself


5 participants

@geoffkizer@Dotnet-GitSync-Bot@antonfirsov@stephentoub@carlossanlop

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Universal Dark Mode - works on any site\n(function() {\n var enabled = true;\n \n function applyDarkMode() {\n if (!enabled) return;\n \n // Create style element if it doesn't exist\n var style = document.getElementById('universal-dark-mode-style');\n if (!style) {\n style = document.createElement('style');\n style.id = 'universal-dark-mode-style';\n document.head.appendChild(style);\n }\n \n // Dark mode CSS - inverts colors but preserves images/video\n style.textContent = '\n /* Invert everything except media */\n html {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #1a1a2e !important;\n }\n \n /* Restore images, videos, iframes, canvas */\n img, video, iframe, canvas, svg, picture, [style*=\"background-image\"] {\n filter: invert(1) hue-rotate(180deg) !important;\n }\n \n /* Preserve specific elements that should not be inverted */\n .no-dark-mode, .no-dark-mode *,\n [data-theme=\"light\"], [data-theme=\"light\"],\n .ace_editor, .ace_editor *,\n .CodeMirror, .CodeMirror *,\n .monaco-editor, .monaco-editor *,\n .markdown-body pre, .markdown-body pre *,\n .highlight, .highlight *,\n pre code, pre code * {\n filter: none !important;\n }\n \n /* Fix common UI elements */\n .modal, .popup, .dropdown-menu, .tooltip, .popover {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #2d2d44 !important;\n border-color: #444 !important;\n }\n \n /* Scrollbars */\n ::-webkit-scrollbar { background: #1a1a2e !important; }\n ::-webkit-scrollbar-thumb { background: #444 !important; }\n ::-webkit-scrollbar-thumb:hover { background: #555 !important; }\n \n /* Selection */\n ::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ';\n }\n \n function removeDarkMode() {\n var style = document.getElementById('universal-dark-mode-style');\n if (style) style.remove();\n }\n \n // Toggle with Alt+Shift+D\n document.addEventListener('keydown', function(e) {\n if (e.altKey && e.shiftKey && e.key === 'D') {\n e.preventDefault();\n enabled = !enabled;\n if (enabled) {\n applyDarkMode();\n console.log('[Universal Dark Mode] Enabled');\n } else {\n removeDarkMode();\n console.log('[Universal Dark Mode] Disabled');\n }\n }\n });\n \n // Apply on load\n applyDarkMode();\n \n // Re-apply on dynamic content\n var observer = new MutationObserver(function(mutations) {\n if (enabled && !document.getElementById('universal-dark-mode-style')) {\n applyDarkMode();\n }\n });\n observer.observe(document.head, { childList: true });\n \n console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');\n})();", "Universal Dark Mode");
}
} catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); }
})();
})();

Skip to content
move SocketTaskExtensions methods to Socket class - #45083
Merged
geoffkizer merged 4 commits into
dotnet:masterfrom 
geoffkizer:movesockettaskextensions
Dec 30, 2020
Merged
move SocketTaskExtensions methods to Socket class#45083
geoffkizer merged 4 commits into
dotnet:masterfrom 
geoffkizer:movesockettaskextensions
Conversation
@geoffkizer
@geoffkizergeoffkizer
commented
Nov 22, 2020

Copy link


Copy Markdown

Contributor
@geoffkizergeoffkizer
added this to the 6.0.0 milestone
Nov 22, 2020
@ghost
ghost
commented
Nov 22, 2020

Copy link


Copy Markdown

Tagging subscribers to this area: @dotnet/ncl

See info in area-owners.md if you want to be subscribed.
Issue Details
Fixes #43901
@antonfirsov@stephentoub @dotnet/ncl
Author:geoffkizer
Assignees:-
Labels:
area-System.Net.Sockets
Milestone:6.0.0
@Dotnet-GitSync-Bot
Dotnet-GitSync-Bot
commented
Nov 22, 2020

Copy link


Copy Markdown

Collaborator
Note regarding the new-api-needs-documentation label:
This serves as a reminder for when your PR is modifying a ref *.cs file and adding/modifying public APIs, to please make sure the API implementation in the src *.cs file is documented with triple slash comments, so the PR reviewers can sign off that change.
@geoffkizer
geoffkizer
commented
Nov 22, 2020

Copy link


Copy Markdown

ContributorAuthor
/azp run runtime-libraries-coreclr outerloop
@azure-pipelines
azure-pipelinesBot
commented
Nov 22, 2020

Copy link


Copy Markdown


Azure Pipelines successfully started running 1 pipeline(s).
antonfirsov
antonfirsov
reviewed
Nov 23, 2020
View reviewed changes
Comment threadsrc/libraries/System.Net.Sockets/ref/System.Net.Sockets.cs
Outdated


Comment on lines

+402
 to 
+420

 public System.Threading.Tasks.Task<System.Net.Sockets.Socket> AcceptAsync() { throw null; }
 public System.Threading.Tasks.Task<System.Net.Sockets.Socket> AcceptAsync(System.Net.Sockets.Socket? acceptSocket) { throw null; }
 public System.Threading.Tasks.Task ConnectAsync(System.Net.EndPoint remoteEP) { throw null; }
 public System.Threading.Tasks.ValueTask ConnectAsync(System.Net.EndPoint remoteEP, System.Threading.CancellationToken cancellationToken) { throw null; }
 public System.Threading.Tasks.Task ConnectAsync(System.Net.IPAddress address, int port) { throw null; }
 public System.Threading.Tasks.ValueTask ConnectAsync(System.Net.IPAddress address, int port, System.Threading.CancellationToken cancellationToken) { throw null; }
 public System.Threading.Tasks.Task ConnectAsync(System.Net.IPAddress[] addresses, int port) { throw null; }
 public System.Threading.Tasks.ValueTask ConnectAsync(System.Net.IPAddress[] addresses, int port, System.Threading.CancellationToken cancellationToken) { throw null; }
 public System.Threading.Tasks.Task ConnectAsync(string host, int port) { throw null; }
 public System.Threading.Tasks.ValueTask ConnectAsync(string host, int port, System.Threading.CancellationToken cancellationToken) { throw null; }
 public System.Threading.Tasks.Task<int> ReceiveAsync(System.ArraySegment<byte> buffer, System.Net.Sockets.SocketFlags socketFlags) { throw null; }
 public System.Threading.Tasks.Task<int> ReceiveAsync(System.Collections.Generic.IList<System.ArraySegment<byte>> buffers, System.Net.Sockets.SocketFlags socketFlags) { throw null; }
 public System.Threading.Tasks.ValueTask<int> ReceiveAsync(System.Memory<byte> buffer, System.Net.Sockets.SocketFlags socketFlags, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) { throw null; }
 public System.Threading.Tasks.Task<System.Net.Sockets.SocketReceiveFromResult> ReceiveFromAsync(System.ArraySegment<byte> buffer, System.Net.Sockets.SocketFlags socketFlags, System.Net.EndPoint remoteEndPoint) { throw null; }
 public System.Threading.Tasks.Task<System.Net.Sockets.SocketReceiveMessageFromResult> ReceiveMessageFromAsync(System.ArraySegment<byte> buffer, System.Net.Sockets.SocketFlags socketFlags, System.Net.EndPoint remoteEndPoint) { throw null; }
 public System.Threading.Tasks.Task<int> SendAsync(System.ArraySegment<byte> buffer, System.Net.Sockets.SocketFlags socketFlags) { throw null; }
 public System.Threading.Tasks.Task<int> SendAsync(System.Collections.Generic.IList<System.ArraySegment<byte>> buffers, System.Net.Sockets.SocketFlags socketFlags) { throw null; }
 public System.Threading.Tasks.ValueTask<int> SendAsync(System.ReadOnlyMemory<byte> buffer, System.Net.Sockets.SocketFlags socketFlags, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) { throw null; }
 public System.Threading.Tasks.Task<int> SendToAsync(System.ArraySegment<byte> buffer, System.Net.Sockets.SocketFlags socketFlags, System.Net.EndPoint remoteEP) { throw null; }
@antonfirsovantonfirsovNov 23, 2020

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I suppose the additions were manual. Shouldn't we at least do to the alphabetical ordering to reduce the number of conflicts in later PR-s with consolidation?
@geoffkizergeoffkizerNov 24, 2020

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sure, will do.
@runfoapprunfoappBot
mentioned this pull request
Nov 23, 2020

Closed

@antonfirsov
antonfirsov
commented
Nov 23, 2020

Copy link


Copy Markdown

Contributor
Coming from #44889 (comment) ... shouldn't we also add xmldocs in this PR?
@stephentoub
stephentoub
commented
Nov 23, 2020

Copy link


Copy Markdown

Member
shouldn't we also add xmldocs in this PR?
Yup
@geoffkizer
geoffkizer
commented
Nov 24, 2020

Copy link


Copy Markdown

ContributorAuthor
I suspect we already have docs for the extension methods, and we should just use them here.
@carlossanlop Do you know? What should be done in this PR to preserve existing docs, just move them to these instance methods?
@geoffkizer
geoffkizer
commented
Nov 24, 2020

Copy link


Copy Markdown

ContributorAuthor
/azp run runtime-libraries-coreclr outerloop
@azure-pipelines
azure-pipelinesBot
commented
Nov 24, 2020

Copy link


Copy Markdown


Azure Pipelines successfully started running 1 pipeline(s).
@carlossanlop
carlossanlop
commented
Nov 30, 2020

Copy link


Copy Markdown

Contributor
@geoffkizer@antonfirsov If documentation was already added somewhere else for the APIs that were made public in this PR, you can copy the triple slash comments on top of these newly public APIs.
@geoffkizer
geoffkizer
commented
Nov 30, 2020

Copy link


Copy Markdown

ContributorAuthor
@carlossanlop There are no triple-slash comments for the existing APIs.
@carlossanlop
carlossanlop
commented
Nov 30, 2020

Copy link


Copy Markdown

Contributor
@geoffkizer Ah, got it. Then please add new triple slash comments.
@geoffkizer
geoffkizer
commented
Dec 15, 2020

Copy link


Copy Markdown

ContributorAuthor
/azp run runtime-libraries-coreclr outerloop
@azure-pipelines
azure-pipelinesBot
commented
Dec 15, 2020

Copy link


Copy Markdown


Azure Pipelines successfully started running 1 pipeline(s).
@geoffkizer
geoffkizer
commented
Dec 15, 2020

Copy link


Copy Markdown

ContributorAuthor
Doc comments added.
@dotnet/ncl Can someone review?
@runfoapprunfoappBot
mentioned this pull request
Dec 15, 2020

Closed

antonfirsov
antonfirsov
reviewed
Dec 16, 2020
View reviewed changes
@antonfirsovantonfirsov
left a comment


Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If documentation text will be auto-generated, we should probably copy it from SocketTaskExtensions for consistency:
https://docs.microsoft.com/en-us/dotnet/api/system.net.sockets.sockettaskextensions.acceptasync?view=net-5.0#System_Net_Sockets_SocketTaskExtensions_AcceptAsync_System_Net_Sockets_Socket_
https://github.com/dotnet/dotnet-api-docs/blob/master/xml/System.Net.Sockets/SocketTaskExtensions.xml
Otherwise LGTM.
Comment threadsrc/libraries/System.Net.Sockets/src/System/Net/Sockets/Socket.Tasks.cs

 internal Task<Socket> AcceptAsync(Socket? acceptSocket)
 /// <summary>
 /// Accepts an incoming connection.
@antonfirsovantonfirsovDec 16, 2020•

edited by stephentoub

Loading

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.


Suggested change

/// Accepts an incoming connection.
/// Performs an asynchronous operation to accept an incoming connection attempt on the socket.
Comment threadsrc/libraries/System.Net.Sockets/src/System/Net/Sockets/Socket.Tasks.cs
 /// <summary>
 /// Accepts an incoming connection.
 /// </summary>
 /// <returns>An asynchronous task that completes with the accepted Socket.</returns>
@antonfirsovantonfirsovDec 16, 2020

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.


Suggested change

/// <returns>An asynchronous task that completes with the accepted Socket.</returns>
/// <returns>An asynchronous task that completes with a <see cref="T:System.Net.Sockets.Socket" /> to handle communication with the remote host.
Comment threadsrc/libraries/System.Net.Sockets/src/System/Net/Sockets/Socket.Tasks.cs
 public Task<Socket> AcceptAsync() => AcceptAsync((Socket?)null);

 /// <summary>
 /// Accepts an incoming connection.
@antonfirsovantonfirsovDec 16, 2020

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.


Suggested change

/// Accepts an incoming connection.
/// Performs an asynchronous operation on to accept an incoming connection attempt on the socket.
Comment threadsrc/libraries/System.Net.Sockets/src/System/Net/Sockets/Socket.Tasks.cs
 /// <summary>
 /// Accepts an incoming connection.
 /// </summary>
 /// <param name="acceptSocket">The socket to use for accepting the connection.</param>
@antonfirsovantonfirsovDec 16, 2020

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.


Suggested change

/// <param name="acceptSocket">The socket to use for accepting the connection.</param>
/// <param name="acceptSocket">The accepted Socket object. This value may be `null`.</param>
Comment threadsrc/libraries/System.Net.Sockets/src/System/Net/Sockets/Socket.Tasks.cs
 public Task ConnectAsync(IPAddress[] addresses, int port) => ConnectAsync(addresses, port, CancellationToken.None).AsTask();

 /// <summary>
 /// Establishes a connection to a remote host.
@antonfirsovantonfirsovDec 16, 2020

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Same for the rest ..
@geoffkizer
geoffkizer
commented
Dec 17, 2020

Copy link


Copy Markdown

ContributorAuthor
If documentation text will be auto-generated, we should probably copy it from SocketTaskExtensions for consistency:
I used that as a starting point for what I added and tried to improve/clarify parts.
@geoffkizer
geoffkizer
merged commit 9bb4bfe
into
dotnet:masterDec 30, 2020
@antonfirsovantonfirsov
mentioned this pull request
Jan 13, 2021
 Merged

@ghostghost
locked as resolved and limited conversation to collaborators
Jan 29, 2021
Sign up for freeto subscribe to this conversation on GitHub.
Already have an account?
Sign in.


Reviewers

@stephentoubstephentoubstephentoub approved these changes

+1 more reviewer

@antonfirsovantonfirsovantonfirsov approved these changes
Reviewers whose approvals may not affect merge requirements

Assignees


No one assigned


Labels

area-System.Net.Socketsnew-api-needs-documentation

Projects


None yet


Milestone

6.0.0

Development

Successfully merging this pull request may close these issues.

Move SocketTaskExtensions methods to Socket class itself


5 participants

@geoffkizer@Dotnet-GitSync-Bot@antonfirsov@stephentoub@carlossanlop