BsonStreamAdapter.EndRead Method

BsonStreamAdapterEndRead Method

Waits for the pending asynchronous read to complete. (Consider using ReadAsync(Byte, Int32, Int32) instead; see the Remarks section.)

Namespace: MongoDB.Bson.IO
Assembly: MongoDB.Bson (in MongoDB.Bson.dll) Version: 2.3.0

Syntax

Copy

public override int EndRead(
	IAsyncResult asyncResult
)

Public Overrides Function EndRead ( 
	asyncResult As IAsyncResult
) As Integer

abstract EndRead : 
        asyncResult : IAsyncResult -> int 
override EndRead : 
        asyncResult : IAsyncResult -> int

Parameters

asyncResult: Type: SystemIAsyncResult
The reference to the pending asynchronous request to finish.

Return Value

Type: Int32
The number of bytes read from the stream, between zero (0) and the number of bytes you requested. Streams return zero (0) only at the end of the stream, otherwise, they should block until at least one byte is available.

Exceptions

Exception	Condition
ArgumentNullException	asyncResult is null.
ArgumentException	A handle to the pending read operation is not available.-or-The pending operation does not support reading.
InvalidOperationException	asyncResult did not originate from a BeginRead(Byte, Int32, Int32, AsyncCallback, Object) method on the current stream.
IOException	The stream is closed or an internal error has occurred.

Reference

BsonStreamAdapter Class

MongoDB.Bson.IO Namespace