Broom 1.0.0
A thread-local C++ Garbage Collector
Loading...
Searching...
No Matches
Public Member Functions | List of all members
broom::BroomScope Struct Reference

#include <broom.h>

Public Member Functions

 BroomScope (broom_configuration config={})
 
 ~BroomScope ()
 
 BroomScope (const BroomScope &other)=delete
 
 BroomScope (BroomScope &&other)=delete
 
BroomScopeoperator= (const BroomScope &other)=delete
 
BroomScopeoperator= (BroomScope &&other)=delete
 

Detailed Description

A helper RAII wrapper for per-thread initialization and teardown of Broom. broom::scope is also available as an alias for this class to support a more traditional C++ style.

Definition at line 111 of file broom.h.

Constructor & Destructor Documentation

◆ BroomScope() [1/3]

broom::BroomScope::BroomScope ( broom_configuration  config = {})
inline

The constructor simply calls thread_init() with an optional configuration.

Parameters
configThe configuration to initialize Broom on this thread with.

Definition at line 117 of file broom.h.

◆ ~BroomScope()

broom::BroomScope::~BroomScope ( )
inline

The destructor simply calls thread_teardown().

Definition at line 121 of file broom.h.

◆ BroomScope() [2/3]

broom::BroomScope::BroomScope ( const BroomScope other)
delete

◆ BroomScope() [3/3]

broom::BroomScope::BroomScope ( BroomScope &&  other)
delete

Member Function Documentation

◆ operator=() [1/2]

BroomScope & broom::BroomScope::operator= ( BroomScope &&  other)
delete

◆ operator=() [2/2]

BroomScope & broom::BroomScope::operator= ( const BroomScope other)
delete

The documentation for this struct was generated from the following file: