Menu

- Learn
- Documentation
  - Language Reference
  - Library Reference
  - Command-line Reference
  - Feature Overview
  - Articles
- Downloads
- Packages
- Community
  - Blog
  - Orgs using D
  - Twitter
  - Calendar
  - 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.gc.registry

Contains a registry for GC factories.
License:
Boost License 1.0.
Authors:
Martin Nowak

alias `GCFactory` = GC function();
  A factory function that instantiates an implementation of the GC interface. In case the instance was allocated on the C heap, it is supposed to free itself upon calling it's destructor.
  The factory should print an error and abort the program if it cannot successfully initialize the GC instance.
nothrow @nogc void `registerGCFactory`(string `name`, GCFactory `factory`);
  Register a GC factory under the given `name`. This function must be called from a C constructor before druntime is initialized.
  To use the registered GC, it's name must be specified gcopt runtime option, e.g. by passing , --DRT-gcopt=gc:my_gc_name as application argument.
  Parameters:

  string `name` | name of the GC implementation; should be unique
  GCFactory `factory` | function to instantiate the implementation

  Note The registry does not perform synchronization, as registration is assumed to be executed serially, as is the case for C constructors.

  See Also:
  Configuring the Garbage Collector
GC `createGCInstance`(string `name`);
  Called during runtime initialization to initialize a GC instance of given `name`.
  Parameters:

  string `name` | name of the GC to instantiate

  Returns:
  The created GC instance or null if no factory for that name was registered

Copyright © 1999-2022 by the D Language Foundation | Page generated by Ddoc on Thu Dec 15 17:30:00 2022