Skip to content

Commit e0ff280

Browse files
jozkeemairaw
authored andcommitted
Adding documentation for System.Net.WebSockets APIs released in 3.0 (#2830)
* Adding documentation for System.Net.WebSockets APIs released in 3.0 * Update ClientWebSocket.xml * Removing double spaces
1 parent d38a8d1 commit e0ff280

File tree

1 file changed

+47
-19
lines changed

1 file changed

+47
-19
lines changed

xml/System.Net.WebSockets/ClientWebSocket.xml

Lines changed: 47 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -433,7 +433,7 @@
433433
</Parameters>
434434
<Docs>
435435
<param name="buffer">The buffer to receive the response.</param>
436-
<param name="cancellationToken">A cancellation token used to propagate notification that this operation should be canceled.</param>
436+
<param name="cancellationToken">A cancellation token used to propagate notification that this operation should be canceled.</param>
437437
<summary>Receives data on <see cref="T:System.Net.WebSockets.ClientWebSocket" /> as an asynchronous operation.</summary>
438438
<returns>The task object representing the asynchronous operation.</returns>
439439
<remarks>
@@ -446,6 +446,8 @@
446446
447447
]]></format>
448448
</remarks>
449+
<exception cref="T:System.InvalidOperationException">The <see cref="T:System.Net.WebSockets.ClientWebSocket" /> is not connected.</exception>
450+
<exception cref="T:System.ObjectDisposedException">The <see cref="T:System.Net.WebSockets.ClientWebSocket" /> has been closed.</exception>
449451
</Docs>
450452
</Member>
451453
<Member MemberName="ReceiveAsync">
@@ -473,11 +475,22 @@
473475
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" Index="1" FrameworkAlternate="netcore-3.0" />
474476
</Parameters>
475477
<Docs>
476-
<param name="buffer">To be added.</param>
477-
<param name="cancellationToken">To be added.</param>
478-
<summary>To be added.</summary>
479-
<returns>To be added.</returns>
480-
<remarks>To be added.</remarks>
478+
<param name="buffer">The region of memory to receive the response.</param>
479+
<param name="cancellationToken">A cancellation token used to propagate notification that this operation should be canceled.</param>
480+
<summary>Receives data on <see cref="T:System.Net.WebSockets.ClientWebSocket" /> to a byte memory range as an asynchronous operation.</summary>
481+
<returns>The task object representing the asynchronous operation.</returns>
482+
<remarks>
483+
<format type="text/markdown"><![CDATA[
484+
485+
## Remarks
486+
This operation will not block. The returned <xref:System.Threading.Tasks.Task%601> object will complete after the receive request on the <xref:System.Net.WebSockets.ClientWebSocket> instance has completed.
487+
488+
Exactly one send and one receive is supported on each <xref:System.Net.WebSockets.ClientWebSocket> object in parallel.
489+
490+
]]></format>
491+
</remarks>
492+
<exception cref="T:System.InvalidOperationException">The <see cref="T:System.Net.WebSockets.ClientWebSocket" /> is not connected.</exception>
493+
<exception cref="T:System.ObjectDisposedException">The <see cref="T:System.Net.WebSockets.ClientWebSocket" /> has been closed.</exception>
481494
</Docs>
482495
</Member>
483496
<Member MemberName="SendAsync">
@@ -514,21 +527,24 @@
514527
</Parameters>
515528
<Docs>
516529
<param name="buffer">The buffer containing the message to be sent.</param>
517-
<param name="messageType">Specifies whether the buffer is clear text or in a binary format.</param>
518-
<param name="endOfMessage">Specifies whether this is the final asynchronous send. Set to <see langword="true" /> if this is the final send; <see langword="false" /> otherwise.</param>
519-
<param name="cancellationToken">A cancellation token used to propagate notification that this operation should be canceled.</param>
520-
<summary>Send data on <see cref="T:System.Net.WebSockets.ClientWebSocket" /> as an asynchronous operation.</summary>
530+
<param name="messageType">One of the enumeration values that specifies whether the buffer is clear text or in a binary format.</param>
531+
<param name="endOfMessage"><see langword="true" /> to indicate this is the final asynchronous send; otherwise, <see langword="false" />.</param>
532+
<param name="cancellationToken">A cancellation token used to propagate notification that this operation should be canceled.</param>
533+
<summary>Sends data on <see cref="T:System.Net.WebSockets.ClientWebSocket" /> as an asynchronous operation.</summary>
521534
<returns>The task object representing the asynchronous operation.</returns>
522535
<remarks>
523536
<format type="text/markdown"><![CDATA[
524537
525-
## Remarks
538+
## Remarks
539+
526540
This operation will not block. The returned <xref:System.Threading.Tasks.Task> object will complete after the send request on the <xref:System.Net.WebSockets.ClientWebSocket> instance has completed.
527541
528542
Exactly one send and one receive is supported on each <xref:System.Net.WebSockets.ClientWebSocket> object in parallel.
529543
530544
]]></format>
531545
</remarks>
546+
<exception cref="T:System.InvalidOperationException">The <see cref="T:System.Net.WebSockets.ClientWebSocket" /> is not connected.</exception>
547+
<exception cref="T:System.ObjectDisposedException">The <see cref="T:System.Net.WebSockets.ClientWebSocket" /> has been closed.</exception>
532548
</Docs>
533549
</Member>
534550
<Member MemberName="SendAsync">
@@ -558,13 +574,25 @@
558574
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" Index="3" FrameworkAlternate="netcore-3.0" />
559575
</Parameters>
560576
<Docs>
561-
<param name="buffer">To be added.</param>
562-
<param name="messageType">To be added.</param>
563-
<param name="endOfMessage">To be added.</param>
564-
<param name="cancellationToken">To be added.</param>
565-
<summary>To be added.</summary>
566-
<returns>To be added.</returns>
567-
<remarks>To be added.</remarks>
577+
<param name="buffer">The region of memory containing the message to be sent.</param>
578+
<param name="messageType">One of the enumeration values that specifies whether the buffer is clear text or in a binary format.</param>
579+
<param name="endOfMessage"><see langword="true" /> to indicate this is the final asynchronous send; otherwise, <see langword="false" />.</param>
580+
<param name="cancellationToken">A cancellation token used to propagate notification that this operation should be canceled.</param>
581+
<summary>Sends data on <see cref="T:System.Net.WebSockets.ClientWebSocket" /> from a read-only byte memory range as an asynchronous operation.</summary>
582+
<returns>The task object representing the asynchronous operation.</returns>
583+
<remarks>
584+
<format type="text/markdown"><![CDATA[
585+
586+
## Remarks
587+
588+
This operation will not block. The returned <xref:System.Threading.Tasks.Task> object will complete after the send request on the <xref:System.Net.WebSockets.ClientWebSocket> instance has completed.
589+
590+
Exactly one send and one receive is supported on each <xref:System.Net.WebSockets.ClientWebSocket> object in parallel.
591+
592+
]]></format>
593+
</remarks>
594+
<exception cref="T:System.InvalidOperationException">The <see cref="T:System.Net.WebSockets.ClientWebSocket" /> is not connected.</exception>
595+
<exception cref="T:System.ObjectDisposedException">The <see cref="T:System.Net.WebSockets.ClientWebSocket" /> has been closed.</exception>
568596
</Docs>
569597
</Member>
570598
<Member MemberName="State">
@@ -634,4 +662,4 @@
634662
</Docs>
635663
</Member>
636664
</Members>
637-
</Type>
665+
</Type>

0 commit comments

Comments
 (0)