Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Port System.Net.Sockets APIs #9303

Merged
merged 13 commits into from
Sep 18, 2023
Merged

Port System.Net.Sockets APIs #9303

Show file tree
Hide file tree
Changes from 4 commits
Commits
Show all changes
13 commits
Select commit Hold shift + click to select a range
540c049
Add Sockets namespace docs
liveans Sep 18, 2023
3dabac5
Add LingerOption docs
liveans Sep 18, 2023
404720f
Fix LingerOption crefs
liveans Sep 18, 2023
38d9078
Fix cref
liveans Sep 18, 2023
eea1123
Update xml/System.Net.Sockets/LingerOption.xml
liveans Sep 18, 2023
0fbb4c8
Update xml/System.Net.Sockets/LingerOption.xml
liveans Sep 18, 2023
ca612a6
Update xml/System.Net.Sockets/LingerOption.xml
liveans Sep 18, 2023
bbdee5f
Update xml/System.Net.Sockets/UnixDomainSocketEndPoint.xml
liveans Sep 18, 2023
53605dc
Update xml/System.Net.Sockets/UnixDomainSocketEndPoint.xml
liveans Sep 18, 2023
aee44b2
Update xml/System.Net.Sockets/UnixDomainSocketEndPoint.xml
liveans Sep 18, 2023
2d7e631
Review feedback
liveans Sep 18, 2023
d759bf5
Review feedback
liveans Sep 18, 2023
f30bf11
Review feedback
liveans Sep 18, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 5 additions & 5 deletions xml/System.Net.Sockets/LingerOption.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -230,9 +230,9 @@
<Parameter Name="comparand" Type="System.Object" Index="0" FrameworkAlternate="net-8.0" />
</Parameters>
<Docs>
<param name="comparand">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<param name="comparand">The <see cref="T:System.Object"/> to compare with the current <see cref="T:System.Net.Sockets.LingerOption"/>.</param>
liveans marked this conversation as resolved.
Show resolved Hide resolved
<summary>Determines whether the specified <see cref="T:System.Object"/> is equal to the current <see cref="T:System.Net.Sockets.LingerOption"/>.</summary>
liveans marked this conversation as resolved.
Show resolved Hide resolved
<returns><see langword="true"/> if the specified <see cref="T:System.Object"/> is equal to the current <see cref="T:System.Net.Sockets.LingerOption"/>; otherwise, <see langword="false"/>.</returns>
liveans marked this conversation as resolved.
Show resolved Hide resolved
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand All @@ -256,8 +256,8 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added.</summary>
<returns>To be added.</returns>
<summary>Returns a hash value for a <see cref="T:System.Net.Sockets.LingerOption"/> instance.</summary>
<returns>An integer hash value.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand Down
52 changes: 30 additions & 22 deletions xml/System.Net.Sockets/Socket.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9690,12 +9690,16 @@ If you're using a connectionless <xref:System.Net.Sockets.Socket>, <xref:System.
</Parameter>
</Parameters>
<Docs>
<param name="buffer">To be added.</param>
<param name="socketFlags">To be added.</param>
<param name="receivedAddress">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<param name="buffer">A span of bytes that is the storage location for received data.</param>
<param name="socketFlags">A bitwise combination of the <see cref="T:System.Net.Sockets.SocketFlags" /> values.</param>
<param name="receivedAddress">An <see cref="T:System.Net.SocketAddress" />, that will be updated with value of the remote peer.</param>
liveans marked this conversation as resolved.
Show resolved Hide resolved
<summary>Receives a datagram into the data buffer, using the specified <see cref="T:System.Net.Sockets.SocketFlags" />, and stores the endpoint.</summary>
<returns>The number of bytes received.</returns>
<remarks>To be added.</remarks>
<exception cref="T:System.ArgumentNullException">
<c>remoteEP</c> is <see langword="null" />.</exception>
liveans marked this conversation as resolved.
Show resolved Hide resolved
liveans marked this conversation as resolved.
Show resolved Hide resolved
<exception cref="T:System.Net.Sockets.SocketException">An error occurred when attempting to access the socket.</exception>
<exception cref="T:System.ObjectDisposedException">The <see cref="T:System.Net.Sockets.Socket" /> has been closed.</exception>
</Docs>
</Member>
<Member MemberName="ReceiveFrom">
Expand Down Expand Up @@ -10296,12 +10300,12 @@ If you're using a connectionless <xref:System.Net.Sockets.Socket>, <xref:System.
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" Index="3" FrameworkAlternate="net-8.0" />
</Parameters>
<Docs>
<param name="buffer">To be added.</param>
<param name="socketFlags">To be added.</param>
<param name="receivedAddress">To be added.</param>
<param name="cancellationToken">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<param name="buffer">The buffer for the received data.</param>
<param name="socketFlags">A bitwise combination of SocketFlags values that will be used when receiving the data.</param>
<param name="receivedAddress">An <see cref="T:System.Net.SocketAddress" />, that will be updated with value of the remote peer.</param>
<param name="cancellationToken">A cancellation token that can be used to signal the asynchronous operation should be canceled.</param>
<summary>Receives data and returns the endpoint of the sending host.</summary>
carlossanlop marked this conversation as resolved.
Show resolved Hide resolved
<returns>An asynchronous task that completes with a <see cref="T:System.Net.Sockets.SocketReceiveFromResult" /> containing the number of bytes received and the endpoint of the sending host.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand Down Expand Up @@ -13408,12 +13412,16 @@ This member outputs trace information when you enable network tracing in your ap
</Parameter>
</Parameters>
<Docs>
<param name="buffer">To be added.</param>
<param name="socketFlags">To be added.</param>
<param name="socketAddress">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<param name="buffer">A span of bytes that contains the data to be sent.</param>
<param name="socketFlags">A bitwise combination of the <see cref="T:System.Net.Sockets.SocketFlags" /> values.</param>
<param name="socketAddress">The <see cref="T:System.Net.SocketAddress" /> that represents the destination for the data.</param>
<summary>Sends data to a specific endpoint using the specified <see cref="T:System.Net.Sockets.SocketFlags" />.</summary>
<returns>The number of bytes sent.</returns>
<remarks>To be added.</remarks>
<exception cref="T:System.ArgumentNullException">
<c>remoteEP</c> is <see langword="null" />.</exception>
liveans marked this conversation as resolved.
Show resolved Hide resolved
<exception cref="T:System.Net.Sockets.SocketException">An error occurred when attempting to access the socket.</exception>
<exception cref="T:System.ObjectDisposedException">The <see cref="T:System.Net.Sockets.Socket" /> has been closed.</exception>
</Docs>
</Member>
liveans marked this conversation as resolved.
Show resolved Hide resolved
<Member MemberName="SendTo">
Expand Down Expand Up @@ -13984,12 +13992,12 @@ This member outputs trace information when you enable network tracing in your ap
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" Index="3" FrameworkAlternate="net-8.0" />
</Parameters>
<Docs>
<param name="buffer">To be added.</param>
<param name="socketFlags">To be added.</param>
<param name="socketAddress">To be added.</param>
<param name="cancellationToken">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<param name="buffer">The buffer for the data to send.</param>
<param name="socketFlags">A bitwise combination of SocketFlags values that will be used when sending the data.</param>
<param name="socketAddress">The remote host to which to send the data.</param>
carlossanlop marked this conversation as resolved.
Show resolved Hide resolved
<param name="cancellationToken">A cancellation token that can be used to cancel the asynchronous operation.</param>
<summary>Sends data to the specified remote host.</summary>
<returns>An asynchronous task that completes with the number of bytes sent.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand Down
2 changes: 1 addition & 1 deletion xml/System.Net.Sockets/TcpListener.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -983,7 +983,7 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added.</summary>
<summary>Releases all resources used by the current <see cref="T:System.Net.Sockets.TcpListener" /> instance.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand Down
11 changes: 6 additions & 5 deletions xml/System.Net.Sockets/UnixDomainSocketEndPoint.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -167,9 +167,10 @@
</Parameter>
</Parameters>
<Docs>
<param name="obj">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<param name="obj">The <see cref="T:System.Object" /> to compare with the current <see cref="T:System.Net.Sockets.UnixDomainSocketEndPoint" />.</param>
liveans marked this conversation as resolved.
Show resolved Hide resolved
<summary>Determines whether the specified <see cref="T:System.Object" /> is equal to the current <see cref="T:System.Net.Sockets.UnixDomainSocketEndPoint" />.</summary>
liveans marked this conversation as resolved.
Show resolved Hide resolved
<returns>
<see langword="true" /> if the specified <see cref="T:System.Object" /> is equal to the current <see cref="T:System.Net.Sockets.UnixDomainSocketEndPoint" />; otherwise, <see langword="false" />.</returns>
liveans marked this conversation as resolved.
Show resolved Hide resolved
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand All @@ -193,8 +194,8 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added.</summary>
<returns>To be added.</returns>
<summary>Returns a hash value for a <see cref="T:System.Net.Sockets.UnixDomainSocketEndPoint" /> instance.</summary>
<returns>An integer hash value.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand Down