Skip to content

Adding documentation for System.Net.WebSockets APIs released in 3.0 #2830

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

Merged
merged 3 commits into from
Jul 26, 2019
Merged

Adding documentation for System.Net.WebSockets APIs released in 3.0 #2830

Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
c465914
Adding documentation for System.Net.WebSockets APIs released in 3.0
jozkee Jul 25, 2019
a782497
Update ClientWebSocket.xml
mairaw Jul 26, 2019
11ba87a
Removing double spaces
jozkee Jul 26, 2019
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
50 changes: 38 additions & 12 deletions xml/System.Net.WebSockets/ClientWebSocket.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -446,6 +446,8 @@

]]></format>
</remarks>
<exception cref="T:System.InvalidOperationException">The <see cref="T:System.Net.WebSockets.ClientWebSocket" /> is not connected.</exception>
<exception cref="T:System.ObjectDisposedException">The <see cref="T:System.Net.WebSockets.ClientWebSocket" /> has been closed.</exception>
</Docs>
</Member>
<Member MemberName="ReceiveAsync">
Expand Down Expand Up @@ -473,11 +475,22 @@
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" Index="1" FrameworkAlternate="netcore-3.0" />
</Parameters>
<Docs>
<param name="buffer">To be added.</param>
<param name="cancellationToken">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<param name="buffer">The region of memory to receive the response.</param>
<param name="cancellationToken">A cancellation token used to propagate notification that this operation should be canceled.</param>
<summary>Receives data on <see cref="T:System.Net.WebSockets.ClientWebSocket" /> to a byte memory range as an asynchronous operation.</summary>
<returns>The task object representing the asynchronous operation.</returns>
<remarks>
<format type="text/markdown"><![CDATA[

## Remarks
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.

Exactly one send and one receive is supported on each <xref:System.Net.WebSockets.ClientWebSocket> object in parallel.

]]></format>
</remarks>
<exception cref="T:System.InvalidOperationException">The <see cref="T:System.Net.WebSockets.ClientWebSocket" /> is not connected.</exception>
<exception cref="T:System.ObjectDisposedException">The <see cref="T:System.Net.WebSockets.ClientWebSocket" /> has been closed.</exception>
</Docs>
</Member>
<Member MemberName="SendAsync">
Expand Down Expand Up @@ -529,6 +542,8 @@

]]></format>
</remarks>
<exception cref="T:System.InvalidOperationException">The <see cref="T:System.Net.WebSockets.ClientWebSocket" /> is not connected.</exception>
<exception cref="T:System.ObjectDisposedException">The <see cref="T:System.Net.WebSockets.ClientWebSocket" /> has been closed.</exception>
</Docs>
</Member>
<Member MemberName="SendAsync">
Expand Down Expand Up @@ -558,13 +573,24 @@
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" Index="3" FrameworkAlternate="netcore-3.0" />
</Parameters>
<Docs>
<param name="buffer">To be added.</param>
<param name="messageType">To be added.</param>
<param name="endOfMessage">To be added.</param>
<param name="cancellationToken">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<param name="buffer">The region of memory containing the message to be sent.</param>
<param name="messageType">Specifies whether the buffer is clear text or in a binary format.</param>
<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>
<param name="cancellationToken">A cancellation token used to propagate notification that this operation should be canceled.</param>
<summary>Send data on <see cref="T:System.Net.WebSockets.ClientWebSocket" /> from a read-only byte memory range as an asynchronous operation.</summary>
<returns>The task object representing the asynchronous operation.</returns>
<remarks>
<format type="text/markdown"><![CDATA[

## Remarks
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.

Exactly one send and one receive is supported on each <xref:System.Net.WebSockets.ClientWebSocket> object in parallel.

]]></format>
</remarks>
<exception cref="T:System.InvalidOperationException">The <see cref="T:System.Net.WebSockets.ClientWebSocket" /> is not connected.</exception>
<exception cref="T:System.ObjectDisposedException">The <see cref="T:System.Net.WebSockets.ClientWebSocket" /> has been closed.</exception>
</Docs>
</Member>
<Member MemberName="State">
Expand Down