NegotiateStream.ReadAsync Method

Definition

Namespace:

System.Net.Security

Assembly:

System.Net.Security.dll

Overloads

ReadAsync(Memory<Byte>, CancellationToken)	Reads data asynchronously from the NegotiateStream and stores it in a byte memory range as an asynchronous operation.
ReadAsync(Byte[], Int32, Int32, CancellationToken)	Reads data asynchronously from this stream and stores it in the specified array.

ReadAsync(Memory<Byte>, CancellationToken)

Source:

NegotiateStream.cs

Reads data asynchronously from the NegotiateStream and stores it in a byte memory range as an asynchronous operation.

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

buffer

Memory<Byte>

The buffer to write the data to.

cancellationToken

CancellationToken

The token to monitor for cancellation requests.

Returns

ValueTask<Int32>

A ValueTask<TResult> that represents the asynchronous read operation. The value of its Result property contains the total number of bytes read into buffer.

Exceptions

IOException

The read operation failed.

InvalidOperationException

Authentication has not occurred.

OperationCanceledException

The cancellation token was canceled. This exception is stored into the returned task.

Remarks

This method reads asynchronously as much data as is available into buffer and returns the number of bytes successfully read.

You cannot call this method until you have successfully authenticated. To authenticate, call one of the AuthenticateAsClient, AuthenticateAsClientAsync, BeginAuthenticateAsClient, AuthenticateAsServer, AuthenticateAsServerAsync, or BeginAuthenticateAsServer methods.

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

Source:

NegotiateStream.cs

Reads data asynchronously from this stream and stores it in the specified 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[]

A Byte array that receives the bytes read from the stream.

offset

Int32

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

count

Int32

A Int32 containing the maximum number of bytes to read from the stream.

cancellationToken

CancellationToken

The token to monitor for cancellation requests.

Returns

Task<Int32>

An Int32 value that specifies the number of bytes read from the underlying stream. When there is no more data to be read, returns 0.

Exceptions

IOException

The read operation failed.

InvalidOperationException

Authentication has not occurred.

NotSupportedException

A Read(Byte[], Int32, Int32) operation is already in progress.

OperationCanceledException

The cancellation token was canceled. This exception is stored into the returned task.

Remarks

The method reads asynchronously a maximum of count bytes from the current stream and stores them in buffer beginning at offset.

You cannot call this method until you have successfully authenticated. To authenticate, call one of the AuthenticateAsClient, AuthenticateAsClientAsync, BeginAuthenticateAsClient, AuthenticateAsServer, AuthenticateAsServerAsync, or BeginAuthenticateAsServer methods.

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).