SslStream.ReadAsync Method
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Overloads
| ReadAsync(Memory<Byte>, CancellationToken) |
Asynchronously reads data from this stream and stores it in the specified memory range. |
| ReadAsync(Byte[], Int32, Int32, CancellationToken) |
Asynchronously reads data from this stream and stores it in the specified range of a byte array. |
ReadAsync(Memory<Byte>, CancellationToken)
- Source:
- SslStream.cs
- Source:
- SslStream.cs
- Source:
- SslStream.cs
Asynchronously reads data from this stream and stores it in the specified memory range.
public override System.Threading.Tasks.ValueTask<int> ReadAsync (Memory<byte> buffer, System.Threading.CancellationToken cancellationToken = default);override this.ReadAsync : Memory<byte> * System.Threading.CancellationToken -> System.Threading.Tasks.ValueTask<int>Public Overrides Function ReadAsync (buffer As Memory(Of Byte), Optional cancellationToken As CancellationToken = Nothing) As ValueTask(Of Integer)Parameters
- cancellationToken
- CancellationToken
The token to monitor for cancellation requests.
Returns
A task that represents the asynchronous read operation. The value of its Result property contains the total number of bytes read into buffer. When there is no more data to be read, returns 0.
Exceptions
Authentication has not occurred.
The read operation failed. Check the inner exception, if it is present, to determine the cause of the failure.
There is already a read operation in progress.
This object has been closed.
The cancellation token was canceled. This exception is stored into the returned task.
Remarks
This method reads as much data as is available into the buffer.
You cannot perform multiple simultaneous read operations.
You cannot call this method until you have successfully authenticated.
Applies to
ReadAsync(Byte[], Int32, Int32, CancellationToken)
- Source:
- SslStream.cs
- Source:
- SslStream.cs
- Source:
- SslStream.cs
Asynchronously reads data from this stream and stores it in the specified range of a byte array.
public:
override System::Threading::Tasks::Task<int> ^ ReadAsync(cli::array <System::Byte> ^ buffer, int offset, int count, System::Threading::CancellationToken cancellationToken);public override System.Threading.Tasks.Task<int> ReadAsync (byte[] buffer, int offset, int count, System.Threading.CancellationToken cancellationToken);override this.ReadAsync : byte[] * int * int * System.Threading.CancellationToken -> System.Threading.Tasks.Task<int>Public Overrides Function ReadAsync (buffer As Byte(), offset As Integer, count As Integer, cancellationToken As CancellationToken) As Task(Of Integer)Parameters
- buffer
- Byte[]
The buffer that receives the bytes read from this stream.
- offset
- Int32
The zero-based location in buffer at which to begin storing the data read from this stream.
- count
- Int32
The maximum number of bytes to read from this stream.
- cancellationToken
- CancellationToken
The token to monitor for cancellation requests.
Returns
A task that represents the asynchronous read operation. The value of its Result property contains the total number of bytes read into buffer. When there is no more data to be read, returns 0.
Exceptions
buffer is null.
offset is less than 0.
-or-
count is less than 0.
-or-
count is greater than the length of buffer minus offset.
Authentication has not occurred.
The read operation failed. Check the inner exception, if it is present, to determine the cause of the failure.
There is already a read operation in progress.
This object has been closed.
The cancellation token was canceled. This exception is stored into the returned task.
Remarks
The method reads a maximum of count bytes from the stream and stores them in buffer beginning at offset.
You cannot perform multiple simultaneous read operations.
You cannot call this method until you have successfully authenticated.
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 ArgumentException, are still thrown synchronously. For the stored exceptions, see the exceptions thrown by Read(Byte[], Int32, Int32).
