From 540c04949260a3a215a003824824b4f93dc8c358 Mon Sep 17 00:00:00 2001 From: "Ahmet Ibrahim Aksoy (from Dev Box)" Date: Mon, 18 Sep 2023 16:20:07 +0200 Subject: [PATCH 01/13] Add Sockets namespace docs --- xml/System.Net.Sockets/Socket.xml | 52 +++++++++++-------- xml/System.Net.Sockets/TcpListener.xml | 2 +- .../UnixDomainSocketEndPoint.xml | 11 ++-- 3 files changed, 37 insertions(+), 28 deletions(-) diff --git a/xml/System.Net.Sockets/Socket.xml b/xml/System.Net.Sockets/Socket.xml index 2fe3b5a488c..eb333837f4d 100644 --- a/xml/System.Net.Sockets/Socket.xml +++ b/xml/System.Net.Sockets/Socket.xml @@ -9690,12 +9690,16 @@ If you're using a connectionless , - To be added. - To be added. - To be added. - To be added. - To be added. + A span of bytes that is the storage location for received data. + A bitwise combination of the values. + An , that will be updated with value of the remote peer. + Receives a datagram into the data buffer, using the specified , and stores the endpoint. + The number of bytes received. To be added. + + remoteEP is . + An error occurred when attempting to access the socket. + The has been closed. @@ -10296,12 +10300,12 @@ If you're using a connectionless , - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. + The buffer for the received data. + A bitwise combination of SocketFlags values that will be used when receiving the data. + An , that will be updated with value of the remote peer. + A cancellation token that can be used to signal the asynchronous operation should be canceled. + Receives data and returns the endpoint of the sending host. + An asynchronous task that completes with a containing the number of bytes received and the endpoint of the sending host. To be added. @@ -13408,12 +13412,16 @@ This member outputs trace information when you enable network tracing in your ap - To be added. - To be added. - To be added. - To be added. - To be added. + A span of bytes that contains the data to be sent. + A bitwise combination of the values. + The that represents the destination for the data. + Sends data to a specific endpoint using the specified . + The number of bytes sent. To be added. + + remoteEP is . + An error occurred when attempting to access the socket. + The has been closed. @@ -13984,12 +13992,12 @@ This member outputs trace information when you enable network tracing in your ap - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. + The buffer for the data to send. + A bitwise combination of SocketFlags values that will be used when sending the data. + The remote host to which to send the data. + A cancellation token that can be used to cancel the asynchronous operation. + Sends data to the specified remote host. + An asynchronous task that completes with the number of bytes sent. To be added. diff --git a/xml/System.Net.Sockets/TcpListener.xml b/xml/System.Net.Sockets/TcpListener.xml index ba4c529196c..94f29c68987 100644 --- a/xml/System.Net.Sockets/TcpListener.xml +++ b/xml/System.Net.Sockets/TcpListener.xml @@ -983,7 +983,7 @@ - To be added. + Releases all resources used by the current instance. To be added. diff --git a/xml/System.Net.Sockets/UnixDomainSocketEndPoint.xml b/xml/System.Net.Sockets/UnixDomainSocketEndPoint.xml index 9ada58d0c52..a3920f1f19e 100644 --- a/xml/System.Net.Sockets/UnixDomainSocketEndPoint.xml +++ b/xml/System.Net.Sockets/UnixDomainSocketEndPoint.xml @@ -167,9 +167,10 @@ - To be added. - To be added. - To be added. + The to compare with the current . + Determines whether the specified is equal to the current . + + if the specified is equal to the current ; otherwise, . To be added. @@ -193,8 +194,8 @@ - To be added. - To be added. + Returns a hash value for a instance. + An integer hash value. To be added. From 3dabac514429acfd162e28c8f4e3b91534e7800a Mon Sep 17 00:00:00 2001 From: "Ahmet Ibrahim Aksoy (from Dev Box)" Date: Mon, 18 Sep 2023 16:33:48 +0200 Subject: [PATCH 02/13] Add LingerOption docs --- xml/System.Net.Sockets/LingerOption.xml | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/xml/System.Net.Sockets/LingerOption.xml b/xml/System.Net.Sockets/LingerOption.xml index 6a99f1068f6..70a29fbc37b 100644 --- a/xml/System.Net.Sockets/LingerOption.xml +++ b/xml/System.Net.Sockets/LingerOption.xml @@ -230,9 +230,9 @@ - To be added. - To be added. - To be added. + The to compare with the current . + Determines whether the specified is equal to the current . + if the specified is equal to the current ; otherwise, . To be added. @@ -256,8 +256,8 @@ - To be added. - To be added. + Returns a hash value for a instance. + An integer hash value. To be added. From 404720fc1637ced11b79ea145198e09112046c3a Mon Sep 17 00:00:00 2001 From: "Ahmet Ibrahim Aksoy (from Dev Box)" Date: Mon, 18 Sep 2023 17:21:05 +0200 Subject: [PATCH 03/13] Fix LingerOption crefs --- xml/System.Net.Sockets/LingerOption.xml | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/xml/System.Net.Sockets/LingerOption.xml b/xml/System.Net.Sockets/LingerOption.xml index 70a29fbc37b..6c5e78c7b06 100644 --- a/xml/System.Net.Sockets/LingerOption.xml +++ b/xml/System.Net.Sockets/LingerOption.xml @@ -230,9 +230,9 @@ - The to compare with the current . - Determines whether the specified is equal to the current . - if the specified is equal to the current ; otherwise, . + The to compare with the current . + Determines whether the specified is equal to the current . + if the specified is equal to the current ; otherwise, . To be added. From 38d90783c39109c86a424791c3d34bbfb2897e76 Mon Sep 17 00:00:00 2001 From: "Ahmet Ibrahim Aksoy (from Dev Box)" Date: Mon, 18 Sep 2023 18:04:31 +0200 Subject: [PATCH 04/13] Fix cref --- xml/System.Net.Sockets/LingerOption.xml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/xml/System.Net.Sockets/LingerOption.xml b/xml/System.Net.Sockets/LingerOption.xml index 6c5e78c7b06..d1dd3dfad60 100644 --- a/xml/System.Net.Sockets/LingerOption.xml +++ b/xml/System.Net.Sockets/LingerOption.xml @@ -256,7 +256,7 @@ - Returns a hash value for a instance. + Returns a hash value for a instance. An integer hash value. To be added. From eea11238f8e8927a5db1988d5aee6ed85eda765b Mon Sep 17 00:00:00 2001 From: Ahmet Ibrahim Aksoy Date: Mon, 18 Sep 2023 18:26:06 +0200 Subject: [PATCH 05/13] Update xml/System.Net.Sockets/LingerOption.xml MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-authored-by: Carlos Sánchez López <1175054+carlossanlop@users.noreply.github.com> --- xml/System.Net.Sockets/LingerOption.xml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/xml/System.Net.Sockets/LingerOption.xml b/xml/System.Net.Sockets/LingerOption.xml index d1dd3dfad60..159df20a69b 100644 --- a/xml/System.Net.Sockets/LingerOption.xml +++ b/xml/System.Net.Sockets/LingerOption.xml @@ -230,7 +230,7 @@ - The to compare with the current . + The object to compare with the current instance. Determines whether the specified is equal to the current . if the specified is equal to the current ; otherwise, . To be added. From 0fbb4c8b166de141f8e6e6a8f5f738e846d57d2d Mon Sep 17 00:00:00 2001 From: Ahmet Ibrahim Aksoy Date: Mon, 18 Sep 2023 18:26:39 +0200 Subject: [PATCH 06/13] Update xml/System.Net.Sockets/LingerOption.xml MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-authored-by: Carlos Sánchez López <1175054+carlossanlop@users.noreply.github.com> --- xml/System.Net.Sockets/LingerOption.xml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/xml/System.Net.Sockets/LingerOption.xml b/xml/System.Net.Sockets/LingerOption.xml index 159df20a69b..9dc1ca6d695 100644 --- a/xml/System.Net.Sockets/LingerOption.xml +++ b/xml/System.Net.Sockets/LingerOption.xml @@ -231,7 +231,7 @@ The object to compare with the current instance. - Determines whether the specified is equal to the current . + Determines whether the specified object is equal to the current instance. if the specified is equal to the current ; otherwise, . To be added. From ca612a66be32b33c8f3fdcf3dacb596ea4e183c6 Mon Sep 17 00:00:00 2001 From: Ahmet Ibrahim Aksoy Date: Mon, 18 Sep 2023 18:26:45 +0200 Subject: [PATCH 07/13] Update xml/System.Net.Sockets/LingerOption.xml MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-authored-by: Carlos Sánchez López <1175054+carlossanlop@users.noreply.github.com> --- xml/System.Net.Sockets/LingerOption.xml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/xml/System.Net.Sockets/LingerOption.xml b/xml/System.Net.Sockets/LingerOption.xml index 9dc1ca6d695..e4bdc83a156 100644 --- a/xml/System.Net.Sockets/LingerOption.xml +++ b/xml/System.Net.Sockets/LingerOption.xml @@ -232,7 +232,7 @@ The object to compare with the current instance. Determines whether the specified object is equal to the current instance. - if the specified is equal to the current ; otherwise, . + if the specified object is equal to the current instance; otherwise, . To be added. From bbdee5f512eccd48d05f546639b4fb440574f04a Mon Sep 17 00:00:00 2001 From: Ahmet Ibrahim Aksoy Date: Mon, 18 Sep 2023 18:27:05 +0200 Subject: [PATCH 08/13] Update xml/System.Net.Sockets/UnixDomainSocketEndPoint.xml MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-authored-by: Carlos Sánchez López <1175054+carlossanlop@users.noreply.github.com> --- xml/System.Net.Sockets/UnixDomainSocketEndPoint.xml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/xml/System.Net.Sockets/UnixDomainSocketEndPoint.xml b/xml/System.Net.Sockets/UnixDomainSocketEndPoint.xml index a3920f1f19e..7b0308045c0 100644 --- a/xml/System.Net.Sockets/UnixDomainSocketEndPoint.xml +++ b/xml/System.Net.Sockets/UnixDomainSocketEndPoint.xml @@ -167,7 +167,7 @@ - The to compare with the current . + The object to compare with the current . Determines whether the specified is equal to the current . if the specified is equal to the current ; otherwise, . From 53605dc4051c51894e268ac8854e69bf4ee10327 Mon Sep 17 00:00:00 2001 From: Ahmet Ibrahim Aksoy Date: Mon, 18 Sep 2023 18:27:12 +0200 Subject: [PATCH 09/13] Update xml/System.Net.Sockets/UnixDomainSocketEndPoint.xml MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-authored-by: Carlos Sánchez López <1175054+carlossanlop@users.noreply.github.com> --- xml/System.Net.Sockets/UnixDomainSocketEndPoint.xml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/xml/System.Net.Sockets/UnixDomainSocketEndPoint.xml b/xml/System.Net.Sockets/UnixDomainSocketEndPoint.xml index 7b0308045c0..089bc8c2db0 100644 --- a/xml/System.Net.Sockets/UnixDomainSocketEndPoint.xml +++ b/xml/System.Net.Sockets/UnixDomainSocketEndPoint.xml @@ -170,7 +170,7 @@ The object to compare with the current . Determines whether the specified is equal to the current . - if the specified is equal to the current ; otherwise, . + if the specified object is equal to the current ; otherwise, . To be added. From aee44b282801d1f065db1d072458d2728415f14b Mon Sep 17 00:00:00 2001 From: Ahmet Ibrahim Aksoy Date: Mon, 18 Sep 2023 18:27:18 +0200 Subject: [PATCH 10/13] Update xml/System.Net.Sockets/UnixDomainSocketEndPoint.xml MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-authored-by: Carlos Sánchez López <1175054+carlossanlop@users.noreply.github.com> --- xml/System.Net.Sockets/UnixDomainSocketEndPoint.xml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/xml/System.Net.Sockets/UnixDomainSocketEndPoint.xml b/xml/System.Net.Sockets/UnixDomainSocketEndPoint.xml index 089bc8c2db0..d22f4cc77bc 100644 --- a/xml/System.Net.Sockets/UnixDomainSocketEndPoint.xml +++ b/xml/System.Net.Sockets/UnixDomainSocketEndPoint.xml @@ -168,7 +168,7 @@ The object to compare with the current . - Determines whether the specified is equal to the current . + Determines whether the specified object is equal to the current . if the specified object is equal to the current ; otherwise, . To be added. From 2d7e631fa5276fc534e267a50e4ab7adb98ad95e Mon Sep 17 00:00:00 2001 From: "Ahmet Ibrahim Aksoy (from Dev Box)" Date: Mon, 18 Sep 2023 19:12:57 +0200 Subject: [PATCH 11/13] Review feedback --- xml/System.Net.Sockets/Socket.xml | 28 ++++++++++++++++++---------- 1 file changed, 18 insertions(+), 10 deletions(-) diff --git a/xml/System.Net.Sockets/Socket.xml b/xml/System.Net.Sockets/Socket.xml index eb333837f4d..d31056b834b 100644 --- a/xml/System.Net.Sockets/Socket.xml +++ b/xml/System.Net.Sockets/Socket.xml @@ -9692,12 +9692,12 @@ If you're using a connectionless , A span of bytes that is the storage location for received data. A bitwise combination of the values. - An , that will be updated with value of the remote peer. + A instance that gets updated with the value of the remote peer when this method returns. Receives a datagram into the data buffer, using the specified , and stores the endpoint. The number of bytes received. To be added. - remoteEP is . + receivedAddress is . An error occurred when attempting to access the socket. The has been closed. @@ -10301,12 +10301,16 @@ If you're using a connectionless , The buffer for the received data. - A bitwise combination of SocketFlags values that will be used when receiving the data. - An , that will be updated with value of the remote peer. + A bitwise combination of the values that will be used when receiving the data. + A instance that gets updated with the value of the remote peer when this method returns. A cancellation token that can be used to signal the asynchronous operation should be canceled. - Receives data and returns the endpoint of the sending host. + Receives a datagram into the data buffer, using the specified , and stores the endpoint. An asynchronous task that completes with a containing the number of bytes received and the endpoint of the sending host. To be added. + + receivedAddress is . + An error occurred when attempting to access the socket. + The has been closed. @@ -13413,13 +13417,13 @@ This member outputs trace information when you enable network tracing in your ap A span of bytes that contains the data to be sent. - A bitwise combination of the values. + A bitwise combination of the values that will be used when sending the data. The that represents the destination for the data. Sends data to a specific endpoint using the specified . The number of bytes sent. To be added. - remoteEP is . + socketAddress is . An error occurred when attempting to access the socket. The has been closed. @@ -13993,12 +13997,16 @@ This member outputs trace information when you enable network tracing in your ap The buffer for the data to send. - A bitwise combination of SocketFlags values that will be used when sending the data. - The remote host to which to send the data. + A bitwise combination of values that will be used when sending the data. + The that represents the destination for the data. A cancellation token that can be used to cancel the asynchronous operation. - Sends data to the specified remote host. + Sends data to a specific endpoint using the specified . An asynchronous task that completes with the number of bytes sent. To be added. + + socketAddress is . + An error occurred when attempting to access the socket. + The has been closed. From d759bf551e66467f2d495d608838a3a5832eda0e Mon Sep 17 00:00:00 2001 From: "Ahmet Ibrahim Aksoy (from Dev Box)" Date: Mon, 18 Sep 2023 21:47:23 +0200 Subject: [PATCH 12/13] Review feedback --- xml/System.Net.Sockets/Socket.xml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/xml/System.Net.Sockets/Socket.xml b/xml/System.Net.Sockets/Socket.xml index d31056b834b..8b4dc088144 100644 --- a/xml/System.Net.Sockets/Socket.xml +++ b/xml/System.Net.Sockets/Socket.xml @@ -9697,7 +9697,7 @@ If you're using a connectionless , The number of bytes received. To be added. - receivedAddress is . + is . An error occurred when attempting to access the socket. The has been closed. @@ -13423,7 +13423,7 @@ This member outputs trace information when you enable network tracing in your ap The number of bytes sent. To be added. - socketAddress is . + is . An error occurred when attempting to access the socket. The has been closed. From f30bf1173e309fa90bba1b1b0c67e967730bf03f Mon Sep 17 00:00:00 2001 From: "Ahmet Ibrahim Aksoy (from Dev Box)" Date: Mon, 18 Sep 2023 21:49:23 +0200 Subject: [PATCH 13/13] Review feedback --- xml/System.Net.Sockets/Socket.xml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/xml/System.Net.Sockets/Socket.xml b/xml/System.Net.Sockets/Socket.xml index 8b4dc088144..02a9f54bceb 100644 --- a/xml/System.Net.Sockets/Socket.xml +++ b/xml/System.Net.Sockets/Socket.xml @@ -10308,7 +10308,7 @@ If you're using a connectionless , An asynchronous task that completes with a containing the number of bytes received and the endpoint of the sending host. To be added. - receivedAddress is . + is . An error occurred when attempting to access the socket. The has been closed. @@ -14004,7 +14004,7 @@ This member outputs trace information when you enable network tracing in your ap An asynchronous task that completes with the number of bytes sent. To be added. - socketAddress is . + is . An error occurred when attempting to access the socket. The has been closed.