BsonStreamAdapterReadAsync Method (Byte, Int32, Int32, CancellationToken)

Asynchronously reads a sequence of bytes from the current stream, advances the position within the stream by the number of bytes read, and monitors cancellation requests.

Namespace: MongoDB.Bson.IO
Assembly: MongoDB.Bson (in MongoDB.Bson.dll) Version: 2.5.0+57.Branch.master.Sha.6a4e00a2d91090c65a9b11364b9ebfdb9c7da076

Syntax

Copy

public override Task<int> ReadAsync(
	byte[] buffer,
	int offset,
	int count,
	CancellationToken cancellationToken
)

Public Overrides Function ReadAsync ( 
	buffer As Byte(),
	offset As Integer,
	count As Integer,
	cancellationToken As CancellationToken
) As Task(Of Integer)

abstract ReadAsync : 
        buffer : byte[] * 
        offset : int * 
        count : int * 
        cancellationToken : CancellationToken -> Task<int> 
override ReadAsync : 
        buffer : byte[] * 
        offset : int * 
        count : int * 
        cancellationToken : CancellationToken -> Task<int>

Parameters

buffer: Type: SystemByte
The buffer to write the data into.
offset: Type: SystemInt32
The byte offset in buffer at which to begin writing data from the stream.
count: Type: SystemInt32
The maximum number of bytes to read.
cancellationToken: Type: System.ThreadingCancellationToken
The token to monitor for cancellation requests. The default value is None.

Return Value

Type: TaskInt32
A task that represents the asynchronous read operation. The value of the TResult parameter contains the total number of bytes read into the buffer. The result value can be less than the number of bytes requested if the number of bytes currently available is less than the requested number, or it can be 0 (zero) if the end of the stream has been reached.

Exceptions

Exception	Condition
ArgumentNullException	buffer is null.
ArgumentOutOfRangeException	offset or count is negative.
ArgumentException	The sum of offset and count is larger than the buffer length.
NotSupportedException	The stream does not support reading.
ObjectDisposedException	The stream has been disposed.
InvalidOperationException	The stream is currently in use by a previous read operation.

Reference

BsonStreamAdapter Class

ReadAsync Overload

MongoDB.Bson.IO Namespace

BsonStreamAdapterAddLanguageSpecificTextSet("LST6DDB6775_0?cpp=::|nu=.");ReadAsync Method (AddLanguageSpecificTextSet("LST6DDB6775_1?cpp=array&lt;");ByteAddLanguageSpecificTextSet("LST6DDB6775_2?cpp=&gt;|vb=()|nu=[]");, Int32, Int32, CancellationToken)

Parameters

Return Value

Reference

BsonStreamAdapterReadAsync Method (Byte, Int32, Int32, CancellationToken)