From c465914d37b12a0dd1d36226d3322fa656a1b941 Mon Sep 17 00:00:00 2001 From: David Cantu Date: Thu, 25 Jul 2019 13:19:14 -0700 Subject: [PATCH 1/3] Adding documentation for System.Net.WebSockets APIs released in 3.0 --- xml/System.Net.WebSockets/ClientWebSocket.xml | 50 ++++++++++++++----- 1 file changed, 38 insertions(+), 12 deletions(-) diff --git a/xml/System.Net.WebSockets/ClientWebSocket.xml b/xml/System.Net.WebSockets/ClientWebSocket.xml index 432856a94c6..cbb6bfe8d2e 100644 --- a/xml/System.Net.WebSockets/ClientWebSocket.xml +++ b/xml/System.Net.WebSockets/ClientWebSocket.xml @@ -446,6 +446,8 @@ ]]> + The is not connected. + The has been closed. @@ -473,11 +475,22 @@ - To be added. - To be added. - To be added. - To be added. - To be added. + The region of memory to receive the response. + A cancellation token used to propagate notification that this operation should be canceled. + Receives data on to a byte memory range as an asynchronous operation. + The task object representing the asynchronous operation. + + object will complete after the receive request on the instance has completed. + + Exactly one send and one receive is supported on each object in parallel. + + ]]> + + The is not connected. + The has been closed. @@ -529,6 +542,8 @@ ]]> + The is not connected. + The has been closed. @@ -558,13 +573,24 @@ - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. + The region of memory containing the message to be sent. + Specifies whether the buffer is clear text or in a binary format. + Specifies whether this is the final asynchronous send. Set to if this is the final send; otherwise. + A cancellation token used to propagate notification that this operation should be canceled. + Send data on from a read-only byte memory range as an asynchronous operation. + The task object representing the asynchronous operation. + + object will complete after the send request on the instance has completed. + + Exactly one send and one receive is supported on each object in parallel. + + ]]> + + The is not connected. + The has been closed. From a782497ac5fe4faee88fd859b8004c9fd9143d1d Mon Sep 17 00:00:00 2001 From: Maira Wenzel Date: Thu, 25 Jul 2019 18:13:44 -0700 Subject: [PATCH 2/3] Update ClientWebSocket.xml --- xml/System.Net.WebSockets/ClientWebSocket.xml | 28 ++++++++++--------- 1 file changed, 15 insertions(+), 13 deletions(-) diff --git a/xml/System.Net.WebSockets/ClientWebSocket.xml b/xml/System.Net.WebSockets/ClientWebSocket.xml index cbb6bfe8d2e..1bf835aee1f 100644 --- a/xml/System.Net.WebSockets/ClientWebSocket.xml +++ b/xml/System.Net.WebSockets/ClientWebSocket.xml @@ -476,7 +476,7 @@ The region of memory to receive the response. - A cancellation token used to propagate notification that this operation should be canceled. + A cancellation token used to propagate notification that this operation should be canceled. Receives data on to a byte memory range as an asynchronous operation. The task object representing the asynchronous operation. @@ -527,15 +527,16 @@ The buffer containing the message to be sent. - Specifies whether the buffer is clear text or in a binary format. - Specifies whether this is the final asynchronous send. Set to if this is the final send; otherwise. - A cancellation token used to propagate notification that this operation should be canceled. - Send data on as an asynchronous operation. + One of the enumeration values that specifies whether the buffer is clear text or in a binary format. + to indicate this is the final asynchronous send; otherwise, . + A cancellation token used to propagate notification that this operation should be canceled. + Sends data on as an asynchronous operation. The task object representing the asynchronous operation. object will complete after the send request on the instance has completed. Exactly one send and one receive is supported on each object in parallel. @@ -574,18 +575,19 @@ The region of memory containing the message to be sent. - Specifies whether the buffer is clear text or in a binary format. - Specifies whether this is the final asynchronous send. Set to if this is the final send; otherwise. + One of the enumeration values that specifies whether the buffer is clear text or in a binary format. + to indicate this is the final asynchronous send; otherwise, . A cancellation token used to propagate notification that this operation should be canceled. - Send data on from a read-only byte memory range as an asynchronous operation. + Sends data on from a read-only byte memory range as an asynchronous operation. The task object representing the asynchronous operation. object will complete after the send request on the instance has completed. +## Remarks + +This operation will not block. The returned object will complete after the send request on the instance has completed. - Exactly one send and one receive is supported on each object in parallel. +Exactly one send and one receive is supported on each object in parallel. ]]> @@ -660,4 +662,4 @@ - \ No newline at end of file + From 11ba87a4372d8e3fbe4d88a699aa5a5d6ef1fb21 Mon Sep 17 00:00:00 2001 From: David Cantu Date: Thu, 25 Jul 2019 18:41:47 -0700 Subject: [PATCH 3/3] Removing double spaces --- xml/System.Net.WebSockets/ClientWebSocket.xml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/xml/System.Net.WebSockets/ClientWebSocket.xml b/xml/System.Net.WebSockets/ClientWebSocket.xml index 1bf835aee1f..7ddc2ce7a4e 100644 --- a/xml/System.Net.WebSockets/ClientWebSocket.xml +++ b/xml/System.Net.WebSockets/ClientWebSocket.xml @@ -433,7 +433,7 @@ The buffer to receive the response. - A cancellation token used to propagate notification that this operation should be canceled. + A cancellation token used to propagate notification that this operation should be canceled. Receives data on as an asynchronous operation. The task object representing the asynchronous operation. @@ -577,7 +577,7 @@ The region of memory containing the message to be sent. One of the enumeration values that specifies whether the buffer is clear text or in a binary format. to indicate this is the final asynchronous send; otherwise, . - A cancellation token used to propagate notification that this operation should be canceled. + A cancellation token used to propagate notification that this operation should be canceled. Sends data on from a read-only byte memory range as an asynchronous operation. The task object representing the asynchronous operation.