You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: xml/System.Net.Sockets/Socket.xml
+4-4Lines changed: 4 additions & 4 deletions
Original file line number
Diff line number
Diff line change
@@ -8867,7 +8867,7 @@ If you're using a connectionless <xref:System.Net.Sockets.Socket>, <xref:System.
8867
8867
<Docs>
8868
8868
<param name="buffer">The buffer for the received data.</param>
8869
8869
<summary>Receives data from a connected socket.</summary>
8870
-
<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>
8870
+
<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>
8871
8871
<remarks>To be added.</remarks>
8872
8872
<exception cref="T:System.ObjectDisposedException">The <see cref="T:System.Net.Sockets.Socket" /> has been closed.</exception>
8873
8873
<exception cref="T:System.Net.Sockets.SocketException">An error occurred when attempting to access the socket.</exception>
@@ -8913,7 +8913,7 @@ If you're using a connectionless <xref:System.Net.Sockets.Socket>, <xref:System.
8913
8913
<Docs>
8914
8914
<param name="buffers">A list of buffers for the received data.</param>
8915
8915
<summary>Receives data from a connected socket.</summary>
8916
-
<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>
8916
+
<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>
8917
8917
<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>
8918
8918
<exception cref="T:System.ArgumentNullException">The <paramref name="buffers" /> parameter was null.</exception>
8919
8919
<exception cref="T:System.ObjectDisposedException">The <see cref="T:System.Net.Sockets.Socket" /> has been closed.</exception>
@@ -9054,7 +9054,7 @@ If you're using a connectionless <xref:System.Net.Sockets.Socket>, <xref:System.
9054
9054
<param name="buffer">The buffer for the received data.</param>
9055
9055
<param name="socketFlags">A bitwise combination of SocketFlags values that will be used when receiving the data.</param>
9056
9056
<summary>Receives data from a connected socket.</summary>
9057
-
<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).
9057
+
<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).
9058
9058
</returns>
9059
9059
<remarks>To be added.</remarks>
9060
9060
<exception cref="T:System.ObjectDisposedException">The <see cref="T:System.Net.Sockets.Socket" /> has been closed.</exception>
@@ -9104,7 +9104,7 @@ If you're using a connectionless <xref:System.Net.Sockets.Socket>, <xref:System.
9104
9104
<param name="buffers">A list of buffers for the received data.</param>
9105
9105
<param name="socketFlags">A bitwise combination of SocketFlags values that will be used when receiving the data.</param>
9106
9106
<summary>Receives data from a connected socket.</summary>
9107
-
<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).
9107
+
<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).
9108
9108
</returns>
9109
9109
<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>
9110
9110
<exception cref="T:System.ArgumentNullException">The <paramref name="buffers" /> parameter was null.</exception>
0 commit comments