broom::BroomSharingScope Struct Reference

#include <broom.h>

Public Member Functions
	BroomSharingScope (broom_configuration config={})
	~BroomSharingScope ()
	BroomSharingScope (const BroomSharingScope &other)=delete
	BroomSharingScope (BroomSharingScope &&other)=delete
BroomSharingScope &	operator= (const BroomSharingScope &other)=delete
BroomSharingScope &	operator= (BroomSharingScope &&other)=delete

Detailed Description

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

Definition at line 168 of file broom.h.

Constructor & Destructor Documentation

BroomSharingScope() [1/3]

broom::BroomSharingScope::BroomSharingScope ( broom_configuration  config = {} )

inline

The constructor simply calls thread_init() with an optional configuration, setting the support_sharing value of broom_configuration to true.

Parameters

config

The configuration to initialize Broom on this thread with. This parameter will be modified with support_sharing set to true.

Definition at line 177 of file broom.h.

~BroomSharingScope()

broom::BroomSharingScope::~BroomSharingScope ( )

inline

The destructor simply calls thread_teardown().

Definition at line 184 of file broom.h.

BroomSharingScope() [2/3]

broom::BroomSharingScope::BroomSharingScope ( const BroomSharingScope &  other )

delete

BroomSharingScope() [3/3]

broom::BroomSharingScope::BroomSharingScope ( BroomSharingScope &&  other )

delete

Member Function Documentation

operator=() [1/2]

BroomSharingScope & broom::BroomSharingScope::operator= ( BroomSharingScope &&  other )

delete

operator=() [2/2]

BroomSharingScope & broom::BroomSharingScope::operator= ( const BroomSharingScope &  other )

delete

---

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

• include/broom.h