ActionBlock<TInput>.Complete Method
Signals to the dataflow block that it shouldn't accept or produce any more messages and shouldn't consume any more postponed messages.
Namespace: System.Threading.Tasks.Dataflow
Assembly: System.Threading.Tasks.Dataflow (in System.Threading.Tasks.Dataflow.dll)
After Complete has been called on a dataflow block, that block will complete (so that its Completion task will enter a final state) after it has processed all previously available data. This method will not block waiting for completion to occur, but will initiate the request. To wait for completion to occur, use the Completion property.
The following example shows the use of the Complete method to signal to the dataflow block that it shouldn't accept or produce any more messages nor consume any more postponed messages. This code example is part of a larger example provided for the How to: Specify the Degree of Parallelism in a Dataflow Block topic.
// 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; }
- Full trust for the immediate caller. This member cannot be used by partially trusted code. For more information, see Using Libraries from Partially Trusted Code.
Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)
The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.