From c5b1b58f48235583d3508e67017a472f80514c8d Mon Sep 17 00:00:00 2001 From: Anton Firszov Date: Mon, 13 Sep 2021 16:19:46 +0200 Subject: [PATCH 1/4] add missing summaries --- xml/System.Net.Sockets/SendPacketsElement.xml | 14 +++++++------- xml/System.Net.Sockets/TcpListener.xml | 12 ++++++------ 2 files changed, 13 insertions(+), 13 deletions(-) diff --git a/xml/System.Net.Sockets/SendPacketsElement.xml b/xml/System.Net.Sockets/SendPacketsElement.xml index fa04207e747..0a1c62ec84d 100644 --- a/xml/System.Net.Sockets/SendPacketsElement.xml +++ b/xml/System.Net.Sockets/SendPacketsElement.xml @@ -163,8 +163,8 @@ - To be added. - To be added. + A of bytes to send using the method. + Initializes a new instance of the class using the specified buffer. To be added. @@ -244,9 +244,9 @@ - To be added. - To be added. - To be added. + A of bytes to send using the method. + Specifies that this element should not be combined with the next element in a single send request from the sockets layer to the transport. This flag is used for granular control of the content of each message on a datagram or message-oriented socket. + Initializes a new instance of the class using the specified buffer with an option to combine this element with the next element in a single send request from the sockets layer to the transport. To be added. @@ -927,8 +927,8 @@ System.Nullable<System.ReadOnlyMemory<System.Byte>> - To be added. - To be added. + Gets the buffer to be sent if the object was initialized with a buffer parameter. + The of bytes to be sent if the object was initialized with a buffer parameter. To be added. diff --git a/xml/System.Net.Sockets/TcpListener.xml b/xml/System.Net.Sockets/TcpListener.xml index 453f90f8671..4d34aa6185e 100644 --- a/xml/System.Net.Sockets/TcpListener.xml +++ b/xml/System.Net.Sockets/TcpListener.xml @@ -423,9 +423,9 @@ - To be added. - To be added. - To be added. + A cancellation token that can be used to cancel the asynchronous operation. + Accepts a pending connection request as a cancellable asynchronous operation. + The task object representing the asynchronous operation. The property on the task object returns a used to send and receive data. To be added. @@ -571,9 +571,9 @@ - To be added. - To be added. - To be added. + A cancellation token that can be used to cancel the asynchronous operation + Accepts a pending connection request as a cancellable asynchronous operation. + The task object representing the asynchronous operation. The property on the task object returns a used to send and receive data. To be added. From ad706109953873a073acbf7b28e1d24f86924d3d Mon Sep 17 00:00:00 2001 From: Anton Firszov Date: Mon, 13 Sep 2021 16:35:58 +0200 Subject: [PATCH 2/4] SendPacketsElement remarks --- xml/System.Net.Sockets/SendPacketsElement.xml | 32 ++++++++++++++++--- 1 file changed, 28 insertions(+), 4 deletions(-) diff --git a/xml/System.Net.Sockets/SendPacketsElement.xml b/xml/System.Net.Sockets/SendPacketsElement.xml index 0a1c62ec84d..ec203abb021 100644 --- a/xml/System.Net.Sockets/SendPacketsElement.xml +++ b/xml/System.Net.Sockets/SendPacketsElement.xml @@ -165,7 +165,14 @@ A of bytes to send using the method. Initializes a new instance of the class using the specified buffer. - To be added. + + class is used with the property to get or set a data buffer or file to be sent using the method. + + ]]> + @@ -247,7 +254,14 @@ A of bytes to send using the method. Specifies that this element should not be combined with the next element in a single send request from the sockets layer to the transport. This flag is used for granular control of the content of each message on a datagram or message-oriented socket. Initializes a new instance of the class using the specified buffer with an option to combine this element with the next element in a single send request from the sockets layer to the transport. - To be added. + + class is used with the property to get or set a data buffer or file to be sent using the method. + + ]]> + @@ -717,7 +731,9 @@ property is `null` if the object was not initialized with a `buffer` parameter. + The default value for the property is `null` if the object was not initialized with a `buffer` parameter or `buffer` was passed as a of bytes. + + In the latter case, the byte buffer shall be obtained using the property. ]]> @@ -929,7 +945,15 @@ Gets the buffer to be sent if the object was initialized with a buffer parameter. The of bytes to be sent if the object was initialized with a buffer parameter. - To be added. + + property is `null` if the object was not initialized with a `buffer` parameter. + If `buffer` was passed as a `byte[]`, returns the contents of as a of bytes. + + ]]> + From bc88be17853e75ba57e01a6ed9ccd73e875ba63a Mon Sep 17 00:00:00 2001 From: Anton Firszov Date: Mon, 13 Sep 2021 16:42:13 +0200 Subject: [PATCH 3/4] add TcpListener remarks --- xml/System.Net.Sockets/TcpListener.xml | 28 ++++++++++++++++++++++++-- 1 file changed, 26 insertions(+), 2 deletions(-) diff --git a/xml/System.Net.Sockets/TcpListener.xml b/xml/System.Net.Sockets/TcpListener.xml index 4d34aa6185e..188aae6939f 100644 --- a/xml/System.Net.Sockets/TcpListener.xml +++ b/xml/System.Net.Sockets/TcpListener.xml @@ -426,7 +426,19 @@ A cancellation token that can be used to cancel the asynchronous operation. Accepts a pending connection request as a cancellable asynchronous operation. The task object representing the asynchronous operation. The property on the task object returns a used to send and receive data. - To be added. + + object will complete after the socket connection has been accepted. + + The returned in is initialized with the IP address and port number of the remote host. You can use any of the and methods available in the class to communicate with the remote host. When you are finished using the , be sure to call its method. If your application is relatively simple, consider using the method rather than the method. provides you with simple methods for sending and receiving data over a network in blocking synchronous mode. + +> [!NOTE] +> This member outputs trace information when you enable network tracing in your application. For more information, see [Network Tracing in the .NET Framework](/dotnet/framework/network-programming/network-tracing). + + ]]> + @@ -574,7 +586,19 @@ A cancellation token that can be used to cancel the asynchronous operation Accepts a pending connection request as a cancellable asynchronous operation. The task object representing the asynchronous operation. The property on the task object returns a used to send and receive data. - To be added. + + object will complete after the TCP connection has been accepted. + + Use the method to obtain the underlying of the returned in the . The will provide you with methods for sending and receiving with the remote host. When you are through with the , be sure to call its method. If you want greater flexibility than a offers, consider using or . + +> [!NOTE] +> This member outputs trace information when you enable network tracing in your application. For more information, see [Network Tracing in the .NET Framework](/dotnet/framework/network-programming/network-tracing). + + ]]> + From e44ff2b880258ab4d6fa9990912b7b4011cb6fe2 Mon Sep 17 00:00:00 2001 From: Anton Firszov Date: Mon, 13 Sep 2021 17:21:06 +0200 Subject: [PATCH 4/4] fix Buffer remarks --- xml/System.Net.Sockets/SendPacketsElement.xml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/xml/System.Net.Sockets/SendPacketsElement.xml b/xml/System.Net.Sockets/SendPacketsElement.xml index ec203abb021..f7c0fff1f55 100644 --- a/xml/System.Net.Sockets/SendPacketsElement.xml +++ b/xml/System.Net.Sockets/SendPacketsElement.xml @@ -733,7 +733,7 @@ ## Remarks The default value for the property is `null` if the object was not initialized with a `buffer` parameter or `buffer` was passed as a of bytes. - In the latter case, the byte buffer shall be obtained using the property. + In the latter case, the buffer can be obtained using the property. ]]>