Click or drag to resize

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.18.0+554c799eb1ec8dd732f16c739387f6664df1ba7a
Syntax
public override Task<int> ReadAsync(
	byte[] buffer,
	int offset,
	int count,
	CancellationToken cancellationToken
)

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
ExceptionCondition
ArgumentNullExceptionbuffer is .
ArgumentOutOfRangeExceptionoffset or count is negative.
ArgumentExceptionThe sum of offset and count is larger than the buffer length.
NotSupportedExceptionThe stream does not support reading.
ObjectDisposedExceptionThe stream has been disposed.
InvalidOperationExceptionThe stream is currently in use by a previous read operation.
See Also