Skip to content
Merged
Changes from all commits
Commits
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
8 changes: 4 additions & 4 deletions xml/System.Net.Sockets/Socket.xml
Original file line number Diff line number Diff line change
Expand Up @@ -8867,7 +8867,7 @@ If you're using a connectionless <xref:System.Net.Sockets.Socket>, <xref:System.
<Docs>
<param name="buffer">The buffer for the received data.</param>
<summary>Receives data from a connected socket.</summary>
<returns>A task that represents the asynchronous receive operation. The value of its <see cref="P:System.Threading.Tasks.Task`1.Result" /> property contains the total number of bytes read into <paramref name="buffer" /> between zero (0) and the number of bytes requested. The result value is zero (0) only if zero bytes were requested or if no more bytes are available because the peer socket performed a graceful shutdown. If zero bytes are requested, reeceive operations may complete immediately or may not complete until at least one byte is available (but without consuming any data).</returns>
<returns>A task that represents the asynchronous receive operation. The value of its <see cref="P:System.Threading.Tasks.Task`1.Result" /> property contains the total number of bytes read into <paramref name="buffer" /> between zero (0) and the number of bytes requested. The result value is zero (0) only if zero bytes were requested or if no more bytes are available because the peer socket performed a graceful shutdown. If zero bytes are requested, receive operations may complete immediately or may not complete until at least one byte is available (but without consuming any data).</returns>
<remarks>To be added.</remarks>
<exception cref="T:System.ObjectDisposedException">The <see cref="T:System.Net.Sockets.Socket" /> has been closed.</exception>
<exception cref="T:System.Net.Sockets.SocketException">An error occurred when attempting to access the socket.</exception>
Expand Down Expand Up @@ -8913,7 +8913,7 @@ If you're using a connectionless <xref:System.Net.Sockets.Socket>, <xref:System.
<Docs>
<param name="buffers">A list of buffers for the received data.</param>
<summary>Receives data from a connected socket.</summary>
<returns>A task that represents the asynchronous receive operation. The value of its <see cref="P:System.Threading.Tasks.Task`1.Result" /> property contains the total number of bytes read into the buffers between zero (0) and the number of bytes requested. The result value is zero (0) only if zero bytes were requested or if no more bytes are available because the peer socket performed a graceful shutdown. If zero bytes are requested, reeceive operations may complete immediately or may not complete until at least one byte is available (but without consuming any data).</returns>
<returns>A task that represents the asynchronous receive operation. The value of its <see cref="P:System.Threading.Tasks.Task`1.Result" /> property contains the total number of bytes read into the buffers between zero (0) and the number of bytes requested. The result value is zero (0) only if zero bytes were requested or if no more bytes are available because the peer socket performed a graceful shutdown. If zero bytes are requested, receive operations may complete immediately or may not complete until at least one byte is available (but without consuming any data).</returns>
<remarks>This method stores in the task it returns all non-usage exceptions that the method's synchronous counterpart can throw. If an exception is stored into the returned task, that exception will be thrown when the task is awaited. Usage exceptions, such as <see cref="T:System.ArgumentException" />, are still thrown synchronously. For the stored exceptions, see the exceptions thrown by <see cref="M:System.Net.Sockets.Socket.Receive(System.Collections.Generic.IList{System.ArraySegment{System.Byte}})" />.</remarks>
<exception cref="T:System.ArgumentNullException">The <paramref name="buffers" /> parameter was null.</exception>
<exception cref="T:System.ObjectDisposedException">The <see cref="T:System.Net.Sockets.Socket" /> has been closed.</exception>
Expand Down Expand Up @@ -9054,7 +9054,7 @@ If you're using a connectionless <xref:System.Net.Sockets.Socket>, <xref:System.
<param name="buffer">The buffer for the received data.</param>
<param name="socketFlags">A bitwise combination of SocketFlags values that will be used when receiving the data.</param>
<summary>Receives data from a connected socket.</summary>
<returns>A task that represents the asynchronous receive operation. The value of its <see cref="P:System.Threading.Tasks.Task`1.Result" /> property contains the total number of bytes read into <paramref name="buffer" /> between zero (0) and the number of bytes requested. The result value is zero (0) only if zero bytes were requested or if no more bytes are available because the peer socket performed a graceful shutdown. If zero bytes are requested, reeceive operations may complete immediately or may not complete until at least one byte is available (but without consuming any data).
<returns>A task that represents the asynchronous receive operation. The value of its <see cref="P:System.Threading.Tasks.Task`1.Result" /> property contains the total number of bytes read into <paramref name="buffer" /> between zero (0) and the number of bytes requested. The result value is zero (0) only if zero bytes were requested or if no more bytes are available because the peer socket performed a graceful shutdown. If zero bytes are requested, receive operations may complete immediately or may not complete until at least one byte is available (but without consuming any data).
</returns>
<remarks>To be added.</remarks>
<exception cref="T:System.ObjectDisposedException">The <see cref="T:System.Net.Sockets.Socket" /> has been closed.</exception>
Expand Down Expand Up @@ -9104,7 +9104,7 @@ If you're using a connectionless <xref:System.Net.Sockets.Socket>, <xref:System.
<param name="buffers">A list of buffers for the received data.</param>
<param name="socketFlags">A bitwise combination of SocketFlags values that will be used when receiving the data.</param>
<summary>Receives data from a connected socket.</summary>
<returns>A task that represents the asynchronous receive operation. The value of its <see cref="P:System.Threading.Tasks.Task`1.Result" /> property contains the total number of bytes read into <paramref name="buffer" /> between zero (0) and the number of bytes requested. The result value is zero (0) only if zero bytes were requested or if no more bytes are available because the peer socket performed a graceful shutdown. If zero bytes are requested, reeceive operations may complete immediately or may not complete until at least one byte is available (but without consuming any data).
<returns>A task that represents the asynchronous receive operation. The value of its <see cref="P:System.Threading.Tasks.Task`1.Result" /> property contains the total number of bytes read into <paramref name="buffer" /> between zero (0) and the number of bytes requested. The result value is zero (0) only if zero bytes were requested or if no more bytes are available because the peer socket performed a graceful shutdown. If zero bytes are requested, receive operations may complete immediately or may not complete until at least one byte is available (but without consuming any data).
</returns>
<remarks>This method stores in the task it returns all non-usage exceptions that the method's synchronous counterpart can throw. If an exception is stored into the returned task, that exception will be thrown when the task is awaited. Usage exceptions, such as <see cref="T:System.ArgumentException" />, are still thrown synchronously. For the stored exceptions, see the exceptions thrown by <see cref="M:System.Net.Sockets.Socket.Receive(System.Collections.Generic.IList{System.ArraySegment{System.Byte}},System.Net.Sockets.SocketFlags)" />.</remarks>
<exception cref="T:System.ArgumentNullException">The <paramref name="buffers" /> parameter was null.</exception>
Expand Down