DataflowBlock.Receive Метод

Определение

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

System.Threading.Tasks.Dataflow

Сборка:

System.Threading.Tasks.Dataflow.dll

Пакет:

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

Перегрузки

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

Receive<TOutput>(ISourceBlock<TOutput>)

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

DataflowBlock.cs

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

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

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

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

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

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

TOutput

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

Параметры

source

ISourceBlock<TOutput>

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

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

TOutput

Полученное значение.

Исключения

ArgumentNullException

source равно null.

InvalidOperationException

Ни один элемент не может быть получен из источника.

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

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

DataflowBlock.cs

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

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

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

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

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

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

TOutput

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

Параметры

source

ISourceBlock<TOutput>

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

cancellationToken

CancellationToken

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

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

TOutput

Полученное значение.

Исключения

ArgumentNullException

source равно null.

InvalidOperationException

Ни один элемент не может быть получен из источника.

OperationCanceledException

Операция была отменена до получения элемента из источника.

Комментарии

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

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

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

DataflowBlock.cs

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

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

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

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

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

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

TOutput

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

Параметры

source

ISourceBlock<TOutput>

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

timeout

TimeSpan

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

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

TOutput

Полученное значение.

Исключения

ArgumentOutOfRangeException

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

–или–

timeout больше int32.MaxValue.

ArgumentNullException

source равно null.

InvalidOperationException

Ни один элемент не может быть получен из источника.

TimeoutException

Указанное время ожидания истекло до получения элемента из источника.

Комментарии

Если источник успешно предложил элемент, полученный данной операцией, возвращается даже в том случае, если происходит одновременный тайм-аут.

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

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

DataflowBlock.cs

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

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

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

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

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

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

TOutput

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

Параметры

source

ISourceBlock<TOutput>

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

timeout

TimeSpan

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

cancellationToken

CancellationToken

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

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

TOutput

Полученное значение.

Исключения

ArgumentNullException

Значение source равно null.

ArgumentOutOfRangeException

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

–или–

timeout больше int32.MaxValue.

InvalidOperationException

Ни один элемент не может быть получен из источника.

TimeoutException

Указанное время ожидания истекло до получения элемента из источника.

OperationCanceledException

Операция была отменена до получения элемента из источника.

Комментарии

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