ActionBlock<TInput>.Completion Właściwość

Definicja

Przestrzeń nazw:

System.Threading.Tasks.Dataflow

Zestaw:

System.Threading.Tasks.Dataflow.dll

Pobiera obiekt reprezentujący operację Task asynchroniczną i zakończenie bloku przepływu danych.

public:
 property System::Threading::Tasks::Task ^ Completion { System::Threading::Tasks::Task ^ get(); };

public System.Threading.Tasks.Task Completion { get; }

member this.Completion : System.Threading.Tasks.Task

Public ReadOnly Property Completion As Task

Wartość właściwości

Task

Ukończone zadanie.

Implementuje

Completion

Przykłady

W poniższym przykładzie pokazano, jak za pomocą Completion właściwości poczekać na propagację wszystkich komunikatów za pośrednictwem sieci. Ten przykład kodu jest częścią większego przykładu przedstawionego w temacie How to: Specify the Degree of Parallelism in a Dataflow Block (Jak określić stopień równoległości w bloku przepływu danych ).

// Performs several computations by using dataflow and returns the elapsed
// time required to perform the computations.
static TimeSpan TimeDataflowComputations(int maxDegreeOfParallelism,
   int messageCount)
{
   // Create an ActionBlock<int> that performs some work.
   var workerBlock = new ActionBlock<int>(
      // Simulate work by suspending the current thread.
      millisecondsTimeout => Thread.Sleep(millisecondsTimeout),
      // Specify a maximum degree of parallelism.
      new ExecutionDataflowBlockOptions
      {
         MaxDegreeOfParallelism = maxDegreeOfParallelism
      });

   // Compute the time that it takes for several messages to
   // flow through the dataflow block.

   Stopwatch stopwatch = new Stopwatch();
   stopwatch.Start();

   for (int i = 0; i < messageCount; i++)
   {
      workerBlock.Post(1000);
   }
   workerBlock.Complete();

   // Wait for all messages to propagate through the network.
   workerBlock.Completion.Wait();

   // Stop the timer and return the elapsed number of milliseconds.
   stopwatch.Stop();
   return stopwatch.Elapsed;
}

' Demonstrates how to specify the maximum degree of parallelism 
' when using dataflow.
Friend Class Program
   ' Performs several computations by using dataflow and returns the elapsed
   ' time required to perform the computations.
   Private Shared Function TimeDataflowComputations(ByVal maxDegreeOfParallelism As Integer, ByVal messageCount As Integer) As TimeSpan
      ' Create an ActionBlock<int> that performs some work.
      Dim workerBlock = New ActionBlock(Of Integer)(Function(millisecondsTimeout) Pause(millisecondsTimeout), New ExecutionDataflowBlockOptions() With { .MaxDegreeOfParallelism = maxDegreeOfParallelism})
         ' Simulate work by suspending the current thread.
         ' Specify a maximum degree of parallelism.

      ' Compute the time that it takes for several messages to 
      ' flow through the dataflow block.

      Dim stopwatch As New Stopwatch()
      stopwatch.Start()

      For i As Integer = 0 To messageCount - 1
         workerBlock.Post(1000)
      Next i
      workerBlock.Complete()

      ' Wait for all messages to propagate through the network.
      workerBlock.Completion.Wait()

      ' Stop the timer and return the elapsed number of milliseconds.
      stopwatch.Stop()
      Return stopwatch.Elapsed
   End Function

   Private Shared Function Pause(ByVal obj As Object)
      Thread.Sleep(obj)
      Return Nothing
   End Function

Uwagi

Blok przepływu danych jest uznawany za ukończony, gdy nie przetwarza obecnie komunikatu i gdy gwarantuje, że nie przetworzy więcej komunikatów. Zwrócony Task element przejdzie do stanu ukończonego po zakończeniu skojarzonego bloku. Nastąpi przejście do stanu po pomyślnym zakończeniu RanToCompletion przetwarzania przez blok zgodnie ze zdefiniowaną semantyka bloku przepływu danych. Nastąpi przejście do Faulted stanu, gdy blok przepływu danych zakończył przetwarzanie przedwcześnie z powodu nieobsługiwanego wyjątku i przejdzie do Canceled stanu, gdy blok przepływu danych zakończył przetwarzanie przedwcześnie po otrzymaniu żądania anulowania. Jeśli zadanie zostanie ukończone w Faulted stanie, jego Exception właściwość zwróci AggregateException wyjątek zawierający co najmniej jeden wyjątek, który spowodował niepowodzenie bloku.