diff --git a/xml/System.Net.Sockets/NetworkStream.xml b/xml/System.Net.Sockets/NetworkStream.xml index cc06499f472..7537c62e4fa 100644 --- a/xml/System.Net.Sockets/NetworkStream.xml +++ b/xml/System.Net.Sockets/NetworkStream.xml @@ -1107,7 +1107,7 @@ The Close method frees both unmanaged and managed resources associated with the An that represents an asynchronous call. Handles the end of an asynchronous read. - The number of bytes read from the . + The number of bytes read from the , between zero (0) and the number of bytes requested. The method returns 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, read operations might complete immediately or might not complete until at least one byte is available (but without consuming any data). A region of memory to store data read from the . Reads data from the and stores it to a span of bytes in memory. - The number of bytes read from the . + The total number of bytes read into the buffer, between zero (0) and the length of the buffer. The method returns zero (0) only if zero bytes were requested or if no more bytes are available because the peer socket performed a graceful shutdown. The number of bytes to read from the . The number of bytes to read from the . Reads data from the and stores it to a byte array. - The number of bytes read from the . + The total number of bytes read into the buffer between zero (0) and the requested count. The method returns zero (0) only if zero bytes were requested or if no more bytes are available because the peer socket performed a graceful shutdown. The buffer to write the data to. The token to monitor for cancellation requests. Reads data from the and stores it in a byte memory range as an asynchronous operation. - A that represents the asynchronous read operation. The value of its property contains the total number of bytes read into . + A that represents the asynchronous read operation. The value of its property contains the total number of bytes read into 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, read operations may complete immediately or may not complete until at least one byte is available (but without consuming any data). The number of bytes to read from the . The token to monitor for cancellation requests. Reads data from the and stores it to a specified range of a byte array as an asynchronous operation. - A task that represents the asynchronous read operation. The value of its property contains the total number of bytes read into . + A task that represents the asynchronous read operation. The value of its property contains the total number of bytes read into 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, read operations may complete immediately or may not complete until at least one byte is available (but without consuming any data). Reads a byte from the and advances the position within the stream by one byte, or returns -1 if at the end of the stream. - The unsigned byte cast to an , or -1 if at the end of the stream. + The unsigned byte cast to an , or -1 if at the end of the stream because the peer socket performed a graceful shutdown. An that stores state information and any user defined data for this asynchronous operation. Ends a pending asynchronous read. - The number of bytes received. + The total number of bytes received. The method returns 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). An that stores state information and any user defined data for this asynchronous operation. A object that stores the socket error. Ends a pending asynchronous read. - The number of bytes received. + The total number of bytes received. The method returns 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). An array of type that is the storage location for the received data. Receives data from a bound into a receive buffer. - The number of bytes received. + The total number of bytes received. The method returns zero (0) only if zero bytes were requested or if no more bytes are available because the peer socket performed a graceful shutdown. A list of s of type that contains the received data. Receives data from a bound into the list of receive buffers. - The number of bytes received. + The total number of bytes received. The method returns zero (0) only if zero bytes were requested or if no more bytes are available because the peer socket performed a graceful shutdown. A span of bytes that is the storage location for the received data. Receives data from a bound into a receive buffer. - The number of bytes received. + The total number of bytes received. The method returns zero (0) only if zero bytes were requested or if no more bytes are available because the peer socket performed a graceful shutdown. An array of type that is the storage location for the received data. A bitwise combination of the values. Receives data from a bound into a receive buffer, using the specified . - The number of bytes received. + The total number of bytes received. The method returns zero (0) only if zero bytes were requested or if no more bytes are available because the peer socket performed a graceful shutdown. A list of s of type that contains the received data. A bitwise combination of the values. Receives data from a bound into the list of receive buffers, using the specified . - The number of bytes received. + The total number of bytes received. The method returns zero (0) only if zero bytes were requested or if no more bytes are available because the peer socket performed a graceful shutdown. A span of bytes that is the storage location for the received data. A bitwise combination of the enumeration values that specifies send and receive behaviors. Receives data from a bound into a receive buffer, using the specified . - The number of bytes received. + The total number of bytes received. The method returns zero (0) only if zero bytes were requested or if no more bytes are available because the peer socket performed a graceful shutdown. The number of bytes to receive. A bitwise combination of the values. Receives the specified number of bytes of data from a bound into a receive buffer, using the specified . - The number of bytes received. + The total number of bytes received. The method returns zero (0) only if zero bytes were requested or if no more bytes are available because the peer socket performed a graceful shutdown. A bitwise combination of the values. A object that stores the socket error. Receives data from a bound into the list of receive buffers, using the specified . - The number of bytes received. + The total number of bytes received. The method returns zero (0) only if zero bytes were requested or if no more bytes are available because the peer socket performed a graceful shutdown. A bitwise combination of the enumeration values that specifies send and receive behaviors. When this method returns, contains one of the enumeration values that defines error codes for the socket. Receives data from a bound into a receive buffer, using the specified . - The number of bytes received. + The total number of bytes received. The method returns zero (0) only if zero bytes were requested or if no more bytes are available because the peer socket performed a graceful shutdown. , The number of bytes to receive. A bitwise combination of the values. Receives the specified number of bytes from a bound into the specified offset position of the receive buffer, using the specified . - The number of bytes received. + The total number of bytes received. The method returns zero (0) only if zero bytes were requested or if no more bytes are available because the peer socket performed a graceful shutdown. , A bitwise combination of the values. A object that stores the socket error. Receives data from a bound into a receive buffer, using the specified . - The number of bytes received. + The total number of bytes received. The method returns zero (0) only if zero bytes were requested or if no more bytes are available because the peer socket performed a graceful shutdown. , The buffer for the received data. Receives data from a connected socket. - An asynchronous task that completes with the number of bytes received. + A task that represents the asynchronous receive operation. The value of its property contains the total number of bytes read into 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). To be added. The has been closed. An error occurred when attempting to access the socket. @@ -8769,7 +8769,7 @@ If you're using a connectionless , A list of buffers for the received data. Receives data from a connected socket. - An asynchronous task that completes with the number of bytes received. + A task that represents the asynchronous receive operation. The value of its 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). 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 , are still thrown synchronously. For the stored exceptions, see the exceptions thrown by . The parameter was null. The has been closed. @@ -8902,7 +8902,8 @@ If you're using a connectionless , The buffer for the received data. A bitwise combination of SocketFlags values that will be used when receiving the data. Receives data from a connected socket. - An asynchronous task that completes with the number of bytes received. + A task that represents the asynchronous receive operation. The value of its property contains the total number of bytes read into 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). + To be added. The has been closed. An error occurred when attempting to access the socket. @@ -8950,7 +8951,8 @@ If you're using a connectionless , A list of buffers for the received data. A bitwise combination of SocketFlags values that will be used when receiving the data. Receives data from a connected socket. - An asynchronous task that completes with the number of bytes received. + A task that represents the asynchronous receive operation. The value of its property contains the total number of bytes read into 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). + 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 , are still thrown synchronously. For the stored exceptions, see the exceptions thrown by . The parameter was null. The has been closed. @@ -8990,7 +8992,7 @@ If you're using a connectionless , The buffer for the received data. A cancellation token that can be used to cancel the asynchronous operation. Receives data from a connected socket. - An asynchronous task that completes with the number of bytes received. + A that represents the asynchronous receive operation. The value of its property contains the total number of bytes read into 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). To be added. The has been closed. An error occurred when attempting to access the socket. @@ -9033,7 +9035,7 @@ If you're using a connectionless , A bitwise combination of SocketFlags values that will be used when receiving the data. A cancellation token that can be used to cancel the asynchronous operation. Receives data from a connected socket. - An asynchronous task that completes with the number of bytes received. + A that represents the asynchronous receive operation. The value of its property contains the total number of bytes read into 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). To be added. The has been closed. An error occurred when attempting to access the socket.