DataflowBlock.ReceiveAsync Метод

Определение

Пространство имен:

System.Threading.Tasks.Dataflow

Сборка:

System.Threading.Tasks.Dataflow.dll

Пакет:

System.Threading.Tasks.Dataflow v11.0.0-preview.4.26230.115

Перегрузки

Имя	Описание
ReceiveAsync<TOutput>(ISourceBlock<TOutput>)	Асинхронно получает значение из указанного источника.
ReceiveAsync<TOutput>(ISourceBlock<TOutput>, CancellationToken)	Асинхронно получает значение из указанного источника и предоставляет маркер для отмены операции.
ReceiveAsync<TOutput>(ISourceBlock<TOutput>, TimeSpan)	Асинхронно получает значение из указанного источника, наблюдая за необязательным периодом ожидания.
ReceiveAsync<TOutput>(ISourceBlock<TOutput>, TimeSpan, CancellationToken)	Асинхронно получает значение из указанного источника, предоставляя маркер для отмены операции и наблюдая необязательный интервал времени ожидания.

ReceiveAsync<TOutput>(ISourceBlock<TOutput>)

Исходный код:

DataflowBlock.cs

Асинхронно получает значение из указанного источника.

public:
generic <typename TOutput>
[System::Runtime::CompilerServices::Extension]
 static System::Threading::Tasks::Task<TOutput> ^ ReceiveAsync(System::Threading::Tasks::Dataflow::ISourceBlock<TOutput> ^ source);

public static System.Threading.Tasks.Task<TOutput> ReceiveAsync<TOutput>(this System.Threading.Tasks.Dataflow.ISourceBlock<TOutput> source);

static member ReceiveAsync : System.Threading.Tasks.Dataflow.ISourceBlock<'Output> -> System.Threading.Tasks.Task<'Output>

<Extension()>
Public Function ReceiveAsync(Of TOutput) (source As ISourceBlock(Of TOutput)) As Task(Of TOutput)

Параметры типа

TOutput

Тип данных, содержащихся в источнике.

Параметры

source

ISourceBlock<TOutput>

Источник, из которого требуется получить значение.

Возвращаемое значение

Task<TOutput>

Задача, представляющая асинхронную операцию получения. Когда значение элемента успешно получено из источника, возвращенная задача завершается и Result возвращает полученное значение. Если значение элемента невозможно извлечь, так как источник пуст и завершен, InvalidOperationException исключение создается в возвращаемой задаче.

Исключения

ArgumentNullException

source равно null.

ReceiveAsync<TOutput>(ISourceBlock<TOutput>, CancellationToken)

Исходный код:

DataflowBlock.cs

Асинхронно получает значение из указанного источника и предоставляет маркер для отмены операции.

public:
generic <typename TOutput>
[System::Runtime::CompilerServices::Extension]
 static System::Threading::Tasks::Task<TOutput> ^ ReceiveAsync(System::Threading::Tasks::Dataflow::ISourceBlock<TOutput> ^ source, System::Threading::CancellationToken cancellationToken);

public static System.Threading.Tasks.Task<TOutput> ReceiveAsync<TOutput>(this System.Threading.Tasks.Dataflow.ISourceBlock<TOutput> source, System.Threading.CancellationToken cancellationToken);

static member ReceiveAsync : System.Threading.Tasks.Dataflow.ISourceBlock<'Output> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<'Output>

<Extension()>
Public Function ReceiveAsync(Of TOutput) (source As ISourceBlock(Of TOutput), cancellationToken As CancellationToken) As Task(Of TOutput)

Параметры типа

TOutput

Указывает тип данных, содержащихся в источнике.

Параметры

source

ISourceBlock<TOutput>

Источник, из которого требуется получить значение.

cancellationToken

CancellationToken

Маркер, используемый для отмены операции получения.

Возвращаемое значение

Task<TOutput>

Задача, представляющая асинхронную операцию получения. После успешного получения значения из источника возвращенная задача завершается и возвращает значение Result . Если не удается получить значение из-за запроса отмены, возвращенная задача отменяется. Если значение не удается получить, так как источник пуст и завершен, InvalidOperationException исключение создается в возвращаемой задаче.

Исключения

ArgumentNullException

source равно null.

OperationCanceledException

Маркер отмены был отменен. Это исключение хранится в возвращаемой задаче.

ReceiveAsync<TOutput>(ISourceBlock<TOutput>, TimeSpan)

