core.sync.barrier - D Programming Language
Description: D Programming Language
Keywords: D programming language

Menu

- Learn
- Documentation
  - Language Reference
  - Library Reference
  - Command-line Reference
  - Feature Overview
  - Articles
- Downloads
- Packages
- Community
  - Blog
  - Orgs using D
  - Twitter
  - Forums
  - IRC
  - Community Discord
  - Wiki
  - GitHub
  - Issues
  - Get involved
  - Contributors
  - Foundation
  - Security Team
  - Donate
  - Sponsors
- Resources
  - Tour
  - Books
  - Tutorials
  - Tools
  - Editors
  - IDEs
  - run.dlang.io
  - Visual D
  - Acknowledgments
  - D Style
  - Glossary
  - Sitemap

Search
Report a bug
If you spot a problem with this page, click here to create a Bugzilla issue.
Improve this page
Quickly fork, edit online, and submit a pull request for this page. Requires a signed-in GitHub account. This works well for small changes. If you'd like to make larger changes you may want to consider using a local clone.

# core.sync.barrier

The barrier module provides a primitive for synchronizing the progress of a group of threads.
License:
Boost License 1.0
Authors:
Sean Kelly

Source core/sync/barrier.d

class `Barrier`;
  This class represents a barrier across which threads may only travel in groups of a specific size.
  Examples:

      import core.thread;

      int  numThreads = 10;
      auto barrier    = new Barrier( numThreads );
      auto synInfo    = new Object;
      int  numReady   = 0;
      int  numPassed  = 0;

      void threadFn()
      {
          synchronized( synInfo )
          {
              ++numReady;
          }
          barrier.wait();
          synchronized( synInfo )
          {
              ++numPassed;
          }
      }

      auto group = new ThreadGroup;

      for ( int i = 0; i < numThreads; ++i )
      {
          group.create( &threadFn );
      }
      group.joinAll();
      assert( numReady == numThreads && numPassed == numThreads );

  this(uint `limit`);
    Initializes a barrier object which releases threads in groups of limit in size.
    Parameters:

    uint `limit` | The number of waiting threads to release in unison.

    Throws:
    SyncError on error.
  void `wait`();
    Wait for the pre-determined number of threads and then proceed.
    Throws:
    SyncError on error.

Copyright © 1999-2023 by the D Language Foundation | Page generated by Ddoc on Wed Feb 15 22:42:53 2023