Поделиться через


DataflowBlock.ReceiveAsync Метод

Определение

Перегрузки

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
Исходный код:
DataflowBlock.cs
Исходный код:
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 в возвращаемой задаче.

Исключения

source имеет значение null.

Применяется к

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

Исходный код:
DataflowBlock.cs
Исходный код:
DataflowBlock.cs
Исходный код:
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 в возвращаемой задаче.

Исключения

source имеет значение null.

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

Применяется к

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

Исходный код:
DataflowBlock.cs
Исходный код:
DataflowBlock.cs
Исходный код:
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 в возвращаемой задаче.

Исключения

source имеет значение null.

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

-или-

timeout больше , чем Int32.MaxValue.

Применяется к

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

Исходный код:
DataflowBlock.cs
Исходный код:
DataflowBlock.cs
Исходный код:
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 в возвращаемой задаче.

Исключения

source имеет значение null.

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

-или-

timeout больше , чем Int32.MaxValue.

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

Применяется к