ActionBlock<TInput>.Completion Eigenschap

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

Waarde van eigenschap

De voltooide taak.

Implementeringen

Voorbeelden

In het volgende voorbeeld ziet u hoe u de Completion eigenschap gebruikt om te wachten tot alle berichten zijn doorgegeven via het netwerk. Dit codevoorbeeld maakt deel uit van een groter voorbeeld dat wordt gegeven voor het onderwerp Procedure: De mate van parallelle uitvoering opgeven in een onderwerp over blokgegevensstromen .

// 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

Opmerkingen

Een gegevensstroomblok wordt beschouwd als voltooid wanneer het momenteel geen bericht verwerkt en wanneer het zeker weet dat het geen berichten meer verwerkt. De geretourneerde Task status wordt overgezet naar een voltooide status wanneer het bijbehorende blok is voltooid. Het wordt overgestapt op de RanToCompletion status wanneer het blok de verwerking ervan heeft voltooid op basis van de gedefinieerde semantiek van het gegevensstroomblok. Deze wordt overgestapt op de Faulted status wanneer het gegevensstroomblok de verwerking voortijdig heeft voltooid vanwege een niet-verwerkte uitzondering en deze wordt overgegaan naar de Canceled status wanneer het gegevensstroomblok de verwerking voortijdig heeft voltooid na ontvangst van een annuleringsaanvraag. Als de taak in de status is voltooid, Faulted retourneert de Exception eigenschap een uitzondering die een AggregateException of meer uitzonderingen bevat waardoor het blok is mislukt.