SslStream.ReadAsync SslStream.ReadAsync SslStream.ReadAsync Method

Definition

Overloads

ReadAsync(Memory<Byte>, CancellationToken) ReadAsync(Memory<Byte>, CancellationToken)

Asynchronously reads data from this stream and stores it in the specified memory range.

ReadAsync(Byte[], Int32, Int32, CancellationToken) ReadAsync(Byte[], Int32, Int32, CancellationToken) 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) ReadAsync(Memory<Byte>, CancellationToken)

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 = null);
override this.ReadAsync : Memory<byte> * System.Threading.CancellationToken -> System.Threading.Tasks.ValueTask<int>

Parameters

buffer
Memory<Byte>

The buffer that receives the bytes read from this stream.

cancellationToken
CancellationToken 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

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.

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.

ReadAsync(Byte[], Int32, Int32, CancellationToken) ReadAsync(Byte[], Int32, Int32, CancellationToken) ReadAsync(Byte[], Int32, Int32, CancellationToken)

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>

Parameters

buffer
Byte[]

The buffer that receives the bytes read from this stream.

offset
Int32 Int32 Int32

The zero-based location in buffer at which to begin storing the data read from this stream.

count
Int32 Int32 Int32

The maximum number of bytes to read from this stream.

cancellationToken
CancellationToken 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

offset is less than 0.

-or-

count is less than 0.

-or-

count is greater than the length of buffer minus offset.

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.

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.

Applies to