Исходный код:

DataflowBlock.cs

Асинхронно получает значение из указанного источника, наблюдая за необязательным периодом ожидания.

public:
generic <typename TOutput>
[System::Runtime::CompilerServices::Extension]
 static System::Threading::Tasks::Task<TOutput> ^ ReceiveAsync(System::Threading::Tasks::Dataflow::ISourceBlock<TOutput> ^ source, TimeSpan timeout);

public static System.Threading.Tasks.Task<TOutput> ReceiveAsync<TOutput>(this System.Threading.Tasks.Dataflow.ISourceBlock<TOutput> source, TimeSpan timeout);

static member ReceiveAsync : System.Threading.Tasks.Dataflow.ISourceBlock<'Output> * TimeSpan -> System.Threading.Tasks.Task<'Output>

<Extension()>
Public Function ReceiveAsync(Of TOutput) (source As ISourceBlock(Of TOutput), timeout As TimeSpan) As Task(Of TOutput)

Параметры типа

TOutput

Тип данных, содержащихся в источнике.

Параметры

source

ISourceBlock<TOutput>

Источник, из которого требуется получить значение.

timeout

TimeSpan

Максимальный интервал времени в миллисекундах, чтобы дождаться завершения синхронной операции или интервал, представляющий -1 миллисекундах, чтобы ждать неограниченное время.

Возвращаемое значение

Task<TOutput>

Задача, представляющая асинхронную операцию получения. После успешного получения значения из источника возвращенная задача завершается и возвращает значение Result . Если значение не удается извлечь из-за истечения срока ожидания, возвращается задача отмены. Если значение не удается получить, так как источник пуст и завершен, InvalidOperationException исключение создается в возвращаемой задаче.

Исключения

ArgumentNullException

source равно null.

ArgumentOutOfRangeException

timeout — отрицательное число, отличное от -1 миллисекунда, которое представляет бесконечный период ожидания.

–или–

timeout больше int32.MaxValue.

ReceiveAsync<TOutput>(ISourceBlock<TOutput>, TimeSpan, CancellationToken)

Исходный код:

DataflowBlock.cs

Асинхронно получает значение из указанного источника, предоставляя маркер для отмены операции и наблюдая необязательный интервал времени ожидания.

public:
generic <typename TOutput>
[System::Runtime::CompilerServices::Extension]
 static System::Threading::Tasks::Task<TOutput> ^ ReceiveAsync(System::Threading::Tasks::Dataflow::ISourceBlock<TOutput> ^ source, TimeSpan timeout, System::Threading::CancellationToken cancellationToken);

public static System.Threading.Tasks.Task<TOutput> ReceiveAsync<TOutput>(this System.Threading.Tasks.Dataflow.ISourceBlock<TOutput> source, TimeSpan timeout, System.Threading.CancellationToken cancellationToken);

static member ReceiveAsync : System.Threading.Tasks.Dataflow.ISourceBlock<'Output> * TimeSpan * System.Threading.CancellationToken -> System.Threading.Tasks.Task<'Output>

<Extension()>
Public Function ReceiveAsync(Of TOutput) (source As ISourceBlock(Of TOutput), timeout As TimeSpan, cancellationToken As CancellationToken) As Task(Of TOutput)

Параметры типа

TOutput

Тип данных, содержащихся в источнике.

Параметры

source

ISourceBlock<TOutput>

Источник, из которого требуется получить значение.

timeout

TimeSpan

Максимальный интервал времени в миллисекундах, чтобы дождаться завершения синхронной операции или интервал, представляющий -1 миллисекундах, чтобы ждать неограниченное время.

cancellationToken

CancellationToken

Маркер, который может использоваться для отмены операции получения.

Возвращаемое значение

Task<TOutput>

Задача, представляющая асинхронную операцию получения. После успешного получения значения из источника возвращенная задача завершается и возвращает значение Result . Если не удается получить значение из-за истечения срока действия или отмены, возвращается задача отмены. Если значение не удается получить, так как источник пуст и завершен, InvalidOperationException исключение создается в возвращаемой задаче.

Исключения

ArgumentNullException

source равно null.

ArgumentOutOfRangeException

timeout — отрицательное число, отличное от -1 миллисекунда, которое представляет бесконечный период ожидания.

–или–

timeout больше int32.MaxValue.

OperationCanceledException

Маркер отмены был отменен. Это исключение хранится в возвращаемой задаче.